Resource Set Resources

The Resource Set Resources API provides operations to manage resources within a resource set. You can add or remove resources in resource sets. See Supported resources.

List all resource set resources
OAuth 2.0 scopes:
  • okta.roles.read

Lists all resources for the resource set

Request
path Parameters
resourceSetIdOrLabel
required
string

id or label of the resource set

Example: iamoJDFKaJxGIr0oamd9g
query Parameters
after
string

Specifies the pagination cursor for the next page of targets

limit
integer <int32>
Default: 100

Specifies the number of results returned. Defaults to 100.

Responses
200

OK

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources
Request samples 
Response samples 
application/json
{}
Add a resource set resource with conditions
OAuth 2.0 scopes: 
  • okta.roles.manage
Adds a resource with conditions for a resource set


Request 
path Parameters
resourceSetIdOrLabel
required
string
id or label of the resource set


 
 Example:  iamoJDFKaJxGIr0oamd9g
Request Body schema: application/json
required
resourceOrnOrUrl
required
string
Resource in ORN or REST API URL format


 
required
object (ResourceConditions) 
Conditions for further restricting a resource.


 
object
Specific resources to exclude


 
okta:ORN
Array of strings
List of specific resources to exclude in ORN format


 
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources
Request samples 
application/json
{
  • "resourceOrnOrUrl": "https://{yourOktaDomain}/api/v1/apps",
  • "conditions": {
    • "Exclude": {
      }
    }
}
Response samples 
application/json
{}
Add more resources to a resource set
OAuth 2.0 scopes: 
  • okta.roles.manage
Adds more resources to a resource set


Request 
path Parameters
resourceSetIdOrLabel
required
string
id or label of the resource set


 
 Example:  iamoJDFKaJxGIr0oamd9g
Request Body schema: application/json
required
additions
Array of strings
A list of resources to add to the resource set


 
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


patch/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources
Request samples 
application/json
{}
Response samples 
application/json
{}
Retrieve a resource set resource
OAuth 2.0 scopes: 
  • okta.roles.read
Retrieves a resource identified by resourceId in a resource set


Request 
path Parameters
resourceSetIdOrLabel
required
string
id or label of the resource set


 
 Example:  iamoJDFKaJxGIr0oamd9g
resourceId
required
string
id of the resource


 
 Example:  ire106sQKoHoXXsAe0g4
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}
Request samples 
Response samples 
application/json
{}
Replace the resource set resource conditions
OAuth 2.0 scopes: 
  • okta.roles.manage
Replaces the conditions of a resource identified by resourceId in a resource set


Request 
path Parameters
resourceSetIdOrLabel
required
string
id or label of the resource set


 
 Example:  iamoJDFKaJxGIr0oamd9g
resourceId
required
string
id of the resource


 
 Example:  ire106sQKoHoXXsAe0g4
Request Body schema: application/json
required
object (ResourceConditions) 
Conditions for further restricting a resource.


 
object
Specific resources to exclude


 
okta:ORN
Array of strings
List of specific resources to exclude in ORN format


 
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}
Request samples 
application/json
{
  • "conditions": {
    • "Exclude": {
      }
    }
}
Response samples 
application/json
{}
Delete a resource set resource
OAuth 2.0 scopes: 
  • okta.roles.manage
Deletes a resource (identified by resourceId) from a resource set


Request 
path Parameters
resourceSetIdOrLabel
required
string
id or label of the resource set


 
 Example:  iamoJDFKaJxGIr0oamd9g
resourceId
required
string
id of the resource


 
 Example:  ire106sQKoHoXXsAe0g4
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/iam/resource-sets/{resourceSetIdOrLabel}/resources/{resourceId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}