6.1 KiB
USER_API
All URIs are relative to http://petstore.swagger.io:80/v2
| Feature | HTTP request | Description |
|---|---|---|
| create_user | Post /user | Create user |
| create_users_with_array_input | Post /user/createWithArray | Creates list of users with given input array |
| create_users_with_list_input | Post /user/createWithList | Creates list of users with given input array |
| delete_user | Delete /user/{username} | Delete user |
| login_user | Get /user/login | Logs user into the system |
| logout_user | Get /user/logout | Logs out current logged in user session |
| update_user | Put /user/{username} | Updated user |
| user_by_name | Get /user/{username} | Get user by user name |
create_user
create_user (user: USER )
Create user
This can only be done by the logged in user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| user | USER | Created user object |
Return type
{empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_users_with_array_input
create_users_with_array_input (user: LIST [USER] )
Creates list of users with given input array
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| user | LIST [USER] | List of user object |
Return type
{empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_users_with_list_input
create_users_with_list_input (user: LIST [USER] )
Creates list of users with given input array
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| user | LIST [USER] | List of user object |
Return type
{empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_user
delete_user (username: STRING_32 )
Delete user
This can only be done by the logged in user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | STRING_32 | The name that needs to be deleted |
Return type
{empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
login_user
login_user (username: STRING_32 ; password: STRING_32 ): detachable STRING_32
Logs user into the system
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | STRING_32 | The user name for login | |
| password | STRING_32 | The password for login in clear text |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
logout_user
logout_user
Logs out current logged in user session
Parameters
This endpoint does not need any parameter.
Return type
{empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_user
update_user (username: STRING_32 ; user: USER )
Updated user
This can only be done by the logged in user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | STRING_32 | name that need to be deleted | |
| user | USER | Updated user object |
Return type
{empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
user_by_name
user_by_name (username: STRING_32 ): detachable USER
Get user by user name
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | STRING_32 | The name that needs to be fetched. Use user1 for testing. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]