Skip to content

MFAApi.md

Latest commit

 

History

History
320 lines (257 loc) · 10.1 KB

MFAApi.md

File metadata and controls

320 lines (257 loc) · 10.1 KB

Bandwidth.Standard.Api.MFAApi

All URIs are relative to http://localhost

Method HTTP request Description
GenerateMessagingCode POST /accounts/{accountId}/code/messaging Messaging Authentication Code
GenerateVoiceCode POST /accounts/{accountId}/code/voice Voice Authentication Code
VerifyCode POST /accounts/{accountId}/code/verify Verify Authentication Code

GenerateMessagingCode

MessagingCodeResponse GenerateMessagingCode (string accountId, CodeRequest codeRequest)

Messaging Authentication Code

Send an MFA code via text message (SMS).

Example

using System.Collections.Generic;
using System.Diagnostics;
using Bandwidth.Standard.Api;
using Bandwidth.Standard.Client;
using Bandwidth.Standard.Model;

namespace Example
{
    public class GenerateMessagingCodeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: OAuth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MFAApi(config);
            var accountId = 9900000;  // string | Your Bandwidth Account ID.
            var codeRequest = new CodeRequest(); // CodeRequest | MFA code request body.

            try
            {
                // Messaging Authentication Code
                MessagingCodeResponse result = apiInstance.GenerateMessagingCode(accountId, codeRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MFAApi.GenerateMessagingCode: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GenerateMessagingCodeWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Messaging Authentication Code
    ApiResponse<MessagingCodeResponse> response = apiInstance.GenerateMessagingCodeWithHttpInfo(accountId, codeRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling MFAApi.GenerateMessagingCodeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
accountId string Your Bandwidth Account ID.
codeRequest CodeRequest MFA code request body.

Return type

MessagingCodeResponse

Authorization

Basic, OAuth2

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]

GenerateVoiceCode

VoiceCodeResponse GenerateVoiceCode (string accountId, CodeRequest codeRequest)

Voice Authentication Code

Send an MFA Code via a phone call.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Bandwidth.Standard.Api;
using Bandwidth.Standard.Client;
using Bandwidth.Standard.Model;

namespace Example
{
    public class GenerateVoiceCodeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: OAuth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MFAApi(config);
            var accountId = 9900000;  // string | Your Bandwidth Account ID.
            var codeRequest = new CodeRequest(); // CodeRequest | MFA code request body.

            try
            {
                // Voice Authentication Code
                VoiceCodeResponse result = apiInstance.GenerateVoiceCode(accountId, codeRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MFAApi.GenerateVoiceCode: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GenerateVoiceCodeWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Voice Authentication Code
    ApiResponse<VoiceCodeResponse> response = apiInstance.GenerateVoiceCodeWithHttpInfo(accountId, codeRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling MFAApi.GenerateVoiceCodeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
accountId string Your Bandwidth Account ID.
codeRequest CodeRequest MFA code request body.

Return type

VoiceCodeResponse

Authorization

Basic, OAuth2

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]

VerifyCode

VerifyCodeResponse VerifyCode (string accountId, VerifyCodeRequest verifyCodeRequest)

Verify Authentication Code

Verify a previously sent MFA code.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Bandwidth.Standard.Api;
using Bandwidth.Standard.Client;
using Bandwidth.Standard.Model;

namespace Example
{
    public class VerifyCodeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: OAuth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MFAApi(config);
            var accountId = 9900000;  // string | Your Bandwidth Account ID.
            var verifyCodeRequest = new VerifyCodeRequest(); // VerifyCodeRequest | MFA code verify request body.

            try
            {
                // Verify Authentication Code
                VerifyCodeResponse result = apiInstance.VerifyCode(accountId, verifyCodeRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MFAApi.VerifyCode: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the VerifyCodeWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Verify Authentication Code
    ApiResponse<VerifyCodeResponse> response = apiInstance.VerifyCodeWithHttpInfo(accountId, verifyCodeRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling MFAApi.VerifyCodeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
accountId string Your Bandwidth Account ID.
verifyCodeRequest VerifyCodeRequest MFA code verify request body.

Return type

VerifyCodeResponse

Authorization

Basic, OAuth2

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]