Skip to content

Latest commit

 

History

History
234 lines (174 loc) · 7.32 KB

MFAApi.md

File metadata and controls

234 lines (174 loc) · 7.32 KB
Raw

mailinabox_api.MFAApi

All URIs are relative to https://box.example.com/admin

Method HTTP request Description
mfa_status POST /mfa/status Retrieve MFA status for you or another user
mfa_totp_disable POST /mfa/disable Disable multi-factor authentication for you or another user
mfa_totp_enable POST /mfa/totp/enable Enable TOTP authentication

mfa_status

MfaStatusResponse mfa_status()

Retrieve MFA status for you or another user

Retrieves which type of MFA is used and configuration

Example

  • Basic Authentication (basicAuth):
from __future__ import print_function
import time
import mailinabox_api
from mailinabox_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://box.example.com/admin
# See configuration.py for a list of all supported configuration parameters.
configuration = mailinabox_api.Configuration(
    host = "https://box.example.com/admin"
)

# 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: basicAuth
configuration = mailinabox_api.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with mailinabox_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailinabox_api.MFAApi(api_client)
    
    try:
        # Retrieve MFA status for you or another user
        api_response = api_instance.mfa_status()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MFAApi->mfa_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MfaStatusResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/html

HTTP response details

Status code Description Response headers
200 Successful operation -
403 Forbidden -

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

mfa_totp_disable

str mfa_totp_disable(mfa_id=mfa_id)

Disable multi-factor authentication for you or another user

Disables multi-factor authentication for the currently logged-in admin user or another user if a 'user' parameter is submitted. Either disables all multi-factor authentication methods or the method corresponding to the optional property mfa_id.

Example

  • Basic Authentication (basicAuth):
from __future__ import print_function
import time
import mailinabox_api
from mailinabox_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://box.example.com/admin
# See configuration.py for a list of all supported configuration parameters.
configuration = mailinabox_api.Configuration(
    host = "https://box.example.com/admin"
)

# 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: basicAuth
configuration = mailinabox_api.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with mailinabox_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailinabox_api.MFAApi(api_client)
    mfa_id = 'mfa_id_example' # str |  (optional)

    try:
        # Disable multi-factor authentication for you or another user
        api_response = api_instance.mfa_totp_disable(mfa_id=mfa_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MFAApi->mfa_totp_disable: %s\n" % e)

Parameters

Name Type Description Notes
mfa_id str [optional]

Return type

str

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: text/html

HTTP response details

Status code Description Response headers
200 Successful operation -
403 Forbidden -

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

mfa_totp_enable

str mfa_totp_enable(secret, code, label=label)

Enable TOTP authentication

Enables TOTP authentication for the currently logged-in admin user

Example

  • Basic Authentication (basicAuth):
from __future__ import print_function
import time
import mailinabox_api
from mailinabox_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://box.example.com/admin
# See configuration.py for a list of all supported configuration parameters.
configuration = mailinabox_api.Configuration(
    host = "https://box.example.com/admin"
)

# 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: basicAuth
configuration = mailinabox_api.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with mailinabox_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailinabox_api.MFAApi(api_client)
    secret = 'secret_example' # str | 
code = 'code_example' # str | 
label = 'label_example' # str |  (optional)

    try:
        # Enable TOTP authentication
        api_response = api_instance.mfa_totp_enable(secret, code, label=label)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MFAApi->mfa_totp_enable: %s\n" % e)

Parameters

Name Type Description Notes
secret str
code str
label str [optional]

Return type

str

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: text/html

HTTP response details

Status code Description Response headers
200 Successful operation -
400 Bad request -
403 Forbidden -

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