# UserApi All URIs are relative to *http://petstore.swagger.io:80/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 > void createUser(user) Create user This can only be done by the logged in user. ### Parameters | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **user** | [**User**](User.md)| Created user object | | ### Return type [**void**](Void.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | - | ## createUsersWithArrayInput > void createUsersWithArrayInput(user) Creates list of users with given input array ### Parameters | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **user** | [**List<User>**](User.md)| List of user object | | ### Return type [**void**](Void.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | - | ## createUsersWithListInput > void createUsersWithListInput(user) Creates list of users with given input array ### Parameters | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **user** | [**List<User>**](User.md)| List of user object | | ### Return type [**void**](Void.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | - | ## deleteUser > void deleteUser(username) Delete user This can only be done by the logged in user. ### Parameters | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **username** | **String**| The name that needs to be deleted | | ### Return type [**void**](Void.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **400** | Invalid username supplied | - | | **404** | User not found | - | ## getUserByName > User getUserByName(username) Get user by user name ### Parameters | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **username** | **String**| The name that needs to be fetched. Use user1 for testing. | | ### Return type [**User**](User.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/xml, application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | - | | **400** | Invalid username supplied | - | | **404** | User not found | - | ## loginUser > String loginUser(username, password) Logs user into the system ### Parameters | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **username** | **String**| The user name for login | | | **password** | **String**| The password for login in clear text | | ### Return type **String** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/xml, application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user
* X-Expires-After - date in UTC when token expires
| | **400** | Invalid username/password supplied | - | ## logoutUser > void logoutUser() Logs out current logged in user session ### Parameters This endpoint does not need any parameter. ### Return type [**void**](Void.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | - | ## updateUser > void updateUser(username, user) Updated user This can only be done by the logged in user. ### Parameters | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **username** | **String**| name that need to be deleted | | | **user** | [**User**](User.md)| Updated user object | | ### Return type [**void**](Void.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| | **400** | Invalid user supplied | - | | **404** | User not found | - |