public class DsGroupsApi extends Object
| Modifier and Type | Class and Description |
|---|---|
class |
DsGroupsApi.GetDSGroupsOptions |
class |
DsGroupsApi.GetDSGroupUsersOptions |
| Constructor and Description |
|---|
DsGroupsApi() |
DsGroupsApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
DSGroupResponse |
addDSGroup(UUID organizationId,
UUID accountId,
DSGroupAddRequest addRequest)
Add a new DSGroup
Required scopes: user_write
|
AddDSGroupAndUsersResponse |
addDSGroupUsers(UUID organizationId,
UUID accountId,
UUID dsGroupId,
DSGroupUsersAddRequest dSGroupUsersAddRequest)
Add list of users to a DSGroup
Required scopes: user_write
|
void |
deleteDSGroup(UUID organizationId,
UUID accountId,
UUID dsGroupId)
Delete a DSGroup
Required scopes: user_write
|
ApiClient |
getApiClient() |
DSGroupResponse |
getDSGroup(UUID organizationId,
UUID accountId,
UUID dsGroupId)
Get list of DSGroup
Required scopes: user_read
|
DSGroupListResponse |
getDSGroups(UUID organizationId,
UUID accountId)
Get list of DSGroups
Required scopes: user_read
|
DSGroupListResponse |
getDSGroups(UUID organizationId,
UUID accountId,
DsGroupsApi.GetDSGroupsOptions options)
Get list of DSGroups
Required scopes: user_read
|
DSGroupAndUsersResponse |
getDSGroupUsers(UUID organizationId,
UUID accountId,
UUID dsGroupId)
Get list of users in a DSGroup
Required scopes: user_read
|
DSGroupAndUsersResponse |
getDSGroupUsers(UUID organizationId,
UUID accountId,
UUID dsGroupId,
DsGroupsApi.GetDSGroupUsersOptions options)
Get list of users in a DSGroup
Required scopes: user_read
|
RemoveDSGroupUsersResponse |
removeDSGroupUsers(UUID organizationId,
UUID accountId,
UUID dsGroupId,
DSGroupUsersRemoveRequest dSGroupUsersRemoveRequest)
Remove users from a DSGroup
Required scopes: user_write
|
void |
setApiClient(ApiClient apiClient) |
public DsGroupsApi()
public DsGroupsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public DSGroupResponse addDSGroup(UUID organizationId, UUID accountId, DSGroupAddRequest addRequest) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)addRequest - Add DSGroup request object (required)ApiException - if fails to make API callpublic AddDSGroupAndUsersResponse addDSGroupUsers(UUID organizationId, UUID accountId, UUID dsGroupId, DSGroupUsersAddRequest dSGroupUsersAddRequest) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)dsGroupId - The DSGroup ID GUID (required)dSGroupUsersAddRequest - Add DSGroup users request object (required)ApiException - if fails to make API callpublic void deleteDSGroup(UUID organizationId, UUID accountId, UUID dsGroupId) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)dsGroupId - The DSGroup ID GUID (required)ApiException - if fails to make API callpublic DSGroupResponse getDSGroup(UUID organizationId, UUID accountId, UUID dsGroupId) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)dsGroupId - The dsGroup ID GUID (required)ApiException - if fails to make API callpublic DSGroupAndUsersResponse getDSGroupUsers(UUID organizationId, UUID accountId, UUID dsGroupId) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)dsGroupId - The DSGroup ID GUID (required)ApiExceptionpublic DSGroupAndUsersResponse getDSGroupUsers(UUID organizationId, UUID accountId, UUID dsGroupId, DsGroupsApi.GetDSGroupUsersOptions options) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)dsGroupId - The DSGroup ID GUID (required)options - for modifying the method behavior.ApiException - if fails to make API callpublic DSGroupListResponse getDSGroups(UUID organizationId, UUID accountId) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)ApiExceptionpublic DSGroupListResponse getDSGroups(UUID organizationId, UUID accountId, DsGroupsApi.GetDSGroupsOptions options) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)options - for modifying the method behavior.ApiException - if fails to make API callpublic RemoveDSGroupUsersResponse removeDSGroupUsers(UUID organizationId, UUID accountId, UUID dsGroupId, DSGroupUsersRemoveRequest dSGroupUsersRemoveRequest) throws ApiException
organizationId - The organization ID GUID (required)accountId - The account ID GUID (required)dsGroupId - The DSGroup ID GUID (required)dSGroupUsersRemoveRequest - Remove DSGroup users request object (required)ApiException - if fails to make API callCopyright © 2021. All rights reserved.