Package com.okta.sdk.resource.api

Class GroupOwnerApi

java.lang.Object

com.okta.sdk.resource.api.GroupOwnerApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class GroupOwnerApi
extends Object

Constructor Summary

Constructors

Constructor	Description
GroupOwnerApi()
GroupOwnerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
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	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
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<GroupOwner>	listGroupOwners(String groupId, String search, String after, Integer limit)	List all Group Owners Lists all owners for a specific group
List<GroupOwner>	listGroupOwners(String groupId, String search, String after, Integer limit, Map<String,String> additionalHeaders)	List all Group Owners Lists all owners for a specific group
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

GroupOwnerApi

public GroupOwnerApi()

GroupOwnerApi

public GroupOwnerApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

assignGroupOwner

public GroupOwner assignGroupOwner(String groupId,
 AssignGroupOwnerRequestBody assignGroupOwnerRequestBody)
                            throws ApiException

Assign a Group Owner Assigns a group owner

Parameters:

groupId - The `id` of the group (required)

assignGroupOwnerRequestBody - (required)

Returns:

GroupOwner

Throws:

ApiException - if fails to make API call

assignGroupOwner

public GroupOwner assignGroupOwner(String groupId,
 AssignGroupOwnerRequestBody assignGroupOwnerRequestBody,
 Map<String,String> additionalHeaders)
                            throws ApiException

Assign a Group Owner Assigns a group owner

Parameters:

groupId - The `id` of the group (required)

assignGroupOwnerRequestBody - (required)

additionalHeaders - additionalHeaders for this call

Returns:

GroupOwner

Throws:

ApiException - if fails to make API call

deleteGroupOwner

public void deleteGroupOwner(String groupId,
 String ownerId)
                      throws ApiException

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

Parameters:

groupId - The `id` of the group (required)

ownerId - The `id` of the group owner (required)

Throws:

ApiException - if fails to make API call

deleteGroupOwner

public void deleteGroupOwner(String groupId,
 String ownerId,
 Map<String,String> additionalHeaders)
                      throws ApiException

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

Parameters:

groupId - The `id` of the group (required)

ownerId - The `id` of the group owner (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

listGroupOwners

public List<GroupOwner> listGroupOwners(String groupId,
 String search,
 String after,
 Integer limit)
                                 throws ApiException

List all Group Owners Lists all owners for a specific group

Parameters:

groupId - The `id` of the group (required)

search - 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:

ApiException - if fails to make API call

listGroupOwners

public List<GroupOwner> listGroupOwners(String groupId,
 String search,
 String after,
 Integer limit,
 Map<String,String> additionalHeaders)
                                 throws ApiException

List all Group Owners Lists all owners for a specific group

Parameters:

groupId - The `id` of the group (required)

search - 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 call

Returns:

List<GroupOwner>

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()