Package com.okta.sdk.resource.api

Class ResourceSetApi

java.lang.Object

com.okta.sdk.resource.api.ResourceSetApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-08-09T14:19:33.269913-05:00[America/Chicago]",
           comments="Generator version: 7.7.0")
public class ResourceSetApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ResourceSetApi()
ResourceSetApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ResourceSetBindingResponse	addMembersToBinding(String resourceSetId, String roleIdOrLabel, ResourceSetBindingAddMembersRequest instance)	Add more Members to a binding Adds more members to a Resource Set binding
ResourceSetBindingResponse	addMembersToBinding(String resourceSetId, String roleIdOrLabel, ResourceSetBindingAddMembersRequest instance, Map<String,String> additionalHeaders)	Add more Members to a binding Adds more members to a Resource Set binding
ResourceSet	addResourceSetResource(String resourceSetId, ResourceSetResourcePatchRequest instance)	Add more Resource to a Resource Set Adds more resources to a Resource Set
ResourceSet	addResourceSetResource(String resourceSetId, ResourceSetResourcePatchRequest instance, Map<String,String> additionalHeaders)	Add more Resource to a Resource Set Adds more resources to a Resource Set
ResourceSet	createResourceSet(CreateResourceSetRequest instance)	Create a Resource Set Creates a new Resource Set.
ResourceSet	createResourceSet(CreateResourceSetRequest instance, Map<String,String> additionalHeaders)	Create a Resource Set Creates a new Resource Set.
ResourceSetBindingResponse	createResourceSetBinding(String resourceSetId, ResourceSetBindingCreateRequest instance)	Create a Resource Set Binding Creates a new Resource Set binding
ResourceSetBindingResponse	createResourceSetBinding(String resourceSetId, ResourceSetBindingCreateRequest instance, Map<String,String> additionalHeaders)	Create a Resource Set Binding Creates a new Resource Set binding
void	deleteBinding(String resourceSetId, String roleIdOrLabel)	Delete a Binding Deletes a Resource Set binding by `resourceSetId` and `roleIdOrLabel`
void	deleteBinding(String resourceSetId, String roleIdOrLabel, Map<String,String> additionalHeaders)	Delete a Binding Deletes a Resource Set binding by `resourceSetId` and `roleIdOrLabel`
void	deleteResourceSet(String resourceSetId)	Delete a Resource Set Deletes a role by `resourceSetId`
void	deleteResourceSet(String resourceSetId, Map<String,String> additionalHeaders)	Delete a Resource Set Deletes a role by `resourceSetId`
void	deleteResourceSetResource(String resourceSetId, String resourceId)	Delete a Resource from a Resource Set Deletes a resource identified by `resourceId` from a Resource Set
void	deleteResourceSetResource(String resourceSetId, String resourceId, Map<String,String> additionalHeaders)	Delete a Resource from a Resource Set Deletes a resource identified by `resourceId` from a Resource Set
ApiClient	getApiClient()
ResourceSetBindingResponse	getBinding(String resourceSetId, String roleIdOrLabel)	Retrieve a Binding Retrieves a Resource Set binding by `resourceSetId` and `roleIdOrLabel`
ResourceSetBindingResponse	getBinding(String resourceSetId, String roleIdOrLabel, Map<String,String> additionalHeaders)	Retrieve a Binding Retrieves a Resource Set binding by `resourceSetId` and `roleIdOrLabel`
ResourceSetBindingMember	getMemberOfBinding(String resourceSetId, String roleIdOrLabel, String memberId)	Retrieve a Member of a binding Retrieves a member identified by `memberId` for a binding
ResourceSetBindingMember	getMemberOfBinding(String resourceSetId, String roleIdOrLabel, String memberId, Map<String,String> additionalHeaders)	Retrieve a Member of a binding Retrieves a member identified by `memberId` for a binding
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
ResourceSet	getResourceSet(String resourceSetId)	Retrieve a Resource Set Retrieves a Resource Set by `resourceSetId`
ResourceSet	getResourceSet(String resourceSetId, Map<String,String> additionalHeaders)	Retrieve a Resource Set Retrieves a Resource Set by `resourceSetId`
ResourceSetBindings	listBindings(String resourceSetId, String after)	List all Bindings Lists all Resource Set bindings with pagination support
ResourceSetBindings	listBindings(String resourceSetId, String after, Map<String,String> additionalHeaders)	List all Bindings Lists all Resource Set bindings with pagination support
ResourceSetBindingMembers	listMembersOfBinding(String resourceSetId, String roleIdOrLabel, String after)	List all Members of a binding Lists all members of a Resource Set binding with pagination support
ResourceSetBindingMembers	listMembersOfBinding(String resourceSetId, String roleIdOrLabel, String after, Map<String,String> additionalHeaders)	List all Members of a binding Lists all members of a Resource Set binding with pagination support
ResourceSetResources	listResourceSetResources(String resourceSetId)	List all Resources of a Resource Set Lists all resources that make up the Resource Set
ResourceSetResources	listResourceSetResources(String resourceSetId, Map<String,String> additionalHeaders)	List all Resources of a Resource Set Lists all resources that make up the Resource Set
ResourceSets	listResourceSets(String after)	List all Resource Sets Lists all Resource Sets with pagination support
ResourceSets	listResourceSets(String after, Map<String,String> additionalHeaders)	List all Resource Sets Lists all Resource Sets with pagination support
ResourceSet	replaceResourceSet(String resourceSetId, ResourceSet instance)	Replace a Resource Set Replaces a Resource Set by `resourceSetId`
ResourceSet	replaceResourceSet(String resourceSetId, ResourceSet instance, Map<String,String> additionalHeaders)	Replace a Resource Set Replaces a Resource Set by `resourceSetId`
void	setApiClient(ApiClient apiClient)
void	unassignMemberFromBinding(String resourceSetId, String roleIdOrLabel, String memberId)	Unassign a Member from a binding Unassigns a member identified by `memberId` from a binding
void	unassignMemberFromBinding(String resourceSetId, String roleIdOrLabel, String memberId, Map<String,String> additionalHeaders)	Unassign a Member from a binding Unassigns a member identified by `memberId` from a binding

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceSetApi

public ResourceSetApi()

ResourceSetApi

public ResourceSetApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addMembersToBinding

public ResourceSetBindingResponse addMembersToBinding(String resourceSetId,
 String roleIdOrLabel,
 ResourceSetBindingAddMembersRequest instance)
                                               throws ApiException

Add more Members to a binding Adds more members to a Resource Set binding

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

instance - (required)

Returns:

ResourceSetBindingResponse

Throws:

ApiException - if fails to make API call

addMembersToBinding

public ResourceSetBindingResponse addMembersToBinding(String resourceSetId,
 String roleIdOrLabel,
 ResourceSetBindingAddMembersRequest instance,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Add more Members to a binding Adds more members to a Resource Set binding

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSetBindingResponse

Throws:

ApiException - if fails to make API call

addResourceSetResource

public ResourceSet addResourceSetResource(String resourceSetId,
 ResourceSetResourcePatchRequest instance)
                                   throws ApiException

Add more Resource to a Resource Set Adds more resources to a Resource Set

Parameters:

resourceSetId - `id` of a Resource Set (required)

instance - (required)

Returns:

ResourceSet

Throws:

ApiException - if fails to make API call

addResourceSetResource

public ResourceSet addResourceSetResource(String resourceSetId,
 ResourceSetResourcePatchRequest instance,
 Map<String,String> additionalHeaders)
                                   throws ApiException

Add more Resource to a Resource Set Adds more resources to a Resource Set

Parameters:

resourceSetId - `id` of a Resource Set (required)

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSet

Throws:

ApiException - if fails to make API call

createResourceSet

public ResourceSet createResourceSet(CreateResourceSetRequest instance)
                              throws ApiException

Create a Resource Set Creates a new Resource Set. See [Supported Resources](/openapi/okta-management/guides/roles/#supported-resources). > **Note:** The maximum amount of `resources` allowed in a `resource set` object is 1000. Resources are identified by either an Okta Resource Name (ORN) or by a REST URL format. See [Okta Resource Name](/openapi/okta-management/guides/roles/#okta-resource-name-orn).

Parameters:

instance - (required)

Returns:

ResourceSet

Throws:

ApiException - if fails to make API call

createResourceSet

public ResourceSet createResourceSet(CreateResourceSetRequest instance,
 Map<String,String> additionalHeaders)
                              throws ApiException

Create a Resource Set Creates a new Resource Set. See [Supported Resources](/openapi/okta-management/guides/roles/#supported-resources). > **Note:** The maximum amount of `resources` allowed in a `resource set` object is 1000. Resources are identified by either an Okta Resource Name (ORN) or by a REST URL format. See [Okta Resource Name](/openapi/okta-management/guides/roles/#okta-resource-name-orn).

Parameters:

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSet

Throws:

ApiException - if fails to make API call

createResourceSetBinding

public ResourceSetBindingResponse createResourceSetBinding(String resourceSetId,
 ResourceSetBindingCreateRequest instance)
                                                    throws ApiException

Create a Resource Set Binding Creates a new Resource Set binding

Parameters:

resourceSetId - `id` of a Resource Set (required)

instance - (required)

Returns:

ResourceSetBindingResponse

Throws:

ApiException - if fails to make API call

createResourceSetBinding

public ResourceSetBindingResponse createResourceSetBinding(String resourceSetId,
 ResourceSetBindingCreateRequest instance,
 Map<String,String> additionalHeaders)
                                                    throws ApiException

Create a Resource Set Binding Creates a new Resource Set binding

Parameters:

resourceSetId - `id` of a Resource Set (required)

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSetBindingResponse

Throws:

ApiException - if fails to make API call

deleteBinding

public void deleteBinding(String resourceSetId,
 String roleIdOrLabel)
                   throws ApiException

Delete a Binding Deletes a Resource Set binding by `resourceSetId` and `roleIdOrLabel`

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

Throws:

ApiException - if fails to make API call

deleteBinding

public void deleteBinding(String resourceSetId,
 String roleIdOrLabel,
 Map<String,String> additionalHeaders)
                   throws ApiException

Delete a Binding Deletes a Resource Set binding by `resourceSetId` and `roleIdOrLabel`

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteResourceSet

public void deleteResourceSet(String resourceSetId)
                       throws ApiException

Delete a Resource Set Deletes a role by `resourceSetId`

Parameters:

resourceSetId - `id` of a Resource Set (required)

Throws:

ApiException - if fails to make API call

deleteResourceSet

public void deleteResourceSet(String resourceSetId,
 Map<String,String> additionalHeaders)
                       throws ApiException

Delete a Resource Set Deletes a role by `resourceSetId`

Parameters:

resourceSetId - `id` of a Resource Set (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteResourceSetResource

public void deleteResourceSetResource(String resourceSetId,
 String resourceId)
                               throws ApiException

Delete a Resource from a Resource Set Deletes a resource identified by `resourceId` from a Resource Set

Parameters:

resourceSetId - `id` of a Resource Set (required)

resourceId - `id` of a resource (required)

Throws:

ApiException - if fails to make API call

deleteResourceSetResource

public void deleteResourceSetResource(String resourceSetId,
 String resourceId,
 Map<String,String> additionalHeaders)
                               throws ApiException

Delete a Resource from a Resource Set Deletes a resource identified by `resourceId` from a Resource Set

Parameters:

resourceSetId - `id` of a Resource Set (required)

resourceId - `id` of a resource (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getBinding

public ResourceSetBindingResponse getBinding(String resourceSetId,
 String roleIdOrLabel)
                                      throws ApiException

Retrieve a Binding Retrieves a Resource Set binding by `resourceSetId` and `roleIdOrLabel`

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

Returns:

ResourceSetBindingResponse

Throws:

ApiException - if fails to make API call

getBinding

public ResourceSetBindingResponse getBinding(String resourceSetId,
 String roleIdOrLabel,
 Map<String,String> additionalHeaders)
                                      throws ApiException

Retrieve a Binding Retrieves a Resource Set binding by `resourceSetId` and `roleIdOrLabel`

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSetBindingResponse

Throws:

ApiException - if fails to make API call

getMemberOfBinding

public ResourceSetBindingMember getMemberOfBinding(String resourceSetId,
 String roleIdOrLabel,
 String memberId)
                                            throws ApiException

Retrieve a Member of a binding Retrieves a member identified by `memberId` for a binding

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

memberId - `id` of a member (required)

Returns:

ResourceSetBindingMember

Throws:

ApiException - if fails to make API call

getMemberOfBinding

public ResourceSetBindingMember getMemberOfBinding(String resourceSetId,
 String roleIdOrLabel,
 String memberId,
 Map<String,String> additionalHeaders)
                                            throws ApiException

Retrieve a Member of a binding Retrieves a member identified by `memberId` for a binding

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

memberId - `id` of a member (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSetBindingMember

Throws:

ApiException - if fails to make API call

getResourceSet

public ResourceSet getResourceSet(String resourceSetId)
                           throws ApiException

Retrieve a Resource Set Retrieves a Resource Set by `resourceSetId`

Parameters:

resourceSetId - `id` of a Resource Set (required)

Returns:

ResourceSet

Throws:

ApiException - if fails to make API call

getResourceSet

public ResourceSet getResourceSet(String resourceSetId,
 Map<String,String> additionalHeaders)
                           throws ApiException

Retrieve a Resource Set Retrieves a Resource Set by `resourceSetId`

Parameters:

resourceSetId - `id` of a Resource Set (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSet

Throws:

ApiException - if fails to make API call

listBindings

public ResourceSetBindings listBindings(String resourceSetId,
 String after)
                                 throws ApiException

List all Bindings Lists all Resource Set bindings with pagination support

Parameters:

resourceSetId - `id` of a Resource Set (required)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional)

Returns:

ResourceSetBindings

Throws:

ApiException - if fails to make API call

listBindings

public ResourceSetBindings listBindings(String resourceSetId,
 String after,
 Map<String,String> additionalHeaders)
                                 throws ApiException

List all Bindings Lists all Resource Set bindings with pagination support

Parameters:

resourceSetId - `id` of a Resource Set (required)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSetBindings

Throws:

ApiException - if fails to make API call

listMembersOfBinding

public ResourceSetBindingMembers listMembersOfBinding(String resourceSetId,
 String roleIdOrLabel,
 String after)
                                               throws ApiException

List all Members of a binding Lists all members of a Resource Set binding with pagination support

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional)

Returns:

ResourceSetBindingMembers

Throws:

ApiException - if fails to make API call

listMembersOfBinding

public ResourceSetBindingMembers listMembersOfBinding(String resourceSetId,
 String roleIdOrLabel,
 String after,
 Map<String,String> additionalHeaders)
                                               throws ApiException

List all Members of a binding Lists all members of a Resource Set binding with pagination support

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSetBindingMembers

Throws:

ApiException - if fails to make API call

listResourceSetResources

public ResourceSetResources listResourceSetResources(String resourceSetId)
                                              throws ApiException

List all Resources of a Resource Set Lists all resources that make up the Resource Set

Parameters:

resourceSetId - `id` of a Resource Set (required)

Returns:

ResourceSetResources

Throws:

ApiException - if fails to make API call

listResourceSetResources

public ResourceSetResources listResourceSetResources(String resourceSetId,
 Map<String,String> additionalHeaders)
                                              throws ApiException

List all Resources of a Resource Set Lists all resources that make up the Resource Set

Parameters:

resourceSetId - `id` of a Resource Set (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSetResources

Throws:

ApiException - if fails to make API call

listResourceSets

public ResourceSets listResourceSets(String after)
                              throws ApiException

List all Resource Sets Lists all Resource Sets with pagination support

Parameters:

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional)

Returns:

ResourceSets

Throws:

ApiException - if fails to make API call

listResourceSets

public ResourceSets listResourceSets(String after,
 Map<String,String> additionalHeaders)
                              throws ApiException

List all Resource Sets Lists all Resource Sets with pagination support

Parameters:

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSets

Throws:

ApiException - if fails to make API call

replaceResourceSet

public ResourceSet replaceResourceSet(String resourceSetId,
 ResourceSet instance)
                               throws ApiException

Replace a Resource Set Replaces a Resource Set by `resourceSetId`

Parameters:

resourceSetId - `id` of a Resource Set (required)

instance - (required)

Returns:

ResourceSet

Throws:

ApiException - if fails to make API call

replaceResourceSet

public ResourceSet replaceResourceSet(String resourceSetId,
 ResourceSet instance,
 Map<String,String> additionalHeaders)
                               throws ApiException

Replace a Resource Set Replaces a Resource Set by `resourceSetId`

Parameters:

resourceSetId - `id` of a Resource Set (required)

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceSet

Throws:

ApiException - if fails to make API call

unassignMemberFromBinding

public void unassignMemberFromBinding(String resourceSetId,
 String roleIdOrLabel,
 String memberId)
                               throws ApiException

Unassign a Member from a binding Unassigns a member identified by `memberId` from a binding

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

memberId - `id` of a member (required)

Throws:

ApiException - if fails to make API call

unassignMemberFromBinding

public void unassignMemberFromBinding(String resourceSetId,
 String roleIdOrLabel,
 String memberId,
 Map<String,String> additionalHeaders)
                               throws ApiException

Unassign a Member from a binding Unassigns a member identified by `memberId` from a binding

Parameters:

resourceSetId - `id` of a Resource Set (required)

roleIdOrLabel - `id` or `label` of the role (required)

memberId - `id` of a member (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

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