kimai_client_lib 1.0.0

# \UserApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_delete_api_token**](UserApi.md#delete_delete_api_token) | **DELETE** /api/users/api-token/{id} | Delete an API token for the current user
[**get_get_user**](UserApi.md#get_get_user) | **GET** /api/users/{id} | Return one user entity
[**get_get_users**](UserApi.md#get_get_users) | **GET** /api/users | Returns the collection of users (which are visible to the user)
[**get_me_user**](UserApi.md#get_me_user) | **GET** /api/users/me | Return the current user entity
[**patch_patch_user**](UserApi.md#patch_patch_user) | **PATCH** /api/users/{id} | Update an existing user
[**post_post_user**](UserApi.md#post_post_user) | **POST** /api/users | Creates a new user



## delete_delete_api_token

> delete_delete_api_token(id)
Delete an API token for the current user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The API token ID to remove | [required] |

### Return type

 (empty response body)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_get_user

> models::UserEntity get_get_user(id)
Return one user entity

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | User ID to fetch | [required] |

### Return type

[**models::UserEntity**](UserEntity.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_get_users

> Vec<models::UserCollection> get_get_users(visible, order_by, order, term, full)
Returns the collection of users (which are visible to the user)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**visible** | Option<**String**> | Visibility status to filter users: 1=visible, 2=hidden, 3=all |  |[default to 1]
**order_by** | Option<**String**> | The field by which results will be ordered. Allowed values: id, username, alias, email (default: username) |  |
**order** | Option<**String**> | The result order. Allowed values: ASC, DESC (default: ASC) |  |
**term** | Option<**String**> | Free search term |  |
**full** | Option<**String**> | Allows to fetch full objects including subresources. Allowed values: 0|1|false|true (default: false) |  |

### Return type

[**Vec<models::UserCollection>**](UserCollection.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_me_user

> models::UserEntity get_me_user()
Return the current user entity

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::UserEntity**](UserEntity.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## patch_patch_user

> models::UserEntity patch_patch_user(id, user_edit_form)
Update an existing user

Update an existing user, you can pass all or just a subset of all attributes (passing roles will replace all existing ones)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | User ID to update | [required] |
**user_edit_form** | [**UserEditForm**](UserEditForm.md) |  | [required] |

### Return type

[**models::UserEntity**](UserEntity.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_post_user

> post_post_user(user_create_form)
Creates a new user

Creates a new user and returns it afterwards

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_create_form** | [**UserCreateForm**](UserCreateForm.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)