Package com.seeq.api
Class UserGroupsApi
java.lang.Object
com.seeq.api.UserGroupsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddIdentityToUserGroup
(String userGroupId, String identityId) Add a user to a user groupaddIdentityToUserGroupWithHeadersAndHttpInfo
(String userGroupId, String identityId, Map<String, String> customHeaders) Add a user to a user groupaddIdentityToUserGroupWithHttpInfo
(String userGroupId, String identityId) Add a user to a user grouparchiveUserGroup
(String userGroupId, Boolean removePermissions) Archive a user grouparchiveUserGroupWithHeadersAndHttpInfo
(String userGroupId, Boolean removePermissions, Map<String, String> customHeaders) Archive a user grouparchiveUserGroupWithHttpInfo
(String userGroupId, Boolean removePermissions) Archive a user groupCreate a user group hosted within SeeqcreateUserGroupWithHeadersAndHttpInfo
(UserGroupInputV1 body, Map<String, String> customHeaders) Create a user group hosted within SeeqCreate a user group hosted within SeeqdisableUserGroup
(String userGroupId, Boolean removePermissions) Disable a user groupdisableUserGroupWithHeadersAndHttpInfo
(String userGroupId, Boolean removePermissions, Map<String, String> customHeaders) Disable a user groupdisableUserGroupWithHttpInfo
(String userGroupId, Boolean removePermissions) Disable a user grouplong
getUserGroup
(String userGroupId) Get a user groupgetUserGroups
(String nameSearch, String datasourceIdSearch, Boolean isEnabled, String sortOrder, Integer offset, Integer limit) Get a collection of usergroupsgetUserGroupsWithHeadersAndHttpInfo
(String nameSearch, String datasourceIdSearch, Boolean isEnabled, String sortOrder, Integer offset, Integer limit, Map<String, String> customHeaders) Get a collection of usergroupsgetUserGroupsWithHttpInfo
(String nameSearch, String datasourceIdSearch, Boolean isEnabled, String sortOrder, Integer offset, Integer limit) Get a collection of usergroupsgetUserGroupWithHeadersAndHttpInfo
(String userGroupId, Map<String, String> customHeaders) Get a user groupgetUserGroupWithHttpInfo
(String userGroupId) Get a user groupCreate or update multiple user groupsputUserGroupsWithHeadersAndHttpInfo
(PutUserGroupsInputV1 body, Map<String, String> customHeaders) Create or update multiple user groupsCreate or update multiple user groupsremoveIdentityFromUserGroup
(String userGroupId, String identityId) Remove a user from a user groupremoveIdentityFromUserGroupWithHeadersAndHttpInfo
(String userGroupId, String identityId, Map<String, String> customHeaders) Remove a user from a user groupremoveIdentityFromUserGroupWithHttpInfo
(String userGroupId, String identityId) Remove a user from a user groupremoveUserGroup
(String userGroupId) Remove a user groupremoveUserGroupWithHeadersAndHttpInfo
(String userGroupId, Map<String, String> customHeaders) Remove a user groupremoveUserGroupWithHttpInfo
(String userGroupId) Remove a user groupvoid
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) updateUserGroup
(String userGroupId, UserGroupInputV1 body) Update name or description of a user groupupdateUserGroupWithHeadersAndHttpInfo
(String userGroupId, UserGroupInputV1 body, Map<String, String> customHeaders) Update name or description of a user groupupdateUserGroupWithHttpInfo
(String userGroupId, UserGroupInputV1 body) Update name or description of a user group
-
Constructor Details
-
UserGroupsApi
public UserGroupsApi() -
UserGroupsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
addIdentityToUserGroup
public UserGroupOutputV1 addIdentityToUserGroup(String userGroupId, String identityId) throws ApiException Add a user to a user group- Parameters:
userGroupId
- ID of the user group to add user or user group to (required)identityId
- ID of the user or user group to add. (required)- Returns:
- UserGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
addIdentityToUserGroupWithHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> addIdentityToUserGroupWithHttpInfo(String userGroupId, String identityId) throws ApiException Add a user to a user group- Parameters:
userGroupId
- ID of the user group to add user or user group to (required)identityId
- ID of the user or user group to add. (required)- Throws:
ApiException
- if fails to make API call
-
addIdentityToUserGroupWithHeadersAndHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> addIdentityToUserGroupWithHeadersAndHttpInfo(String userGroupId, String identityId, Map<String, String> customHeaders) throws ApiExceptionAdd a user to a user group- Parameters:
userGroupId
- ID of the user group to add user or user group to (required)identityId
- ID of the user or user group to add. (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
archiveUserGroup
public UserGroupOutputV1 archiveUserGroup(String userGroupId, Boolean removePermissions) throws ApiException Archive a user group- Parameters:
userGroupId
- ID of user group to archive (required)removePermissions
- Whether to remove permissions associated with the group being archived (optional, default to false)- Returns:
- UserGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
archiveUserGroupWithHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> archiveUserGroupWithHttpInfo(String userGroupId, Boolean removePermissions) throws ApiException Archive a user group- Parameters:
userGroupId
- ID of user group to archive (required)removePermissions
- Whether to remove permissions associated with the group being archived (optional, default to false)- Throws:
ApiException
- if fails to make API call
-
archiveUserGroupWithHeadersAndHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> archiveUserGroupWithHeadersAndHttpInfo(String userGroupId, Boolean removePermissions, Map<String, String> customHeaders) throws ApiExceptionArchive a user group- Parameters:
userGroupId
- ID of user group to archive (required)removePermissions
- Whether to remove permissions associated with the group being archived (optional, default to false)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createUserGroup
Create a user group hosted within Seeq- Parameters:
body
- User group information (required)- Returns:
- UserGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
createUserGroupWithHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> createUserGroupWithHttpInfo(UserGroupInputV1 body) throws ApiException Create a user group hosted within Seeq- Parameters:
body
- User group information (required)- Throws:
ApiException
- if fails to make API call
-
createUserGroupWithHeadersAndHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> createUserGroupWithHeadersAndHttpInfo(UserGroupInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a user group hosted within Seeq- Parameters:
body
- User group information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
disableUserGroup
public UserGroupOutputV1 disableUserGroup(String userGroupId, Boolean removePermissions) throws ApiException Disable a user group- Parameters:
userGroupId
- ID of user group to disable (required)removePermissions
- Whether to remove permissions associated with the group being disabled (optional, default to false)- Returns:
- UserGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
disableUserGroupWithHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> disableUserGroupWithHttpInfo(String userGroupId, Boolean removePermissions) throws ApiException Disable a user group- Parameters:
userGroupId
- ID of user group to disable (required)removePermissions
- Whether to remove permissions associated with the group being disabled (optional, default to false)- Throws:
ApiException
- if fails to make API call
-
disableUserGroupWithHeadersAndHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> disableUserGroupWithHeadersAndHttpInfo(String userGroupId, Boolean removePermissions, Map<String, String> customHeaders) throws ApiExceptionDisable a user group- Parameters:
userGroupId
- ID of user group to disable (required)removePermissions
- Whether to remove permissions associated with the group being disabled (optional, default to false)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getUserGroup
Get a user group- Parameters:
userGroupId
- ID of the user group to get (required)- Returns:
- UserGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
getUserGroupWithHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> getUserGroupWithHttpInfo(String userGroupId) throws ApiException Get a user group- Parameters:
userGroupId
- ID of the user group to get (required)- Throws:
ApiException
- if fails to make API call
-
getUserGroupWithHeadersAndHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> getUserGroupWithHeadersAndHttpInfo(String userGroupId, Map<String, String> customHeaders) throws ApiExceptionGet a user group- Parameters:
userGroupId
- ID of the user group to get (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getUserGroups
public IdentityPreviewListV1 getUserGroups(String nameSearch, String datasourceIdSearch, Boolean isEnabled, String sortOrder, Integer offset, Integer limit) throws ApiException Get a collection of usergroups- Parameters:
nameSearch
- Search text by which to filter user groups' names. (optional)datasourceIdSearch
- Search text by which to filter user groups' directories. (optional)isEnabled
- Whether to filter users to only users who are enabled. (optional)sortOrder
- A field by which to order the user groups followed by a space and 'asc' or 'desc'. Field name can be one of: name, directory (optional, default to name asc)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination level, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- IdentityPreviewListV1
- Throws:
ApiException
- if fails to make API call
-
getUserGroupsWithHttpInfo
public ApiClient.ApiResponse<IdentityPreviewListV1> getUserGroupsWithHttpInfo(String nameSearch, String datasourceIdSearch, Boolean isEnabled, String sortOrder, Integer offset, Integer limit) throws ApiException Get a collection of usergroups- Parameters:
nameSearch
- Search text by which to filter user groups' names. (optional)datasourceIdSearch
- Search text by which to filter user groups' directories. (optional)isEnabled
- Whether to filter users to only users who are enabled. (optional)sortOrder
- A field by which to order the user groups followed by a space and 'asc' or 'desc'. Field name can be one of: name, directory (optional, default to name asc)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination level, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getUserGroupsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<IdentityPreviewListV1> getUserGroupsWithHeadersAndHttpInfo(String nameSearch, String datasourceIdSearch, Boolean isEnabled, String sortOrder, Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a collection of usergroups- Parameters:
nameSearch
- Search text by which to filter user groups' names. (optional)datasourceIdSearch
- Search text by which to filter user groups' directories. (optional)isEnabled
- Whether to filter users to only users who are enabled. (optional)sortOrder
- A field by which to order the user groups followed by a space and 'asc' or 'desc'. Field name can be one of: name, directory (optional, default to name asc)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination level, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putUserGroups
Create or update multiple user groups- Parameters:
body
- (required)- Returns:
- ItemBatchOutputV1
- Throws:
ApiException
- if fails to make API call
-
putUserGroupsWithHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> putUserGroupsWithHttpInfo(PutUserGroupsInputV1 body) throws ApiException Create or update multiple user groups- Parameters:
body
- (required)- Throws:
ApiException
- if fails to make API call
-
putUserGroupsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> putUserGroupsWithHeadersAndHttpInfo(PutUserGroupsInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update multiple user groups- Parameters:
body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
removeIdentityFromUserGroup
public UserGroupOutputV1 removeIdentityFromUserGroup(String userGroupId, String identityId) throws ApiException Remove a user from a user group- Parameters:
userGroupId
- ID of the user group to remove user from (required)identityId
- ID of the user or user group to remove. (required)- Returns:
- UserGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
removeIdentityFromUserGroupWithHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> removeIdentityFromUserGroupWithHttpInfo(String userGroupId, String identityId) throws ApiException Remove a user from a user group- Parameters:
userGroupId
- ID of the user group to remove user from (required)identityId
- ID of the user or user group to remove. (required)- Throws:
ApiException
- if fails to make API call
-
removeIdentityFromUserGroupWithHeadersAndHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> removeIdentityFromUserGroupWithHeadersAndHttpInfo(String userGroupId, String identityId, Map<String, String> customHeaders) throws ApiExceptionRemove a user from a user group- Parameters:
userGroupId
- ID of the user group to remove user from (required)identityId
- ID of the user or user group to remove. (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
removeUserGroup
Remove a user group- Parameters:
userGroupId
- ID of the user group to remove (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
removeUserGroupWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> removeUserGroupWithHttpInfo(String userGroupId) throws ApiException Remove a user group- Parameters:
userGroupId
- ID of the user group to remove (required)- Throws:
ApiException
- if fails to make API call
-
removeUserGroupWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> removeUserGroupWithHeadersAndHttpInfo(String userGroupId, Map<String, String> customHeaders) throws ApiExceptionRemove a user group- Parameters:
userGroupId
- ID of the user group to remove (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
updateUserGroup
public UserGroupOutputV1 updateUserGroup(String userGroupId, UserGroupInputV1 body) throws ApiException Update name or description of a user group- Parameters:
userGroupId
- ID of the user group to update (required)body
- New user group information (required)- Returns:
- UserGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
updateUserGroupWithHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> updateUserGroupWithHttpInfo(String userGroupId, UserGroupInputV1 body) throws ApiException Update name or description of a user group- Parameters:
userGroupId
- ID of the user group to update (required)body
- New user group information (required)- Throws:
ApiException
- if fails to make API call
-
updateUserGroupWithHeadersAndHttpInfo
public ApiClient.ApiResponse<UserGroupOutputV1> updateUserGroupWithHeadersAndHttpInfo(String userGroupId, UserGroupInputV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate name or description of a user group- Parameters:
userGroupId
- ID of the user group to update (required)body
- New user group information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-