# UserApi All URIs are relative to *http://petstore.swagger.io/v2* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_user**](UserApi.md#create_user) | **POST** /user | Create user [**create_users_with_array_input**](UserApi.md#create_users_with_array_input) | **POST** /user/createWithArray | Creates list of users with given input array [**create_users_with_list_input**](UserApi.md#create_users_with_list_input) | **POST** /user/createWithList | Creates list of users with given input array [**delete_user**](UserApi.md#delete_user) | **DELETE** /user/{username} | Delete user [**get_user_by_name**](UserApi.md#get_user_by_name) | **GET** /user/{username} | Get user by user name [**login_user**](UserApi.md#login_user) | **GET** /user/login | Logs user into the system [**logout_user**](UserApi.md#logout_user) | **GET** /user/logout | Logs out current logged in user session [**update_user**](UserApi.md#update_user) | **PUT** /user/{username} | Updated user # **create_user** > `create_user`(req::`HTTP.Request`, `user`::`User`;) -> `Nothing` Create user This can only be done by the logged in user. ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **req** | **`HTTP.Request`** | The HTTP Request object | **`user`** | [**`User`**](User.md)| Created user object | ### Return type `Nothing` ### Authorization [api_key](../README.md#api_key) ### 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) # **create_users_with_array_input** > `create_users_with_array_input`(req::`HTTP.Request`, `user`::`Vector{User}`;) -> `Nothing` Creates list of users with given input array ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **req** | **`HTTP.Request`** | The HTTP Request object | **`user`** | [**`Vector{User}`**](User.md)| List of user object | ### Return type `Nothing` ### Authorization [api_key](../README.md#api_key) ### 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) # **create_users_with_list_input** > `create_users_with_list_input`(req::`HTTP.Request`, `user`::`Vector{User}`;) -> `Nothing` Creates list of users with given input array ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **req** | **`HTTP.Request`** | The HTTP Request object | **`user`** | [**`Vector{User}`**](User.md)| List of user object | ### Return type `Nothing` ### Authorization [api_key](../README.md#api_key) ### 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) # **delete_user** > `delete_user`(req::`HTTP.Request`, `username`::`String`;) -> `Nothing` Delete user This can only be done by the logged in user. ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **req** | **`HTTP.Request`** | The HTTP Request object | **`username`** | **`String`**| The name that needs to be deleted | ### Return type `Nothing` ### Authorization [api_key](../README.md#api_key) ### 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_user_by_name** > `get_user_by_name`(req::`HTTP.Request`, `username`::`String`;) -> `User` Get user by user name ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **req** | **`HTTP.Request`** | The HTTP Request object | **`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 [[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) # **login_user** > `login_user`(req::`HTTP.Request`, `username`::`String`, `password`::`String`;) -> `String` Logs user into the system ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **req** | **`HTTP.Request`** | The HTTP Request object | **`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 [[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) # **logout_user** > `logout_user`(req::`HTTP.Request`;) -> `Nothing` Logs out current logged in user session ### Required Parameters This endpoint does not need any parameter. ### Return type `Nothing` ### Authorization [api_key](../README.md#api_key) ### 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) # **update_user** > `update_user`(req::`HTTP.Request`, `username`::`String`, `user`::`User`;) -> `Nothing` Updated user This can only be done by the logged in user. ### Required Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **req** | **`HTTP.Request`** | The HTTP Request object | **`username`** | **`String`**| name that need to be deleted | **`user`** | [**`User`**](User.md)| Updated user object | ### Return type `Nothing` ### Authorization [api_key](../README.md#api_key) ### 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)