Package org.openapitools.client.api

Class GroupApi

java.lang.Object

org.openapitools.client.api.GroupApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-04-19T09:13:44.263607-05:00[America/Chicago]")
@Component("org.openapitools.client.api.GroupApi")
public class GroupApi
extends Object

Constructor Summary

Constructors

Constructor	Description
GroupApi()
GroupApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	activateGroupRule(String ruleId)	Activate a Group Rule Activates a specific group rule by `ruleId`
org.springframework.http.ResponseEntity<Void>	activateGroupRuleWithHttpInfo(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
org.springframework.http.ResponseEntity<GroupOwner>	assignGroupOwnerWithHttpInfo(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
org.springframework.http.ResponseEntity<Void>	assignUserToGroupWithHttpInfo(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
org.springframework.http.ResponseEntity<GroupRule>	createGroupRuleWithHttpInfo(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
org.springframework.http.ResponseEntity<Group>	createGroupWithHttpInfo(Group group)	Create a Group Creates a new group with `OKTA_GROUP` type
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`
org.springframework.http.ResponseEntity<Void>	deactivateGroupRuleWithHttpInfo(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
org.springframework.http.ResponseEntity<Void>	deleteGroupOwnerWithHttpInfo(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`
org.springframework.http.ResponseEntity<Void>	deleteGroupRuleWithHttpInfo(String ruleId, Boolean removeUsers)	Delete a group Rule Deletes a specific group rule by `ruleId`
org.springframework.http.ResponseEntity<Void>	deleteGroupWithHttpInfo(String groupId)	Delete a Group Deletes a group with `OKTA_GROUP` type
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`
org.springframework.http.ResponseEntity<GroupRule>	getGroupRuleWithHttpInfo(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`
org.springframework.http.ResponseEntity<Group>	getGroupWithHttpInfo(String groupId)	Retrieve a Group Retrieves a group by `groupId`
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
org.springframework.http.ResponseEntity<List<Application>>	listAssignedApplicationsForGroupWithHttpInfo(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
org.springframework.http.ResponseEntity<List<GroupOwner>>	listGroupOwnersWithHttpInfo(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
org.springframework.http.ResponseEntity<List<GroupRule>>	listGroupRulesWithHttpInfo(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.
org.springframework.http.ResponseEntity<List<Group>>	listGroupsWithHttpInfo(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
org.springframework.http.ResponseEntity<List<User>>	listGroupUsersWithHttpInfo(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.
org.springframework.http.ResponseEntity<GroupRule>	replaceGroupRuleWithHttpInfo(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.
org.springframework.http.ResponseEntity<Group>	replaceGroupWithHttpInfo(String groupId, Group group)	Replace a Group Replaces the profile for a group with `OKTA_GROUP` type
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
org.springframework.http.ResponseEntity<Void>	unassignUserFromGroupWithHttpInfo(String groupId, String userId)	Unassign a User Unassigns a user from a group with 'OKTA_GROUP' type

Methods inherited from class java.lang.Object

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

Constructor Details

GroupApi

public GroupApi()

GroupApi

@Autowired
public GroupApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateGroupRule

public void activateGroupRule(String ruleId)
                       throws org.springframework.web.client.RestClientException

Activate a Group Rule Activates a specific group rule by `ruleId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateGroupRuleWithHttpInfo

public org.springframework.http.ResponseEntity<Void> activateGroupRuleWithHttpInfo(String ruleId)
                                                                            throws org.springframework.web.client.RestClientException

Activate a Group Rule Activates a specific group rule by `ruleId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignGroupOwner

public GroupOwner assignGroupOwner(String groupId,
 GroupOwner groupOwner)
                            throws org.springframework.web.client.RestClientException

Assign a Group Owner Assigns a group owner

201 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

groupOwner - (required)

Returns:

GroupOwner

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignGroupOwner

public <T> T assignGroupOwner(Class<?> T,
 String groupId,
 GroupOwner groupOwner)
                       throws org.springframework.web.client.RestClientException

Assign a Group Owner Assigns a group owner

201 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

groupId - (required)

groupOwner - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignGroupOwnerWithHttpInfo

public org.springframework.http.ResponseEntity<GroupOwner> assignGroupOwnerWithHttpInfo(String groupId,
 GroupOwner groupOwner)
                                                                                 throws org.springframework.web.client.RestClientException

Assign a Group Owner Assigns a group owner

201 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

groupOwner - (required)

Returns:

ResponseEntity<GroupOwner>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignGroupOwnerWithPaginationInfo

public PagedList assignGroupOwnerWithPaginationInfo(String groupId,
 GroupOwner groupOwner)
                                             throws org.springframework.web.client.RestClientException

Assign a Group Owner Assigns a group owner

201 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

groupOwner - (required)

Returns:

ResponseEntity<GroupOwner>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignUserToGroup

public void assignUserToGroup(String groupId,
 String userId)
                       throws org.springframework.web.client.RestClientException

Assign a User Assigns a user to a group with 'OKTA_GROUP' type

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

userId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignUserToGroupWithHttpInfo

public org.springframework.http.ResponseEntity<Void> assignUserToGroupWithHttpInfo(String groupId,
 String userId)
                                                                            throws org.springframework.web.client.RestClientException

Assign a User Assigns a user to a group with 'OKTA_GROUP' type

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

userId - (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createGroup

public Group createGroup(Group group)
                  throws org.springframework.web.client.RestClientException

Create a Group Creates a new group with `OKTA_GROUP` type

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

group - (required)

Returns:

Group

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createGroup

public <T> T createGroup(Class<?> T,
 Group group)
                  throws org.springframework.web.client.RestClientException

Create a Group Creates a new group with `OKTA_GROUP` type

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

group - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createGroupWithHttpInfo

public org.springframework.http.ResponseEntity<Group> createGroupWithHttpInfo(Group group)
                                                                       throws org.springframework.web.client.RestClientException

Create a Group Creates a new group with `OKTA_GROUP` type

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

group - (required)

Returns:

ResponseEntity<Group>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createGroupWithPaginationInfo

public PagedList createGroupWithPaginationInfo(Group group)
                                        throws org.springframework.web.client.RestClientException

Create a Group Creates a new group with `OKTA_GROUP` type

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

group - (required)

Returns:

ResponseEntity<Group>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createGroupRule

public GroupRule createGroupRule(GroupRule groupRule)
                          throws org.springframework.web.client.RestClientException

Create a Group Rule Creates a group rule to dynamically add users to the specified group if they match the condition

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

groupRule - (required)

Returns:

GroupRule

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createGroupRule

public <T> T createGroupRule(Class<?> T,
 GroupRule groupRule)
                      throws org.springframework.web.client.RestClientException

Create a Group Rule Creates a group rule to dynamically add users to the specified group if they match the condition

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

groupRule - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createGroupRuleWithHttpInfo

public org.springframework.http.ResponseEntity<GroupRule> createGroupRuleWithHttpInfo(GroupRule groupRule)
                                                                               throws org.springframework.web.client.RestClientException

Create a Group Rule Creates a group rule to dynamically add users to the specified group if they match the condition

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

groupRule - (required)

Returns:

ResponseEntity<GroupRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createGroupRuleWithPaginationInfo

public PagedList createGroupRuleWithPaginationInfo(GroupRule groupRule)
                                            throws org.springframework.web.client.RestClientException

Create a Group Rule Creates a group rule to dynamically add users to the specified group if they match the condition

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

groupRule - (required)

Returns:

ResponseEntity<GroupRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateGroupRule

public void deactivateGroupRule(String ruleId)
                         throws org.springframework.web.client.RestClientException

Deactivate a Group Rule Deactivates a specific group rule by `ruleId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateGroupRuleWithHttpInfo

public org.springframework.http.ResponseEntity<Void> deactivateGroupRuleWithHttpInfo(String ruleId)
                                                                              throws org.springframework.web.client.RestClientException

Deactivate a Group Rule Deactivates a specific group rule by `ruleId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteGroup

public void deleteGroup(String groupId)
                 throws org.springframework.web.client.RestClientException

Delete a Group Deletes a group with `OKTA_GROUP` type

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteGroupWithHttpInfo

public org.springframework.http.ResponseEntity<Void> deleteGroupWithHttpInfo(String groupId)
                                                                      throws org.springframework.web.client.RestClientException

Delete a Group Deletes a group with `OKTA_GROUP` type

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteGroupOwner

public void deleteGroupOwner(String groupId,
 String ownerId)
                      throws org.springframework.web.client.RestClientException

Delete a Group Owner Deletes a group owner from a specific group

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

ownerId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteGroupOwnerWithHttpInfo

public org.springframework.http.ResponseEntity<Void> deleteGroupOwnerWithHttpInfo(String groupId,
 String ownerId)
                                                                           throws org.springframework.web.client.RestClientException

Delete a Group Owner Deletes a group owner from a specific group

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

ownerId - (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteGroupRule

public void deleteGroupRule(String ruleId,
 Boolean removeUsers)
                     throws org.springframework.web.client.RestClientException

Delete a group Rule Deletes a specific group rule by `ruleId`

202 - Accepted

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

removeUsers - Indicates whether to keep or remove users from groups assigned by this rule. (optional)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteGroupRuleWithHttpInfo

public org.springframework.http.ResponseEntity<Void> deleteGroupRuleWithHttpInfo(String ruleId,
 Boolean removeUsers)
                                                                          throws org.springframework.web.client.RestClientException

Delete a group Rule Deletes a specific group rule by `ruleId`

202 - Accepted

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

removeUsers - Indicates whether to keep or remove users from groups assigned by this rule. (optional)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroup

public Group getGroup(String groupId)
               throws org.springframework.web.client.RestClientException

Retrieve a Group Retrieves a group by `groupId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

Returns:

Group

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupWithHttpInfo

public org.springframework.http.ResponseEntity<Group> getGroupWithHttpInfo(String groupId)
                                                                    throws org.springframework.web.client.RestClientException

Retrieve a Group Retrieves a group by `groupId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

Returns:

ResponseEntity<Group>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupWithPaginationInfo

public PagedList getGroupWithPaginationInfo(String groupId)
                                     throws org.springframework.web.client.RestClientException

Retrieve a Group Retrieves a group by `groupId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

Returns:

ResponseEntity<Group>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupRule

public GroupRule getGroupRule(String ruleId,
 String expand)
                       throws org.springframework.web.client.RestClientException

Retrieve a Group Rule Retrieves a specific group rule by `ruleId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

expand - (optional)

Returns:

GroupRule

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupRuleWithHttpInfo

public org.springframework.http.ResponseEntity<GroupRule> getGroupRuleWithHttpInfo(String ruleId,
 String expand)
                                                                            throws org.springframework.web.client.RestClientException

Retrieve a Group Rule Retrieves a specific group rule by `ruleId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

expand - (optional)

Returns:

ResponseEntity<GroupRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupRuleWithPaginationInfo

public PagedList getGroupRuleWithPaginationInfo(String ruleId,
 String expand)
                                         throws org.springframework.web.client.RestClientException

Retrieve a Group Rule Retrieves a specific group rule by `ruleId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

expand - (optional)

Returns:

ResponseEntity<GroupRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAssignedApplicationsForGroup

public List<Application> listAssignedApplicationsForGroup(String groupId,
 String after,
 Integer limit)
                                                   throws org.springframework.web.client.RestClientException

List all Assigned Applications Lists all applications that are assigned to a group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

List<Application>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAssignedApplicationsForGroupWithHttpInfo

public org.springframework.http.ResponseEntity<List<Application>> listAssignedApplicationsForGroupWithHttpInfo(String groupId,
 String after,
 Integer limit)
                                                                                                        throws org.springframework.web.client.RestClientException

List all Assigned Applications Lists all applications that are assigned to a group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<Application>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAssignedApplicationsForGroupWithPaginationInfo

public PagedList listAssignedApplicationsForGroupWithPaginationInfo(String groupId,
 String after,
 Integer limit)
                                                             throws org.springframework.web.client.RestClientException

List all Assigned Applications Lists all applications that are assigned to a group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<Application>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupOwners

public List<GroupOwner> listGroupOwners(String groupId,
 String filter,
 String after,
 Integer limit)
                                 throws org.springframework.web.client.RestClientException

List all Group Owners Lists all owners for a specific group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

List<GroupOwner>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupOwnersWithHttpInfo

public org.springframework.http.ResponseEntity<List<GroupOwner>> listGroupOwnersWithHttpInfo(String groupId,
 String filter,
 String after,
 Integer limit)
                                                                                      throws org.springframework.web.client.RestClientException

List all Group Owners Lists all owners for a specific group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<GroupOwner>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupOwnersWithPaginationInfo

public PagedList listGroupOwnersWithPaginationInfo(String groupId,
 String filter,
 String after,
 Integer limit)
                                            throws org.springframework.web.client.RestClientException

List all Group Owners Lists all owners for a specific group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<GroupOwner>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupRules

public List<GroupRule> listGroupRules(Integer limit,
 String after,
 String search,
 String expand)
                               throws org.springframework.web.client.RestClientException

List all Group Rules Lists all group rules

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

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)

Returns:

List<GroupRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupRulesWithHttpInfo

public org.springframework.http.ResponseEntity<List<GroupRule>> listGroupRulesWithHttpInfo(Integer limit,
 String after,
 String search,
 String expand)
                                                                                    throws org.springframework.web.client.RestClientException

List all Group Rules Lists all group rules

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<GroupRule>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupRulesWithPaginationInfo

public PagedList listGroupRulesWithPaginationInfo(Integer limit,
 String after,
 String search,
 String expand)
                                           throws org.springframework.web.client.RestClientException

List all Group Rules Lists all group rules

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<GroupRule>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupUsers

public List<User> listGroupUsers(String groupId,
 String after,
 Integer limit)
                          throws org.springframework.web.client.RestClientException

List all Member Users Lists all users that are a member of a group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

List<User>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupUsersWithHttpInfo

public org.springframework.http.ResponseEntity<List<User>> listGroupUsersWithHttpInfo(String groupId,
 String after,
 Integer limit)
                                                                               throws org.springframework.web.client.RestClientException

List all Member Users Lists all users that are a member of a group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<User>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupUsersWithPaginationInfo

public PagedList listGroupUsersWithPaginationInfo(String groupId,
 String after,
 Integer limit)
                                           throws org.springframework.web.client.RestClientException

List all Member Users Lists all users that are a member of a group

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<User>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroups

public List<Group> listGroups(String q,
 String filter,
 String after,
 Integer limit,
 String expand,
 String search)
                       throws org.springframework.web.client.RestClientException

List all Groups Lists all groups with pagination support. A subset of groups can be returned that match a supported filter expression or query.

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

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)

Returns:

List<Group>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupsWithHttpInfo

public org.springframework.http.ResponseEntity<List<Group>> listGroupsWithHttpInfo(String q,
 String filter,
 String after,
 Integer limit,
 String expand,
 String search)
                                                                            throws org.springframework.web.client.RestClientException

List all Groups Lists all groups with pagination support. A subset of groups can be returned that match a supported filter expression or query.

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<Group>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupsWithPaginationInfo

public PagedList listGroupsWithPaginationInfo(String q,
 String filter,
 String after,
 Integer limit,
 String expand,
 String search)
                                       throws org.springframework.web.client.RestClientException

List all Groups Lists all groups with pagination support. A subset of groups can be returned that match a supported filter expression or query.

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

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)

Returns:

ResponseEntity<List<Group>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceGroup

public Group replaceGroup(String groupId,
 Group group)
                   throws org.springframework.web.client.RestClientException

Replace a Group Replaces the profile for a group with `OKTA_GROUP` type

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

group - (required)

Returns:

Group

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceGroup

public <T> T replaceGroup(Class<?> T,
 String groupId,
 Group group)
                   throws org.springframework.web.client.RestClientException

Replace a Group Replaces the profile for a group with `OKTA_GROUP` type

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

groupId - (required)

group - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceGroupWithHttpInfo

public org.springframework.http.ResponseEntity<Group> replaceGroupWithHttpInfo(String groupId,
 Group group)
                                                                        throws org.springframework.web.client.RestClientException

Replace a Group Replaces the profile for a group with `OKTA_GROUP` type

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

group - (required)

Returns:

ResponseEntity<Group>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceGroupWithPaginationInfo

public PagedList replaceGroupWithPaginationInfo(String groupId,
 Group group)
                                         throws org.springframework.web.client.RestClientException

Replace a Group Replaces the profile for a group with `OKTA_GROUP` type

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

group - (required)

Returns:

ResponseEntity<Group>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceGroupRule

public GroupRule replaceGroupRule(String ruleId,
 GroupRule groupRule)
                           throws org.springframework.web.client.RestClientException

Replace a Group Rule Replaces a group rule. Only `INACTIVE` rules can be updated.

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

groupRule - (required)

Returns:

GroupRule

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceGroupRule

public <T> T replaceGroupRule(Class<?> T,
 String ruleId,
 GroupRule groupRule)
                       throws org.springframework.web.client.RestClientException

Replace a Group Rule Replaces a group rule. Only `INACTIVE` rules can be updated.

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

ruleId - (required)

groupRule - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceGroupRuleWithHttpInfo

public org.springframework.http.ResponseEntity<GroupRule> replaceGroupRuleWithHttpInfo(String ruleId,
 GroupRule groupRule)
                                                                                throws org.springframework.web.client.RestClientException

Replace a Group Rule Replaces a group rule. Only `INACTIVE` rules can be updated.

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

groupRule - (required)

Returns:

ResponseEntity<GroupRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceGroupRuleWithPaginationInfo

public PagedList replaceGroupRuleWithPaginationInfo(String ruleId,
 GroupRule groupRule)
                                             throws org.springframework.web.client.RestClientException

Replace a Group Rule Replaces a group rule. Only `INACTIVE` rules can be updated.

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

ruleId - (required)

groupRule - (required)

Returns:

ResponseEntity<GroupRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unassignUserFromGroup

public void unassignUserFromGroup(String groupId,
 String userId)
                           throws org.springframework.web.client.RestClientException

Unassign a User Unassigns a user from a group with 'OKTA_GROUP' type

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

userId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unassignUserFromGroupWithHttpInfo

public org.springframework.http.ResponseEntity<Void> unassignUserFromGroupWithHttpInfo(String groupId,
 String userId)
                                                                                throws org.springframework.web.client.RestClientException

Unassign a User Unassigns a user from a group with 'OKTA_GROUP' type

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

userId - (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API