openaws_client.AuthApi

All URIs are relative to http://localhost

Method	HTTP request	Description
auth_db_bearer_login_v1_auth_jwt_login_post	POST /v1/auth/jwt/login	Auth:Db Bearer.Login
auth_db_bearer_logout_v1_auth_jwt_logout_post	POST /v1/auth/jwt/logout	Auth:Db Bearer.Logout
auth_db_cookie_login_v1_auth_login_post	POST /v1/auth/login	Auth:Db Cookie.Login
auth_db_cookie_logout_v1_auth_logout_post	POST /v1/auth/logout	Auth:Db Cookie.Logout
register_register_v1_auth_register_post	POST /v1/auth/register	Register:Register
reset_forgot_password_v1_auth_forgot_password_post	POST /v1/auth/forgot-password	Reset:Forgot Password
reset_reset_password_v1_auth_reset_password_post	POST /v1/auth/reset-password	Reset:Reset Password
verify_request_token_v1_auth_request_verify_token_post	POST /v1/auth/request-verify-token	Verify:Request-Token
verify_verify_v1_auth_verify_post	POST /v1/auth/verify	Verify:Verify

auth_db_bearer_login_v1_auth_jwt_login_post

BearerResponse auth_db_bearer_login_v1_auth_jwt_login_post(username, password, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)

Auth:Db Bearer.Login

Example

import time
import os
import openaws_client
from openaws_client.models.bearer_response import BearerResponse
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)
    username = 'username_example' # str | 
    password = 'password_example' # str | 
    grant_type = 'grant_type_example' # str |  (optional)
    scope = '' # str |  (optional) (default to '')
    client_id = 'client_id_example' # str |  (optional)
    client_secret = 'client_secret_example' # str |  (optional)

    try:
        # Auth:Db Bearer.Login
        api_response = api_instance.auth_db_bearer_login_v1_auth_jwt_login_post(username, password, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)
        print("The response of AuthApi->auth_db_bearer_login_v1_auth_jwt_login_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->auth_db_bearer_login_v1_auth_jwt_login_post: %s\n" % e)

Parameters

Name	Type	Notes
username	str
password	str
grant_type	str	[optional]
scope	str	[optional] [default to '']
client_id	str	[optional]
client_secret	str	[optional]

Return type

BearerResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
422	Validation Error	-

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

auth_db_bearer_logout_v1_auth_jwt_logout_post

object auth_db_bearer_logout_v1_auth_jwt_logout_post()

Auth:Db Bearer.Logout

Example

OAuth Authentication (OAuth2PasswordBearer):
Api Key Authentication (APIKeyCookie):

import time
import os
import openaws_client
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure API key authorization: APIKeyCookie
configuration.api_key['APIKeyCookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyCookie'] = 'Bearer'

# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)

    try:
        # Auth:Db Bearer.Logout
        api_response = api_instance.auth_db_bearer_logout_v1_auth_jwt_logout_post()
        print("The response of AuthApi->auth_db_bearer_logout_v1_auth_jwt_logout_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->auth_db_bearer_logout_v1_auth_jwt_logout_post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

OAuth2PasswordBearer, APIKeyCookie

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
401	Missing token or inactive user.	-

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

auth_db_cookie_login_v1_auth_login_post

object auth_db_cookie_login_v1_auth_login_post(username, password, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)

Auth:Db Cookie.Login

Example

import time
import os
import openaws_client
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)
    username = 'username_example' # str | 
    password = 'password_example' # str | 
    grant_type = 'grant_type_example' # str |  (optional)
    scope = '' # str |  (optional) (default to '')
    client_id = 'client_id_example' # str |  (optional)
    client_secret = 'client_secret_example' # str |  (optional)

    try:
        # Auth:Db Cookie.Login
        api_response = api_instance.auth_db_cookie_login_v1_auth_login_post(username, password, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)
        print("The response of AuthApi->auth_db_cookie_login_v1_auth_login_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->auth_db_cookie_login_v1_auth_login_post: %s\n" % e)

Parameters

Name	Type	Notes
username	str
password	str
grant_type	str	[optional]
scope	str	[optional] [default to '']
client_id	str	[optional]
client_secret	str	[optional]

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
422	Validation Error	-

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

auth_db_cookie_logout_v1_auth_logout_post

object auth_db_cookie_logout_v1_auth_logout_post()

Auth:Db Cookie.Logout

Example

OAuth Authentication (OAuth2PasswordBearer):
Api Key Authentication (APIKeyCookie):

import time
import os
import openaws_client
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure API key authorization: APIKeyCookie
configuration.api_key['APIKeyCookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyCookie'] = 'Bearer'

# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)

    try:
        # Auth:Db Cookie.Logout
        api_response = api_instance.auth_db_cookie_logout_v1_auth_logout_post()
        print("The response of AuthApi->auth_db_cookie_logout_v1_auth_logout_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->auth_db_cookie_logout_v1_auth_logout_post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

OAuth2PasswordBearer, APIKeyCookie

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
401	Missing token or inactive user.	-

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

register_register_v1_auth_register_post

UserRead register_register_v1_auth_register_post(user_create)

Register:Register

Example

import time
import os
import openaws_client
from openaws_client.models.user_create import UserCreate
from openaws_client.models.user_read import UserRead
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)
    user_create = openaws_client.UserCreate() # UserCreate | 

    try:
        # Register:Register
        api_response = api_instance.register_register_v1_auth_register_post(user_create)
        print("The response of AuthApi->register_register_v1_auth_register_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->register_register_v1_auth_register_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_create	UserCreate

Return type

UserRead

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful Response	-
400	Bad Request	-
422	Validation Error	-

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

reset_forgot_password_v1_auth_forgot_password_post

object reset_forgot_password_v1_auth_forgot_password_post(body_reset_forgot_password_v1_auth_forgot_password_post)

Reset:Forgot Password

Example

import time
import os
import openaws_client
from openaws_client.models.body_reset_forgot_password_v1_auth_forgot_password_post import BodyResetForgotPasswordV1AuthForgotPasswordPost
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)
    body_reset_forgot_password_v1_auth_forgot_password_post = openaws_client.BodyResetForgotPasswordV1AuthForgotPasswordPost() # BodyResetForgotPasswordV1AuthForgotPasswordPost | 

    try:
        # Reset:Forgot Password
        api_response = api_instance.reset_forgot_password_v1_auth_forgot_password_post(body_reset_forgot_password_v1_auth_forgot_password_post)
        print("The response of AuthApi->reset_forgot_password_v1_auth_forgot_password_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->reset_forgot_password_v1_auth_forgot_password_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body_reset_forgot_password_v1_auth_forgot_password_post	BodyResetForgotPasswordV1AuthForgotPasswordPost

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Successful Response	-
422	Validation Error	-

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

reset_reset_password_v1_auth_reset_password_post

object reset_reset_password_v1_auth_reset_password_post(body_reset_reset_password_v1_auth_reset_password_post)

Reset:Reset Password

Example

import time
import os
import openaws_client
from openaws_client.models.body_reset_reset_password_v1_auth_reset_password_post import BodyResetResetPasswordV1AuthResetPasswordPost
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)
    body_reset_reset_password_v1_auth_reset_password_post = openaws_client.BodyResetResetPasswordV1AuthResetPasswordPost() # BodyResetResetPasswordV1AuthResetPasswordPost | 

    try:
        # Reset:Reset Password
        api_response = api_instance.reset_reset_password_v1_auth_reset_password_post(body_reset_reset_password_v1_auth_reset_password_post)
        print("The response of AuthApi->reset_reset_password_v1_auth_reset_password_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->reset_reset_password_v1_auth_reset_password_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body_reset_reset_password_v1_auth_reset_password_post	BodyResetResetPasswordV1AuthResetPasswordPost

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
422	Validation Error	-

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

verify_request_token_v1_auth_request_verify_token_post

object verify_request_token_v1_auth_request_verify_token_post(body_verify_request_token_v1_auth_request_verify_token_post)

Verify:Request-Token

Example

import time
import os
import openaws_client
from openaws_client.models.body_verify_request_token_v1_auth_request_verify_token_post import BodyVerifyRequestTokenV1AuthRequestVerifyTokenPost
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)
    body_verify_request_token_v1_auth_request_verify_token_post = openaws_client.BodyVerifyRequestTokenV1AuthRequestVerifyTokenPost() # BodyVerifyRequestTokenV1AuthRequestVerifyTokenPost | 

    try:
        # Verify:Request-Token
        api_response = api_instance.verify_request_token_v1_auth_request_verify_token_post(body_verify_request_token_v1_auth_request_verify_token_post)
        print("The response of AuthApi->verify_request_token_v1_auth_request_verify_token_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->verify_request_token_v1_auth_request_verify_token_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body_verify_request_token_v1_auth_request_verify_token_post	BodyVerifyRequestTokenV1AuthRequestVerifyTokenPost

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Successful Response	-
422	Validation Error	-

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

verify_verify_v1_auth_verify_post

UserRead verify_verify_v1_auth_verify_post(body_verify_verify_v1_auth_verify_post)

Verify:Verify

Example

import time
import os
import openaws_client
from openaws_client.models.body_verify_verify_v1_auth_verify_post import BodyVerifyVerifyV1AuthVerifyPost
from openaws_client.models.user_read import UserRead
from openaws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openaws_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openaws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openaws_client.AuthApi(api_client)
    body_verify_verify_v1_auth_verify_post = openaws_client.BodyVerifyVerifyV1AuthVerifyPost() # BodyVerifyVerifyV1AuthVerifyPost | 

    try:
        # Verify:Verify
        api_response = api_instance.verify_verify_v1_auth_verify_post(body_verify_verify_v1_auth_verify_post)
        print("The response of AuthApi->verify_verify_v1_auth_verify_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->verify_verify_v1_auth_verify_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body_verify_verify_v1_auth_verify_post	BodyVerifyVerifyV1AuthVerifyPost

Return type

UserRead

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
422	Validation Error	-

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

Files

AuthApi.md

Latest commit

History

AuthApi.md

File metadata and controls

openaws_client.AuthApi

auth_db_bearer_login_v1_auth_jwt_login_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

auth_db_bearer_logout_v1_auth_jwt_logout_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

auth_db_cookie_login_v1_auth_login_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

auth_db_cookie_logout_v1_auth_logout_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

register_register_v1_auth_register_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reset_forgot_password_v1_auth_forgot_password_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reset_reset_password_v1_auth_reset_password_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verify_request_token_v1_auth_request_verify_token_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verify_verify_v1_auth_verify_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details