# UserApi All URIs are relative to *http://petstore.swagger.io/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** > createUser(body) Create user This can only be done by the logged in user. ### Example ```kotlin // Import classes: //import org.openapitools.client.infrastructure.* //import org.openapitools.client.models.* val apiInstance = UserApi() val body : User = // User | Created user object try { apiInstance.createUser(body) } catch (e: ClientException) { println("4xx response calling UserApi#createUser") e.printStackTrace() } catch (e: ServerException) { println("5xx response calling UserApi#createUser") e.printStackTrace() } ``` ### Parameters | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **body** | [**User**](User.md)| Created user object | | ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example ```kotlin // Import classes: //import org.openapitools.client.infrastructure.* //import org.openapitools.client.models.* val apiInstance = UserApi() val body : kotlin.collections.List = // kotlin.collections.List | List of user object try { apiInstance.createUsersWithArrayInput(body) } catch (e: ClientException) { println("4xx response calling UserApi#createUsersWithArrayInput") e.printStackTrace() } catch (e: ServerException) { println("5xx response calling UserApi#createUsersWithArrayInput") e.printStackTrace() } ``` ### Parameters | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **body** | [**kotlin.collections.List<User>**](User.md)| List of user object | | ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example ```kotlin // Import classes: //import org.openapitools.client.infrastructure.* //import org.openapitools.client.models.* val apiInstance = UserApi() val body : kotlin.collections.List = // kotlin.collections.List | List of user object try { apiInstance.createUsersWithListInput(body) } catch (e: ClientException) { println("4xx response calling UserApi#createUsersWithListInput") e.printStackTrace() } catch (e: ServerException) { println("5xx response calling UserApi#createUsersWithListInput") e.printStackTrace() } ``` ### Parameters | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **body** | [**kotlin.collections.List<User>**](User.md)| List of user object | | ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **deleteUser** > deleteUser(username) Delete user This can only be done by the logged in user. ### Example ```kotlin // Import classes: //import org.openapitools.client.infrastructure.* //import org.openapitools.client.models.* val apiInstance = UserApi() val username : kotlin.String = username_example // kotlin.String | The name that needs to be deleted try { apiInstance.deleteUser(username) } catch (e: ClientException) { println("4xx response calling UserApi#deleteUser") e.printStackTrace() } catch (e: ServerException) { println("5xx response calling UserApi#deleteUser") e.printStackTrace() } ``` ### Parameters | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **username** | **kotlin.String**| The name that needs to be deleted | | ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **getUserByName** > User getUserByName(username) Get user by user name ### Example ```kotlin // Import classes: //import org.openapitools.client.infrastructure.* //import org.openapitools.client.models.* val apiInstance = UserApi() val username : kotlin.String = username_example // kotlin.String | The name that needs to be fetched. Use user1 for testing. try { val result : User = apiInstance.getUserByName(username) println(result) } catch (e: ClientException) { println("4xx response calling UserApi#getUserByName") e.printStackTrace() } catch (e: ServerException) { println("5xx response calling UserApi#getUserByName") e.printStackTrace() } ``` ### Parameters | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **username** | **kotlin.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 # **loginUser** > kotlin.String loginUser(username, password) Logs user into the system ### Example ```kotlin // Import classes: //import org.openapitools.client.infrastructure.* //import org.openapitools.client.models.* val apiInstance = UserApi() val username : kotlin.String = username_example // kotlin.String | The user name for login val password : kotlin.String = password_example // kotlin.String | The password for login in clear text try { val result : kotlin.String = apiInstance.loginUser(username, password) println(result) } catch (e: ClientException) { println("4xx response calling UserApi#loginUser") e.printStackTrace() } catch (e: ServerException) { println("5xx response calling UserApi#loginUser") e.printStackTrace() } ``` ### Parameters | **username** | **kotlin.String**| The user name for login | | | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **password** | **kotlin.String**| The password for login in clear text | | ### Return type **kotlin.String** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/xml, application/json # **logoutUser** > logoutUser() Logs out current logged in user session ### Example ```kotlin // Import classes: //import org.openapitools.client.infrastructure.* //import org.openapitools.client.models.* val apiInstance = UserApi() try { apiInstance.logoutUser() } catch (e: ClientException) { println("4xx response calling UserApi#logoutUser") e.printStackTrace() } catch (e: ServerException) { println("5xx response calling UserApi#logoutUser") e.printStackTrace() } ``` ### Parameters This endpoint does not need any parameter. ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **updateUser** > updateUser(username, body) Updated user This can only be done by the logged in user. ### Example ```kotlin // Import classes: //import org.openapitools.client.infrastructure.* //import org.openapitools.client.models.* val apiInstance = UserApi() val username : kotlin.String = username_example // kotlin.String | name that need to be deleted val body : User = // User | Updated user object try { apiInstance.updateUser(username, body) } catch (e: ClientException) { println("4xx response calling UserApi#updateUser") e.printStackTrace() } catch (e: ServerException) { println("5xx response calling UserApi#updateUser") e.printStackTrace() } ``` ### Parameters | **username** | **kotlin.String**| name that need to be deleted | | | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **body** | [**User**](User.md)| Updated user object | | ### Return type null (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined