Skip to content

TwoFATemplatesApi.md

Latest commit

 

History

History
341 lines (237 loc) · 11.5 KB

TwoFATemplatesApi.md

File metadata and controls

341 lines (237 loc) · 11.5 KB

bsg_api.TwoFATemplatesApi

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

Method HTTP request Description
otp_template GET /api/2fa/authentications/templates/{templateId} Get message template
otp_template_create POST /api/2fa/authentications/templates Create a message template
otp_template_delete DELETE /api/2fa/authentications/templates/{templateId} Delete a message template
otp_template_list GET /api/2fa/authentications/templates List of message templates

otp_template

OtpTemplate200Response otp_template(template_id)

Get message template

Example

  • Bearer (JWT) Authentication (ExternalAuth):
import bsg_api
from bsg_api.models.otp_template200_response import OtpTemplate200Response
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.TwoFATemplatesApi(api_client)
    template_id = 56 # int | Template id

    try:
        # Get message template
        api_response = api_instance.otp_template(template_id)
        print("The response of TwoFATemplatesApi->otp_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TwoFATemplatesApi->otp_template: %s\n" % e)

Parameters

Name Type Description Notes
template_id int Template id

Return type

OtpTemplate200Response

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Get template info -
404 Model not found -

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

otp_template_create

OtpTemplateCreate200Response otp_template_create(otp_template_create_request)

Create a message template

This method creates a new message template used for sending the OTP code.

Please note that after creating the template, it is moderated. This template will be available for sending messages with the OTP code only after moderation. Once it’s ready, its status will be changed from Requested to Approved.

Example

  • Bearer (JWT) Authentication (ExternalAuth):
import bsg_api
from bsg_api.models.otp_template_create200_response import OtpTemplateCreate200Response
from bsg_api.models.otp_template_create_request import OtpTemplateCreateRequest
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.TwoFATemplatesApi(api_client)
    otp_template_create_request = bsg_api.OtpTemplateCreateRequest() # OtpTemplateCreateRequest | 

    try:
        # Create a message template
        api_response = api_instance.otp_template_create(otp_template_create_request)
        print("The response of TwoFATemplatesApi->otp_template_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TwoFATemplatesApi->otp_template_create: %s\n" % e)

Parameters

Name Type Description Notes
otp_template_create_request OtpTemplateCreateRequest

Return type

OtpTemplateCreate200Response

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Stored template info -
422 The given data was invalid. -

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

otp_template_delete

OtpTemplateDelete200Response otp_template_delete(template_id)

Delete a message template

This method deletes the message template for sending the OTP code based on its unique identifier.

Example

  • Bearer (JWT) Authentication (ExternalAuth):
import bsg_api
from bsg_api.models.otp_template_delete200_response import OtpTemplateDelete200Response
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.TwoFATemplatesApi(api_client)
    template_id = 56 # int | The ID of the message template that you want to delete. From 1 to 9 digits.

    try:
        # Delete a message template
        api_response = api_instance.otp_template_delete(template_id)
        print("The response of TwoFATemplatesApi->otp_template_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TwoFATemplatesApi->otp_template_delete: %s\n" % e)

Parameters

Name Type Description Notes
template_id int The ID of the message template that you want to delete. From 1 to 9 digits.

Return type

OtpTemplateDelete200Response

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful operation -
422 Default template is not available for deletion -
404 Template not found -

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

otp_template_list

OtpTemplateList200Response otp_template_list(page_offset=page_offset, page_limit=page_limit, filter_ids=filter_ids, filter_status=filter_status, sort=sort, way=way)

List of message templates

This method returns a list of message templates for sending OTR code, allowing you to filter them by various parameters.

Example

  • Bearer (JWT) Authentication (ExternalAuth):
import bsg_api
from bsg_api.models.otp_template_list200_response import OtpTemplateList200Response
from bsg_api.models.sort_way import SortWay
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.TwoFATemplatesApi(api_client)
    page_offset = 0 # int |  (optional) (default to 0)
    page_limit = 10 # int |  (optional) (default to 10)
    filter_ids = [56] # List[int] |  (optional)
    filter_status = 'filter_status_example' # str |  (optional)
    sort = template_id # str | Sorting by (optional) (default to template_id)
    way = asc # SortWay |  (optional) (default to asc)

    try:
        # List of message templates
        api_response = api_instance.otp_template_list(page_offset=page_offset, page_limit=page_limit, filter_ids=filter_ids, filter_status=filter_status, sort=sort, way=way)
        print("The response of TwoFATemplatesApi->otp_template_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TwoFATemplatesApi->otp_template_list: %s\n" % e)

Parameters

Name Type Description Notes
page_offset int [optional] [default to 0]
page_limit int [optional] [default to 10]
filter_ids List[int] [optional]
filter_status str [optional]
sort str Sorting by [optional] [default to template_id]
way SortWay [optional] [default to asc]

Return type

OtpTemplateList200Response

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful operation: TwoFA authentications list -

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