sdkms.v1.apis.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.authentication_api.AuthenticationApi(api_client=None)[source]

Bases: object

__init__(api_client=None)[source]

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

Authenticate a user or an app to SDKMS to begin a session. The caller needs to provide a basic 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:: AuthResponse
Returns:

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

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

Returns a 200-class status code if the server is handling requests, or a 500-class status code if the server is having problems.

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.

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

Returns information about the SDKMS server version and the client API version that it supports.

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

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

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

Authenticate a user or an app to SDKMS using existing session token, to generate a new session. The caller needs to provide bearer authentication token of an existing valid session. The response body contains a bearer authentication token of the new session created.

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

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

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

Refreshes an existing session, thus extending the expiration time of the existing bearer authentication token. The caller needs to provide bearer token of sesssion need to be refreshed. The response body is empty.

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.

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

Select one of user’s account to proceed. This is applicable when a user is associated with more than one account. 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).
body (SelectAccountRequest) – Select Account Request (required)

Return type:

SelectAccountResponse

Returns:

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

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

Terminate an authenticated session. After this call, the provided bearer authentication token will be invalidated and cannot be used to make any further API calls.

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.

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

Re-authenticate to unlock two factor configuration. Two factor configuration must be unlocked to enable or disable two factor authentication, add or remove two factor devices, or regenerate recovery codes. 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:: None
Returns:

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