@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-02-10T11:07:35.698-06:00[America/Chicago]") @Component(value="org.openapitools.client.api.GroupApi") public class GroupApi extends Object
Constructor and Description |
---|
GroupApi() |
GroupApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
void |
activateGroupRule(String ruleId)
Activate a Group Rule
Activates a specific group rule by `ruleId`
|
<T> T |
assignGroupOwner(Class<?> T,
String groupId,
GroupOwner groupOwner)
Assign a Group Owner
Assigns a group owner
|
GroupOwner |
assignGroupOwner(String groupId,
GroupOwner groupOwner)
Assign a Group Owner
Assigns a group owner
|
PagedList |
assignGroupOwnerWithPaginationInfo(String groupId,
GroupOwner groupOwner)
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
|
<T> T |
createGroup(Class<?> T,
Group group)
Create a Group
Creates a new group with `OKTA_GROUP` type
|
Group |
createGroup(Group group)
Create a Group
Creates a new group with `OKTA_GROUP` type
|
<T> T |
createGroupRule(Class<?> T,
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)
Create a Group Rule
Creates a group rule to dynamically add users to the specified group if they match the condition
|
PagedList |
createGroupRuleWithPaginationInfo(GroupRule groupRule)
Create a Group Rule
Creates a group rule to dynamically add users to the specified group if they match the condition
|
PagedList |
createGroupWithPaginationInfo(Group group)
Create a Group
Creates a new group with `OKTA_GROUP` type
|
void |
deactivateGroupRule(String ruleId)
Deactivate a Group Rule
Deactivates a specific group rule by `ruleId`
|
void |
deleteGroup(String groupId)
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 |
deleteGroupRule(String ruleId,
Boolean removeUsers)
Delete a group Rule
Deletes a specific group rule by `ruleId`
|
ApiClient |
getApiClient() |
Group |
getGroup(String groupId)
Retrieve a Group
Retrieves a group by `groupId`
|
GroupRule |
getGroupRule(String ruleId,
String expand)
Retrieve a Group Rule
Retrieves a specific group rule by `ruleId`
|
PagedList |
getGroupRuleWithPaginationInfo(String ruleId,
String expand)
Retrieve a Group Rule
Retrieves a specific group rule by `ruleId`
|
PagedList |
getGroupWithPaginationInfo(String groupId)
Retrieve a Group
Retrieves a group by `groupId`
|
List<Application> |
listAssignedApplicationsForGroup(String groupId,
String after,
Integer limit)
List all Assigned Applications
Lists all applications that are assigned to a group
|
PagedList |
listAssignedApplicationsForGroupWithPaginationInfo(String groupId,
String after,
Integer limit)
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
|
PagedList |
listGroupOwnersWithPaginationInfo(String groupId,
String filter,
String after,
Integer limit)
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
|
PagedList |
listGroupRulesWithPaginationInfo(Integer limit,
String after,
String search,
String expand)
List all Group Rules
Lists all group rules
|
List<Group> |
listGroups(String q,
String filter,
String after,
Integer limit,
String expand,
String search)
List all Groups
Lists all groups with pagination support.
|
PagedList |
listGroupsWithPaginationInfo(String q,
String filter,
String after,
Integer limit,
String expand,
String search)
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
|
PagedList |
listGroupUsersWithPaginationInfo(String groupId,
String after,
Integer limit)
List all Member Users
Lists all users that are a member of a group
|
<T> T |
replaceGroup(Class<?> T,
String groupId,
Group group)
Replace a Group
Replaces the profile for a group with `OKTA_GROUP` type
|
Group |
replaceGroup(String groupId,
Group group)
Replace a Group
Replaces the profile for a group with `OKTA_GROUP` type
|
<T> T |
replaceGroupRule(Class<?> T,
String ruleId,
GroupRule groupRule)
Replace a Group Rule
Replaces a group rule.
|
GroupRule |
replaceGroupRule(String ruleId,
GroupRule groupRule)
Replace a Group Rule
Replaces a group rule.
|
PagedList |
replaceGroupRuleWithPaginationInfo(String ruleId,
GroupRule groupRule)
Replace a Group Rule
Replaces a group rule.
|
PagedList |
replaceGroupWithPaginationInfo(String groupId,
Group group)
Replace a Group
Replaces the profile for a group with `OKTA_GROUP` type
|
void |
setApiClient(ApiClient apiClient) |
void |
unassignUserFromGroup(String groupId,
String userId)
Unassign a User
Unassigns a user from a group with 'OKTA_GROUP' type
|
public GroupApi()
@Autowired public GroupApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public void activateGroupRule(String ruleId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
ruleId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic GroupOwner assignGroupOwner(String groupId, GroupOwner groupOwner) throws org.springframework.web.client.RestClientException
201 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)groupOwner
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T assignGroupOwner(Class<?> T, String groupId, GroupOwner groupOwner) throws org.springframework.web.client.RestClientException
201 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typegroupId
- (required)groupOwner
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList assignGroupOwnerWithPaginationInfo(String groupId, GroupOwner groupOwner) throws org.springframework.web.client.RestClientException
201 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)groupOwner
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void assignUserToGroup(String groupId, String userId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)userId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Group createGroup(Group group) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
group
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T createGroup(Class<?> T, Group group) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
T
- (required) - the assignable return typegroup
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList createGroupWithPaginationInfo(Group group) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
group
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic GroupRule createGroupRule(GroupRule groupRule) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
groupRule
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T createGroupRule(Class<?> T, GroupRule groupRule) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
T
- (required) - the assignable return typegroupRule
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList createGroupRuleWithPaginationInfo(GroupRule groupRule) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
groupRule
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deactivateGroupRule(String ruleId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
ruleId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteGroup(String groupId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteGroupOwner(String groupId, String ownerId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)ownerId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteGroupRule(String ruleId, Boolean removeUsers) throws org.springframework.web.client.RestClientException
202 - Accepted
403 - Forbidden
404 - Not Found
429 - Too Many Requests
ruleId
- (required)removeUsers
- Indicates whether to keep or remove users from groups assigned by this rule. (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Group getGroup(String groupId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getGroupWithPaginationInfo(String groupId) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic GroupRule getGroupRule(String ruleId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
ruleId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getGroupRuleWithPaginationInfo(String ruleId, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
ruleId
- (required)expand
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<Application> listAssignedApplicationsForGroup(String groupId, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listAssignedApplicationsForGroupWithPaginationInfo(String groupId, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<GroupOwner> listGroupOwners(String groupId, String filter, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listGroupOwnersWithPaginationInfo(String groupId, String filter, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<GroupRule> listGroupRules(Integer limit, String after, String search, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listGroupRulesWithPaginationInfo(Integer limit, String after, String search, String expand) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<User> listGroupUsers(String groupId, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listGroupUsersWithPaginationInfo(String groupId, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<Group> listGroups(String q, String filter, String after, Integer limit, String expand, String search) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listGroupsWithPaginationInfo(String q, String filter, String after, Integer limit, String expand, String search) throws org.springframework.web.client.RestClientException
200 - Success
403 - Forbidden
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Group replaceGroup(String groupId, Group group) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)group
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceGroup(Class<?> T, String groupId, Group group) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typegroupId
- (required)group
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceGroupWithPaginationInfo(String groupId, Group group) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)group
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic GroupRule replaceGroupRule(String ruleId, GroupRule groupRule) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
ruleId
- (required)groupRule
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceGroupRule(Class<?> T, String ruleId, GroupRule groupRule) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typeruleId
- (required)groupRule
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceGroupRuleWithPaginationInfo(String ruleId, GroupRule groupRule) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
ruleId
- (required)groupRule
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void unassignUserFromGroup(String groupId, String userId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
groupId
- (required)userId
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APICopyright © 2017–2023 Okta. All rights reserved.