AuthApi.md

bsg_api.AuthApi

All URIs are relative to https://one-api.bsg.world

Method	HTTP request	Description
login	POST /api/auth/login	Receive JWT token
refresh_token	POST /api/auth/refresh	Refresh JWT token

login

TokenSchema login(login_request)

Receive JWT token

Receive JWT token to use with other method. Use live/test api-key to login. JWT-token has limited lifetime and have to be refreshed before become expired

Example

import bsg_api
from bsg_api.models.login_request import LoginRequest
from bsg_api.models.token_schema import TokenSchema
from bsg_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://one-api.bsg.world
# See configuration.py for a list of all supported configuration parameters.
configuration = bsg_api.Configuration(
    host = "https://one-api.bsg.world"
)


# Enter a context with an instance of the API client
with bsg_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bsg_api.AuthApi(api_client)
    login_request = {"api_key":"live_XXXXXXXXXXXXXXXXXXXX"} # LoginRequest | 

    try:
        # Receive JWT token
        api_response = api_instance.login(login_request)
        print("The response of AuthApi->login:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->login: %s\n" % e)

Parameters

Name	Type	Description	Notes
login_request	LoginRequest

Return type

TokenSchema

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

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

refresh_token

TokenSchema refresh_token()

Refresh JWT token

Refresh JWT token. Return new JWT-token to new term. It's necessary to call when actual JWT-token almost expired

Example

• Bearer (JWT) Authentication (ExternalAuth):

import bsg_api
from bsg_api.models.token_schema import TokenSchema
from bsg_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://one-api.bsg.world
# See configuration.py for a list of all supported configuration parameters.
configuration = bsg_api.Configuration(
    host = "https://one-api.bsg.world"
)

# 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 (JWT): ExternalAuth
configuration = bsg_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

Parameters

This endpoint does not need any parameter.

Return type

TokenSchema

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

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