Resource Sets

The Resource Sets API provides operations to manage Resource Sets as a custom set of resources. See Supported Resources.

List all Resource Sets
OAuth 2.0: okta.roles.read

Lists all Resource Sets with pagination support

Request
query Parameters
after
string

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.

Responses
200

OK

403

Forbidden

429

Too Many Requests

get/api/v1/iam/resource-sets
Request samples
Response samples
application/json
{}

Create a Resource Set
OAuth 2.0: okta.roles.manage

Creates a new Resource Set. See Supported Resources.

Note: The maximum number 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.

Request
Request Body schema: application/json
required
description
required
string

Description of the Resource Set

label
required
string

Unique name for the Resource Set

resources
required
Array of strings <= 1000

The endpoint (URL) that references all resource objects included in the Resource Set. Resources are identified by either an Okta Resource Name (ORN) or by a REST URL format. See Okta Resource Name.

Responses
200

Success

400

Bad Request

403

Forbidden

429

Too Many Requests

post/api/v1/iam/resource-sets
Request samples
application/json
{}
Response samples
application/json
{}

Retrieve a Resource Set
OAuth 2.0: okta.roles.read

Retrieves a Resource Set by resourceSetIdOrLabel

Request
path Parameters
resourceSetIdOrLabel
required
string

id or label the Resource Set

Example: iamoJDFKaJxGIr0oamd9g
Responses
200

OK

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/iam/resource-sets/{resourceSetIdOrLabel}
Request samples
Response samples
application/json
{}

Replace a Resource Set
OAuth 2.0: okta.roles.manage

Replaces the label and description of a Resource Set

Request
path Parameters
resourceSetIdOrLabel
required
string

id or label the Resource Set

Example: iamoJDFKaJxGIr0oamd9g
Request Body schema: application/json
required
description
string

Description of the Resource Set

label
string

Unique label for the Resource Set

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

put/api/v1/iam/resource-sets/{resourceSetIdOrLabel}
Request samples
application/json
{
  • "label": "SF-IT-People",
  • "description": "People in the IT department of San Francisco"
}
Response samples
application/json
{}

Delete a Resource Set
OAuth 2.0: okta.roles.manage

Deletes a Resource Set by resourceSetIdOrLabel

Request
path Parameters
resourceSetIdOrLabel
required
string

id or label the Resource Set

Example: iamoJDFKaJxGIr0oamd9g
Responses
204

No Content

403

Forbidden

404

Not Found

429

Too Many Requests

delete/api/v1/iam/resource-sets/{resourceSetIdOrLabel}
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": [ ]
}