rxinferclient.AuthenticationApi

All URIs are relative to http://localhost:8000/v1

Method	HTTP request	Description
token_generate	POST /token/generate	Generate authentication token
token_roles	GET /token/roles	Get token roles

token_generate

TokenGenerateResponse token_generate()

Generate authentication token

Generates a new authentication token for accessing protected endpoints

Example

import rxinferclient
from rxinferclient.models.token_generate_response import TokenGenerateResponse
from rxinferclient.rest import ApiException
from pprint import pprint

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


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

    try:
        # Generate authentication token
        api_response = api_instance.token_generate()
        print("The response of AuthenticationApi->token_generate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->token_generate: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

TokenGenerateResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully generated authentication token	-
400	Unable to generate token	-

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

token_roles

TokenRolesResponse token_roles()

Get token roles

Retrieve the list of roles for a specific token

Example

• Bearer Authentication (ApiKeyAuth):

import rxinferclient
from rxinferclient.models.token_roles_response import TokenRolesResponse
from rxinferclient.rest import ApiException
from pprint import pprint

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

# 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.

# Configure Bearer authorization: ApiKeyAuth
configuration = rxinferclient.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # Get token roles
        api_response = api_instance.token_roles()
        print("The response of AuthenticationApi->token_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationApi->token_roles: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

TokenRolesResponse

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved token roles	-
401	Access token is missing or invalid	-

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