com.fortanix.sdkms.v1.api

Class GroupsApi

java.lang.Object

com.fortanix.sdkms.v1.api.GroupsApi

public class GroupsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
GroupsApi()
GroupsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<AzureKeyVaultResponse>	azureVaults() List all Azure Key Vaults available to back a group Given an Azure HMG configuration, fetch a list of available Azure key vaults which can be used to back a group.
void	checkGroupHmg(String groupId) Check the HMG configuration of a group Check that the HMG configuration for a particular group is valid and reachable.
void	checkHmg(HmgConfig body) Check a HMG configuration Check that the HMG configuration provided is valid and reachable.
Group	createGroup(GroupRequest body) Create new group Create a new group with the specified properties.
void	deleteGroup(String groupId) Delete group Remove a group from SDKMS.
ApiClient	getApiClient()
Group	getGroup(String groupId) Get a specific group Look up a specific group by group ID.
List<Group>	getGroups() Get all groups Get detailed information about all groups the authenticated User or authenticated Application belongs to.
List<KeyObject>	scanHmg(String groupId) Scan all keys from the external source for a particular group For a group backed by an external source, scan the external source for changes since the last scan, and accordingly update the group.
void	setApiClient(ApiClient apiClient)
Group	updateGroup(String groupId, GroupRequest body) Update group Change a group's properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupsApi

public GroupsApi()

GroupsApi

public GroupsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

azureVaults

public List<AzureKeyVaultResponse> azureVaults()
                                        throws ApiException

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

Returns:

List<AzureKeyVaultResponse>

Throws:

ApiException - if fails to make API call

checkGroupHmg

public void checkGroupHmg(String groupId)
                   throws ApiException

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

Parameters:

groupId - Group Identifier (required)

Throws:

ApiException - if fails to make API call

checkHmg

public void checkHmg(HmgConfig body)
              throws ApiException

Check a HMG configuration Check that the HMG configuration provided is valid and reachable.

Parameters:

body - Request to check validity and reachability of an external configuration (required)

Throws:

ApiException - if fails to make API call

createGroup

public Group createGroup(GroupRequest body)
                  throws ApiException

Create new group Create a new group with the specified properties.

Parameters:

body - Name of group (required)

Returns:

Group

Throws:

ApiException - if fails to make API call

deleteGroup

public void deleteGroup(String groupId)
                 throws ApiException

Delete group Remove a group from SDKMS.

Parameters:

groupId - Group Identifier (required)

Throws:

ApiException - if fails to make API call

getGroup

public Group getGroup(String groupId)
               throws ApiException

Get a specific group Look up a specific group by group ID.

Parameters:

groupId - Group Identifier (required)

Returns:

Group

Throws:

ApiException - if fails to make API call

getGroups

public List<Group> getGroups()
                      throws ApiException

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

Returns:

List<Group>

Throws:

ApiException - if fails to make API call

scanHmg

public List<KeyObject> scanHmg(String groupId)
                        throws ApiException

Scan all keys from the external source for a particular group 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:

groupId - Group Identifier (required)

Returns:

List<KeyObject>

Throws:

ApiException - if fails to make API call

updateGroup

public Group updateGroup(String groupId,
                         GroupRequest body)
                  throws ApiException

Update group Change a group's properties.

Parameters:

groupId - Group Identifier (required)

body - Name of group (required)

Returns:

Group

Throws:

ApiException - if fails to make API call