sdkms.v1.apis.two_factor_authentication_api module

Fortanix DSM REST API

This is a set of REST APIs for accessing the Fortanix Data Security Manager. This includes APIs for managing accounts, and for performing cryptographic and key management operations.

OpenAPI spec version: 1.0.0-20200608 Contact: support@fortanix.com Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class sdkms.v1.apis.two_factor_authentication_api.TwoFactorAuthenticationApi(api_client=None)[source]

Bases: object

__init__(api_client=None)[source]

authorize_recovery_code(async_call=False, **kwargs)[source]

Complete two factor authentication with a backup recovery code. The caller needs to provide a bearer token for the session in the request body. Each recovery code may only be used once, so users should update their two factor configuration after using this API.

Parameters:: async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
Return type:: None
Returns:

If the method is called asynchronously, returns the request thread.

authorize_u2_f(async_call=False, **kwargs)[source]

Complete two factor authentication with a U2F authentication token to authenticate to SDKMS. The response body contains a bearer authentication token which needs to be provided by subsequent calls for the duration of the session.

Parameters:: async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
Return type:: None
Returns:

If the method is called asynchronously, returns the request thread.

generate_recovery_codes(async_call=False, **kwargs)[source]

Generate backup recovery codes that may be used to complete complete two factor authentication. The caller needs to provide a bearer token for the session in the request body. Two factor configuration must be unlocked to use this API.

Parameters:: async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
Return type:: RecoveryCodes
Returns:

If the method is called asynchronously, returns the request thread.

generate_u2_f_challenge(async_call=False, **kwargs)[source]

Generate a new challenge that may be used to register U2F devices. The caller needs to provide a bearer token for the session in the request body.

Parameters:: async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
Return type:: MfaChallenge
Returns:

If the method is called asynchronously, returns the request thread.

lock2_f(async_call=False, **kwargs)[source]

Lock two factor configuration after completing two factor reconfiguration. The caller needs to provide a bearer token for the session in the request body. If this API is not called, two factor configuration will be locked automatically after ten minutes.

Parameters:: async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
Return type:: None
Returns:

If the method is called asynchronously, returns the request thread.