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

Bases: object

__init__(api_client=None)[source]

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

Create a new account with the specified properties.

Parameters:

async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
body (AccountRequest) – Properties to assign to Account. (required)

Return type:

Account

Returns:

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

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

Remove an account from SDKMS.

Parameters:

async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
account_id (str) – Account Identifier (required)

Return type:

None

Returns:

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

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

Look up an account by account ID.

Parameters:

async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
account_id (str) – Account Identifier (required)

Return type:

Account

Returns:

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

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

Get detailed information on all accounts the current user has access to.

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

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

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

Update the properties of an account. Only certain properties may be changed with this API.

Parameters:

async_call (bool) – Whether the call should be performed asynchronously. (Default is False).
account_id (str) – Account Identifier (required)
body (AccountRequest) – Properties to assign to Account. (required)

Return type:

Account

Returns:

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