Role Resource Set Bindings

The Role Resource Set Bindings API provides operations to assign members to a Custom Role that targets resources in a Resource Set. These operations allow you to assign custom roles to admins who are scoped to the designated resources in a resource set.

The returned role resource set binding is a single unique combination of a resource set, a custom role, and members.

List all role resource set bindings
OAuth 2.0: okta.roles.read

Lists all bindings for a resource set with pagination support.

The returned roles array contains the custom role bindings for the specified resource set. If there are more than 100 bindings for the specified resource set, links.next provides the resource with pagination for the next list of bindings.

Request
path Parameters
resourceSetIdOrLabel
required
string

id or label of the resource set

Example: iamoJDFKaJxGIr0oamd9g
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

404

Not Found

429

Too Many Requests

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

Create a role resource set binding
OAuth 2.0: okta.roles.manage

Creates a binding for the resource set, custom role, and members (users or groups)

Request
path Parameters
resourceSetIdOrLabel
required
string

id or label of the resource set

Example: iamoJDFKaJxGIr0oamd9g
Request Body schema: application/json
required
members
Array of strings

URLs to user and/or group instances that are assigned to the role

role
string

Unique key for the role

Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

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

Retrieve a role resource set binding
OAuth 2.0: okta.roles.read

Retrieves the binding of a role (identified by roleIdOrLabel) for a resource set (identified by resourceSetIdOrLabel)

Request
path Parameters
resourceSetIdOrLabel
required
string

id or label of the resource set

Example: iamoJDFKaJxGIr0oamd9g
roleIdOrLabel
required
string

id or label of the role

Example: cr0Yq6IJxGIr0ouum0g3
Responses
200

OK

403

Forbidden

404

Not Found

429

Too Many Requests

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

Delete a role resource set binding
OAuth 2.0: okta.roles.manage

Deletes a binding of a role (identified by roleIdOrLabel) and a resource set (identified by resourceSetIdOrLabel)

Request
path Parameters
resourceSetIdOrLabel
required
string

id or label of the resource set

Example: iamoJDFKaJxGIr0oamd9g
roleIdOrLabel
required
string

id or label of the role

Example: cr0Yq6IJxGIr0ouum0g3
Responses
204

No Content

403

Forbidden

404

Not Found

429

Too Many Requests

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