sdkms.v1.apis.groups_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.groups_api.GroupsApi(api_client=None)[source]

Bases: object

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

Given an Azure HMG configuration, fetch a list of available Azure key vaults which can be used to back a group.

Parameters:

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

Return type:

list[AzureKeyVaultResponse]

Returns:

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

check_group_hmg(group_id, async_call=False, **kwargs)[source]

Check that the HMG configuration for a particular group is valid and reachable.

Parameters:

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

  • group_id (str) – Group Identifier (required)

Return type:

None

Returns:

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

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

Check that the HMG configuration provided is valid and reachable.

Parameters:

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

  • body (HmgConfig) – Request to check validity and reachability of an external configuration (required)

Return type:

None

Returns:

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

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

Create a new group with the specified properties.

Parameters:

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

  • body (GroupRequest) – Name of group (required)

Return type:

Group

Returns:

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

delete_group(group_id, async_call=False, **kwargs)[source]

Remove a group from SDKMS.

Parameters:

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

  • group_id (str) – Group Identifier (required)

Return type:

None

Returns:

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

get_group(group_id, async_call=False, **kwargs)[source]

Look up a specific group by group ID.

Parameters:

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

  • group_id (str) – Group Identifier (required)

Return type:

Group

Returns:

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

get_groups(async_call=False, **kwargs)[source]

Get detailed information about all groups the authenticated User or authenticated Application belongs to.

Parameters:

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

Return type:

list[Group]

Returns:

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

scan_hmg(group_id, async_call=False, **kwargs)[source]

For a group backed by an external source, scan the external source for changes since the last scan, and accordingly update the group. This includes creating virtual keys for new keys found, marking the virtual keys of missing keys as destroyed, and updating the metadata of changed keys.

Parameters:

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

  • group_id (str) – Group Identifier (required)

Return type:

list[KeyObject]

Returns:

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

update_group(group_id, body, async_call=False, **kwargs)[source]

Change a group’s properties.

Parameters:

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

  • group_id (str) – Group Identifier (required)

  • body (GroupRequest) – Name of group (required)

Return type:

Group

Returns:

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