sdkms.v1.apis.child_account_users_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

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.child_account_users_api.ChildAccountUsersApi(api_client=None)[source]

Bases: object

__init__(api_client=None)[source]
create_child_account_user(body, async_call=False, **kwargs)[source]

Create a new user user in a child account.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • body (ChildAccountUserRequest) – User in child account (required)

Return type:

ChildAccountUser

Returns:

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

delete_child_account_user(user_id, async_call=False, **kwargs)[source]

Completely delete a user in child account.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

Return type:

None

Returns:

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

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

Get all users in a child account

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • account_id (str) – Account Identifier (required)

Return type:

list[ChildAccountUser]

Returns:

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

get_child_account_user(user_id, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

Return type:

ChildAccountUser

Returns:

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

update_child_account_user(user_id, body, async_call=False, **kwargs)[source]

Change a child account user’s properties.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

  • body (ChildAccountUserRequest) – User in child account (required)

Return type:

ChildAccountUser

Returns:

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