@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-07-14T17:07:26.321-05:00[America/Chicago]") public class GroupApi extends Object
Constructor and Description |
---|
GroupApi() |
GroupApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
void |
activateGroupRule(String groupRuleId)
Activate a Group Rule
Activates a specific group rule by `groupRuleId`
|
void |
activateGroupRule(String groupRuleId,
Map<String,String> additionalHeaders)
Activate a Group Rule
Activates a specific group rule by `groupRuleId`
|
GroupOwner |
assignGroupOwner(String groupId,
AssignGroupOwnerRequestBody assignGroupOwnerRequestBody)
Assign a Group Owner
Assigns a group owner
|
GroupOwner |
assignGroupOwner(String groupId,
AssignGroupOwnerRequestBody assignGroupOwnerRequestBody,
Map<String,String> additionalHeaders)
Assign a Group Owner
Assigns a group owner
|
void |
assignUserToGroup(String groupId,
String userId)
Assign a User
Assigns a user to a group with 'OKTA_GROUP' type
|
void |
assignUserToGroup(String groupId,
String userId,
Map<String,String> additionalHeaders)
Assign a User
Assigns a user to a group with 'OKTA_GROUP' type
|
Group |
createGroup(Group group)
Create a Group
Creates a new group with `OKTA_GROUP` type
|
Group |
createGroup(Group group,
Map<String,String> additionalHeaders)
Create a Group
Creates a new group with `OKTA_GROUP` type
|
GroupRule |
createGroupRule(GroupRule groupRule)
Create a Group Rule
Creates a group rule to dynamically add users to the specified group if they match the condition
|
GroupRule |
createGroupRule(GroupRule groupRule,
Map<String,String> additionalHeaders)
Create a Group Rule
Creates a group rule to dynamically add users to the specified group if they match the condition
|
void |
deactivateGroupRule(String groupRuleId)
Deactivate a Group Rule
Deactivates a specific group rule by `groupRuleId`
|
void |
deactivateGroupRule(String groupRuleId,
Map<String,String> additionalHeaders)
Deactivate a Group Rule
Deactivates a specific group rule by `groupRuleId`
|
void |
deleteGroup(String groupId)
Delete a Group
Deletes a group with `OKTA_GROUP` type
|
void |
deleteGroup(String groupId,
Map<String,String> additionalHeaders)
Delete a Group
Deletes a group with `OKTA_GROUP` type
|
void |
deleteGroupOwner(String groupId,
String ownerId)
Delete a Group Owner
Deletes a group owner from a specific group
|
void |
deleteGroupOwner(String groupId,
String ownerId,
Map<String,String> additionalHeaders)
Delete a Group Owner
Deletes a group owner from a specific group
|
void |
deleteGroupRule(String groupRuleId,
Boolean removeUsers)
Delete a group Rule
Deletes a specific group rule by `groupRuleId`
|
void |
deleteGroupRule(String groupRuleId,
Boolean removeUsers,
Map<String,String> additionalHeaders)
Delete a group Rule
Deletes a specific group rule by `groupRuleId`
|
ApiClient |
getApiClient() |
Group |
getGroup(String groupId)
Retrieve a Group
Retrieves a group by `groupId`
|
Group |
getGroup(String groupId,
Map<String,String> additionalHeaders)
Retrieve a Group
Retrieves a group by `groupId`
|
GroupRule |
getGroupRule(String groupRuleId,
String expand)
Retrieve a Group Rule
Retrieves a specific group rule by `groupRuleId`
|
GroupRule |
getGroupRule(String groupRuleId,
String expand,
Map<String,String> additionalHeaders)
Retrieve a Group Rule
Retrieves a specific group rule by `groupRuleId`
|
protected static com.fasterxml.jackson.databind.ObjectMapper |
getObjectMapper() |
List<Application> |
listAssignedApplicationsForGroup(String groupId,
String after,
Integer limit)
List all Assigned Applications
Lists all applications that are assigned to a group
|
List<Application> |
listAssignedApplicationsForGroup(String groupId,
String after,
Integer limit,
Map<String,String> additionalHeaders)
List all Assigned Applications
Lists all applications that are assigned to a group
|
List<GroupOwner> |
listGroupOwners(String groupId,
String filter,
String after,
Integer limit)
List all Group Owners
Lists all owners for a specific group
|
List<GroupOwner> |
listGroupOwners(String groupId,
String filter,
String after,
Integer limit,
Map<String,String> additionalHeaders)
List all Group Owners
Lists all owners for a specific group
|
List<GroupRule> |
listGroupRules(Integer limit,
String after,
String search,
String expand)
List all Group Rules
Lists all group rules
|
List<GroupRule> |
listGroupRules(Integer limit,
String after,
String search,
String expand,
Map<String,String> additionalHeaders)
List all Group Rules
Lists all group rules
|
List<Group> |
listGroups(String q,
String filter,
String after,
Integer limit,
String expand,
String search,
String sortBy,
String sortOrder)
List all Groups
Lists all groups with pagination support.
|
List<Group> |
listGroups(String q,
String filter,
String after,
Integer limit,
String expand,
String search,
String sortBy,
String sortOrder,
Map<String,String> additionalHeaders)
List all Groups
Lists all groups with pagination support.
|
List<User> |
listGroupUsers(String groupId,
String after,
Integer limit)
List all Member Users
Lists all users that are a member of a group
|
List<User> |
listGroupUsers(String groupId,
String after,
Integer limit,
Map<String,String> additionalHeaders)
List all Member Users
Lists all users that are a member of a group
|
Group |
replaceGroup(String groupId,
Group group)
Replace a Group
Replaces the profile for a group with `OKTA_GROUP` type
|
Group |
replaceGroup(String groupId,
Group group,
Map<String,String> additionalHeaders)
Replace a Group
Replaces the profile for a group with `OKTA_GROUP` type
|
GroupRule |
replaceGroupRule(String groupRuleId,
GroupRule groupRule)
Replace a Group Rule
Replaces a group rule.
|
GroupRule |
replaceGroupRule(String groupRuleId,
GroupRule groupRule,
Map<String,String> additionalHeaders)
Replace a Group Rule
Replaces a group rule.
|
void |
setApiClient(ApiClient apiClient) |
void |
unassignUserFromGroup(String groupId,
String userId)
Unassign a User
Unassigns a user from a group with 'OKTA_GROUP' type
|
void |
unassignUserFromGroup(String groupId,
String userId,
Map<String,String> additionalHeaders)
Unassign a User
Unassigns a user from a group with 'OKTA_GROUP' type
|
public GroupApi()
public GroupApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public void activateGroupRule(String groupRuleId) throws ApiException
groupRuleId
- The `id` of the group rule (required)ApiException
- if fails to make API callpublic void activateGroupRule(String groupRuleId, Map<String,String> additionalHeaders) throws ApiException
groupRuleId
- The `id` of the group rule (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic GroupOwner assignGroupOwner(String groupId, AssignGroupOwnerRequestBody assignGroupOwnerRequestBody) throws ApiException
groupId
- The `id` of the group (required)assignGroupOwnerRequestBody
- (required)ApiException
- if fails to make API callpublic GroupOwner assignGroupOwner(String groupId, AssignGroupOwnerRequestBody assignGroupOwnerRequestBody, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)assignGroupOwnerRequestBody
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void assignUserToGroup(String groupId, String userId) throws ApiException
groupId
- The `id` of the group (required)userId
- (required)ApiException
- if fails to make API callpublic void assignUserToGroup(String groupId, String userId, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)userId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic Group createGroup(Group group) throws ApiException
group
- (required)ApiException
- if fails to make API callpublic Group createGroup(Group group, Map<String,String> additionalHeaders) throws ApiException
group
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic GroupRule createGroupRule(GroupRule groupRule) throws ApiException
groupRule
- (required)ApiException
- if fails to make API callpublic GroupRule createGroupRule(GroupRule groupRule, Map<String,String> additionalHeaders) throws ApiException
groupRule
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void deactivateGroupRule(String groupRuleId) throws ApiException
groupRuleId
- The `id` of the group rule (required)ApiException
- if fails to make API callpublic void deactivateGroupRule(String groupRuleId, Map<String,String> additionalHeaders) throws ApiException
groupRuleId
- The `id` of the group rule (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void deleteGroup(String groupId) throws ApiException
groupId
- The `id` of the group (required)ApiException
- if fails to make API callpublic void deleteGroup(String groupId, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void deleteGroupOwner(String groupId, String ownerId) throws ApiException
groupId
- The `id` of the group (required)ownerId
- The `id` of the group owner (required)ApiException
- if fails to make API callpublic void deleteGroupOwner(String groupId, String ownerId, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)ownerId
- The `id` of the group owner (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void deleteGroupRule(String groupRuleId, Boolean removeUsers) throws ApiException
groupRuleId
- The `id` of the group rule (required)removeUsers
- Indicates whether to keep or remove users from groups assigned by this rule. (optional)ApiException
- if fails to make API callpublic void deleteGroupRule(String groupRuleId, Boolean removeUsers, Map<String,String> additionalHeaders) throws ApiException
groupRuleId
- The `id` of the group rule (required)removeUsers
- Indicates whether to keep or remove users from groups assigned by this rule. (optional)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic Group getGroup(String groupId) throws ApiException
groupId
- The `id` of the group (required)ApiException
- if fails to make API callpublic Group getGroup(String groupId, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic GroupRule getGroupRule(String groupRuleId, String expand) throws ApiException
groupRuleId
- The `id` of the group rule (required)expand
- (optional)ApiException
- if fails to make API callpublic GroupRule getGroupRule(String groupRuleId, String expand, Map<String,String> additionalHeaders) throws ApiException
groupRuleId
- The `id` of the group rule (required)expand
- (optional)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<Application> listAssignedApplicationsForGroup(String groupId, String after, Integer limit) throws ApiException
groupId
- The `id` of the group (required)after
- Specifies the pagination cursor for the next page of apps (optional)limit
- Specifies the number of app results for a page (optional, default to 20)ApiException
- if fails to make API callpublic List<Application> listAssignedApplicationsForGroup(String groupId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)after
- Specifies the pagination cursor for the next page of apps (optional)limit
- Specifies the number of app results for a page (optional, default to 20)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<GroupOwner> listGroupOwners(String groupId, String filter, String after, Integer limit) throws ApiException
groupId
- The `id` of the group (required)filter
- SCIM Filter expression for group owners. Allows to filter owners by type. (optional)after
- Specifies the pagination cursor for the next page of owners (optional)limit
- Specifies the number of owner results in a page (optional, default to 1000)ApiException
- if fails to make API callpublic List<GroupOwner> listGroupOwners(String groupId, String filter, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)filter
- SCIM Filter expression for group owners. Allows to filter owners by type. (optional)after
- Specifies the pagination cursor for the next page of owners (optional)limit
- Specifies the number of owner results in a page (optional, default to 1000)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<GroupRule> listGroupRules(Integer limit, String after, String search, String expand) throws ApiException
limit
- Specifies the number of rule results in a page (optional, default to 50)after
- Specifies the pagination cursor for the next page of rules (optional)search
- Specifies the keyword to search fules for (optional)expand
- If specified as `groupIdToGroupNameMap`, then show group names (optional)ApiException
- if fails to make API callpublic List<GroupRule> listGroupRules(Integer limit, String after, String search, String expand, Map<String,String> additionalHeaders) throws ApiException
limit
- Specifies the number of rule results in a page (optional, default to 50)after
- Specifies the pagination cursor for the next page of rules (optional)search
- Specifies the keyword to search fules for (optional)expand
- If specified as `groupIdToGroupNameMap`, then show group names (optional)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<User> listGroupUsers(String groupId, String after, Integer limit) throws ApiException
groupId
- The `id` of the group (required)after
- Specifies the pagination cursor for the next page of users (optional)limit
- Specifies the number of user results in a page (optional, default to 1000)ApiException
- if fails to make API callpublic List<User> listGroupUsers(String groupId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)after
- Specifies the pagination cursor for the next page of users (optional)limit
- Specifies the number of user results in a page (optional, default to 1000)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<Group> listGroups(String q, String filter, String after, Integer limit, String expand, String search, String sortBy, String sortOrder) throws ApiException
q
- Searches the name property of groups for matching value (optional)filter
- Filter expression for groups (optional)after
- Specifies the pagination cursor for the next page of groups (optional)limit
- Specifies the number of group results in a page (optional, default to 10000)expand
- If specified, it causes additional metadata to be included in the response. (optional)search
- Searches for groups with a supported filtering expression for all attributes except for _embedded, _links, and objectClass (optional)sortBy
- Specifies field to sort by and can be any single property (for search queries only). (optional)sortOrder
- Specifies sort order `asc` or `desc` (for search queries only). This parameter is ignored if `sortBy` is not present. Groups with the same value for the `sortBy` parameter are ordered by `id`. (optional, default to asc)ApiException
- if fails to make API callpublic List<Group> listGroups(String q, String filter, String after, Integer limit, String expand, String search, String sortBy, String sortOrder, Map<String,String> additionalHeaders) throws ApiException
q
- Searches the name property of groups for matching value (optional)filter
- Filter expression for groups (optional)after
- Specifies the pagination cursor for the next page of groups (optional)limit
- Specifies the number of group results in a page (optional, default to 10000)expand
- If specified, it causes additional metadata to be included in the response. (optional)search
- Searches for groups with a supported filtering expression for all attributes except for _embedded, _links, and objectClass (optional)sortBy
- Specifies field to sort by and can be any single property (for search queries only). (optional)sortOrder
- Specifies sort order `asc` or `desc` (for search queries only). This parameter is ignored if `sortBy` is not present. Groups with the same value for the `sortBy` parameter are ordered by `id`. (optional, default to asc)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic Group replaceGroup(String groupId, Group group) throws ApiException
groupId
- The `id` of the group (required)group
- (required)ApiException
- if fails to make API callpublic Group replaceGroup(String groupId, Group group, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)group
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic GroupRule replaceGroupRule(String groupRuleId, GroupRule groupRule) throws ApiException
groupRuleId
- The `id` of the group rule (required)groupRule
- (required)ApiException
- if fails to make API callpublic GroupRule replaceGroupRule(String groupRuleId, GroupRule groupRule, Map<String,String> additionalHeaders) throws ApiException
groupRuleId
- The `id` of the group rule (required)groupRule
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void unassignUserFromGroup(String groupId, String userId) throws ApiException
groupId
- The `id` of the group (required)userId
- (required)ApiException
- if fails to make API callpublic void unassignUserFromGroup(String groupId, String userId, Map<String,String> additionalHeaders) throws ApiException
groupId
- The `id` of the group (required)userId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callprotected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
Copyright © 2017–2023 Okta. All rights reserved.