openapi-generator/samples/client/petstore/python/docs/UserApi.md

petstore_api.UserApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	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
get_user_by_name	GET /user/{username}	Get user by user name
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

create_user

create_user(body)

Create user

This can only be done by the logged in user.

Example

import time
import petstore_api
from petstore_api.api import user_api
from petstore_api.model.user import User
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)
    body = User(
        id=1,
        username="username_example",
        first_name="first_name_example",
        last_name="last_name_example",
        email="email_example",
        password="password_example",
        phone="phone_example",
        user_status=1,
    ) # User | Created user object

    # example passing only required values which don't have defaults set
    try:
        # Create user
        api_instance.create_user(body)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->create_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	User	Created user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_users_with_array_input

create_users_with_array_input(body)

Creates list of users with given input array

Example

import time
import petstore_api
from petstore_api.api import user_api
from petstore_api.model.user import User
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)
    body = [
        User(
            id=1,
            username="username_example",
            first_name="first_name_example",
            last_name="last_name_example",
            email="email_example",
            password="password_example",
            phone="phone_example",
            user_status=1,
        ),
    ] # [User] | List of user object

    # example passing only required values which don't have defaults set
    try:
        # Creates list of users with given input array
        api_instance.create_users_with_array_input(body)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->create_users_with_array_input: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	[User]	List of user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_users_with_list_input

create_users_with_list_input(body)

Creates list of users with given input array

Example

import time
import petstore_api
from petstore_api.api import user_api
from petstore_api.model.user import User
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)
    body = [
        User(
            id=1,
            username="username_example",
            first_name="first_name_example",
            last_name="last_name_example",
            email="email_example",
            password="password_example",
            phone="phone_example",
            user_status=1,
        ),
    ] # [User] | List of user object

    # example passing only required values which don't have defaults set
    try:
        # Creates list of users with given input array
        api_instance.create_users_with_list_input(body)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->create_users_with_list_input: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	[User]	List of user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_user

delete_user(username)

Delete user

This can only be done by the logged in user.

Example

import time
import petstore_api
from petstore_api.api import user_api
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)
    username = "username_example" # str | The name that needs to be deleted

    # example passing only required values which don't have defaults set
    try:
        # Delete user
        api_instance.delete_user(username)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->delete_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	The name that needs to be deleted

Return type

void (empty response body)

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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_by_name

User get_user_by_name(username)

Get user by user name

Example

import time
import petstore_api
from petstore_api.api import user_api
from petstore_api.model.user import User
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)
    username = "username_example" # str | The name that needs to be fetched. Use user1 for testing.

    # example passing only required values which don't have defaults set
    try:
        # Get user by user name
        api_response = api_instance.get_user_by_name(username)
        pprint(api_response)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->get_user_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	The name that needs to be fetched. Use user1 for testing.

Return type

User

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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

login_user

str login_user(username, password)

Logs user into the system

Example

import time
import petstore_api
from petstore_api.api import user_api
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)
    username = "username_example" # str | The user name for login
    password = "password_example" # str | The password for login in clear text

    # example passing only required values which don't have defaults set
    try:
        # Logs user into the system
        api_response = api_instance.login_user(username, password)
        pprint(api_response)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->login_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	The user name for login
password	str	The password for login in clear text

Return type

str

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	-

[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

Example

import time
import petstore_api
from petstore_api.api import user_api
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Logs out current logged in user session
        api_instance.logout_user()
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->logout_user: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user

update_user(username, body)

Updated user

This can only be done by the logged in user.

Example

import time
import petstore_api
from petstore_api.api import user_api
from petstore_api.model.user import User
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)
    username = "username_example" # str | name that need to be deleted
    body = User(
        id=1,
        username="username_example",
        first_name="first_name_example",
        last_name="last_name_example",
        email="email_example",
        password="password_example",
        phone="phone_example",
        user_status=1,
    ) # User | Updated user object

    # example passing only required values which don't have defaults set
    try:
        # Updated user
        api_instance.update_user(username, body)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->update_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	name that need to be deleted
body	User	Updated user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Invalid user supplied	-
404	User not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]