Skip to content

Latest commit

 

History

History
270 lines (191 loc) · 8.36 KB

MFAApi.md

File metadata and controls

270 lines (191 loc) · 8.36 KB
Raw

bandwidth.MFAApi

All URIs are relative to http://localhost

Method HTTP request Description
generate_messaging_code POST /accounts/{accountId}/code/messaging Messaging Authentication Code
generate_voice_code POST /accounts/{accountId}/code/voice Voice Authentication Code
verify_code POST /accounts/{accountId}/code/verify Verify Authentication Code

generate_messaging_code

MessagingCodeResponse generate_messaging_code(account_id, code_request)

Messaging Authentication Code

Send an MFA code via text message (SMS).

Example

  • Basic Authentication (Basic):
import bandwidth
from bandwidth.models.code_request import CodeRequest
from bandwidth.models.messaging_code_response import MessagingCodeResponse
from bandwidth.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 = bandwidth.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.

# Configure HTTP basic authorization: Basic
configuration = bandwidth.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with bandwidth.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bandwidth.MFAApi(api_client)
    account_id = '9900000' # str | Your Bandwidth Account ID.
    code_request = bandwidth.CodeRequest() # CodeRequest | MFA code request body.

    try:
        # Messaging Authentication Code
        api_response = api_instance.generate_messaging_code(account_id, code_request)
        print("The response of MFAApi->generate_messaging_code:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MFAApi->generate_messaging_code: %s\n" % e)

Parameters

Name Type Description Notes
account_id str Your Bandwidth Account ID.
code_request CodeRequest MFA code request body.

Return type

MessagingCodeResponse

Authorization

Basic

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
500 Internal Server Error -

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

generate_voice_code

VoiceCodeResponse generate_voice_code(account_id, code_request)

Voice Authentication Code

Send an MFA Code via a phone call.

Example

  • Basic Authentication (Basic):
import bandwidth
from bandwidth.models.code_request import CodeRequest
from bandwidth.models.voice_code_response import VoiceCodeResponse
from bandwidth.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 = bandwidth.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.

# Configure HTTP basic authorization: Basic
configuration = bandwidth.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with bandwidth.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bandwidth.MFAApi(api_client)
    account_id = '9900000' # str | Your Bandwidth Account ID.
    code_request = bandwidth.CodeRequest() # CodeRequest | MFA code request body.

    try:
        # Voice Authentication Code
        api_response = api_instance.generate_voice_code(account_id, code_request)
        print("The response of MFAApi->generate_voice_code:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MFAApi->generate_voice_code: %s\n" % e)

Parameters

Name Type Description Notes
account_id str Your Bandwidth Account ID.
code_request CodeRequest MFA code request body.

Return type

VoiceCodeResponse

Authorization

Basic

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
500 Internal Server Error -

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

verify_code

VerifyCodeResponse verify_code(account_id, verify_code_request)

Verify Authentication Code

Verify a previously sent MFA code.

Example

  • Basic Authentication (Basic):
import bandwidth
from bandwidth.models.verify_code_request import VerifyCodeRequest
from bandwidth.models.verify_code_response import VerifyCodeResponse
from bandwidth.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 = bandwidth.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.

# Configure HTTP basic authorization: Basic
configuration = bandwidth.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with bandwidth.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bandwidth.MFAApi(api_client)
    account_id = '9900000' # str | Your Bandwidth Account ID.
    verify_code_request = bandwidth.VerifyCodeRequest() # VerifyCodeRequest | MFA code verify request body.

    try:
        # Verify Authentication Code
        api_response = api_instance.verify_code(account_id, verify_code_request)
        print("The response of MFAApi->verify_code:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MFAApi->verify_code: %s\n" % e)

Parameters

Name Type Description Notes
account_id str Your Bandwidth Account ID.
verify_code_request VerifyCodeRequest MFA code verify request body.

Return type

VerifyCodeResponse

Authorization

Basic

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
429 Too Many Requests -
500 Internal Server Error -

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