# UserApi All URIs are relative to */v2* Method | HTTP request | Description ------------- | ------------- | ------------- [**createUser**](UserApi.md#createUser) | **POST** /user | Create user [**createUsersWithArrayInput**](UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array [**createUsersWithListInput**](UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array [**deleteUser**](UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user [**getUserByName**](UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name [**loginUser**](UserApi.md#loginUser) | **GET** /user/login | Logs user into the system [**logoutUser**](UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user ## createUser Create user This can only be done by the logged in user. ### Example ```bash petstore-cli createUser ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**User**](User.md) | Created user object | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not Applicable [[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) ## createUsersWithArrayInput Creates list of users with given input array ### Example ```bash petstore-cli createUsersWithArrayInput ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**array[User]**](User.md) | List of user object | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not Applicable [[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) ## createUsersWithListInput Creates list of users with given input array ### Example ```bash petstore-cli createUsersWithListInput ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**array[User]**](User.md) | List of user object | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not Applicable [[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) ## deleteUser Delete user This can only be done by the logged in user. ### Example ```bash petstore-cli deleteUser username=value ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string** | The name that needs to be deleted | [default to null] ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not Applicable - **Accept**: Not Applicable [[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) ## getUserByName Get user by user name ### Example ```bash petstore-cli getUserByName username=value ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string** | The name that needs to be fetched. Use user1 for testing. | [default to null] ### Return type [**User**](User.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not Applicable - **Accept**: application/xml, 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) ## loginUser Logs user into the system ### Example ```bash petstore-cli loginUser username=value password=value ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string** | The user name for login | [default to null] **password** | **string** | The password for login in clear text | [default to null] ### Return type **string** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not Applicable - **Accept**: application/xml, 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) ## logoutUser Logs out current logged in user session ### Example ```bash petstore-cli logoutUser ``` ### Parameters This endpoint does not need any parameter. ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not Applicable - **Accept**: Not Applicable [[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) ## updateUser Updated user This can only be done by the logged in user. ### Example ```bash petstore-cli updateUser username=value ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string** | name that need to be deleted | [default to null] **user** | [**User**](User.md) | Updated user object | ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not Applicable [[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)