The Resource Sets API provides operations to manage Resource Sets as custom collections of resources. You can use Resource Sets to assign Custom Roles to administrators who are scoped to the designated resources. See Supported Resources.
okta.roles.read
Lists all Resource Sets with pagination support
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 |
OK
Forbidden
Too Many Requests
{- "resource-sets": [
- {
- "id": "iamoJDFKaJxGIr0oamd9g",
- "label": "SF-IT-1",
- "description": "First San Francisco IT Resource Set",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
- "_links": {
- "resources": {
}, - "bindings": {
}
}
}, - {
- "id": "iamoJDFKaJxGIr0oamd0q",
- "label": "SF-IT-2",
- "description": "Second San Francisco IT Resource Set",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
- "_links": {
- "resources": {
}, - "bindings": {
}
}
}
], - "_links": {
}
}
okta.roles.manage
Creates a new Resource Set
Success
Bad Request
Forbidden
Too Many Requests
{- "label": "SF-IT-People",
- "description": "People in the IT department of San Francisco",
}
{- "id": "iamoJDFKaJxGIr0oamd9g",
- "label": "SF-IT-People",
- "description": "People in the IT department of San Francisco",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
- "_links": {
- "resources": {
}, - "bindings": {
}
}
}
okta.roles.read
Retrieves a Resource Set by resourceSetId
OK
Forbidden
Not Found
Too Many Requests
{- "id": "iamoJDFKaJxGIr0oamd9g",
- "label": "SF-IT-People",
- "description": "People in the IT department of San Francisco",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
- "_links": {
- "resources": {
}, - "bindings": {
}
}
}
okta.roles.manage
Replaces a Resource Set by resourceSetId
OK
Bad Request
Forbidden
Not Found
Too Many Requests
{- "label": "SF-IT-People",
- "description": "People in the IT department of San Francisco",
}
{- "id": "iamoJDFKaJxGIr0oamd9g",
- "label": "SF-IT-People",
- "description": "People in the IT department of San Francisco",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
- "_links": {
- "resources": {
}, - "bindings": {
}
}
}
okta.roles.manage
Deletes a role by resourceSetId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.roles.read
Lists all Resource Set bindings with pagination support
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 |
OK
Forbidden
Not Found
Too Many Requests
{- "roles": [
- {
- "id": "cr0WxyzJxGIr0ouum0g4",
- "_links": {
}
}
], - "_links": {
- "self": {
}, - "resource-set": {
},
}
}
okta.roles.manage
Creates a new Resource Set binding
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "role": "cr0Yq6IJxGIr0ouum0g3",
}
{- "_links": {
- "bindings": {
},
}
}
okta.roles.read
Retrieves a Resource Set binding by resourceSetId
and roleIdOrLabel
OK
Forbidden
Not Found
Too Many Requests
{- "id": "cr0Yq6IJxGIr0ouum0g3",
- "_links": {
- "bindings": {
},
}
}
okta.roles.manage
Deletes a Resource Set binding by resourceSetId
and roleIdOrLabel
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.roles.read
Lists all members of a Resource Set binding with pagination support
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 |
OK
Forbidden
Not Found
Too Many Requests
{- "members": [
- {
- "id": "irb1qe6PGuMc7Oh8N0g4",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
}, - {
- "id": "irb1q92TFAHzySt3x0g4",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
}
],
}
okta.roles.manage
Adds more members to a Resource Set binding
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "_links": {
- "bindings": {
},
}
}
okta.roles.read
Retrieves a member identified by memberId
for a binding
OK
Forbidden
Not Found
Too Many Requests
{- "id": "irb1qe6PGuMc7Oh8N0g4",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
}
okta.roles.manage
Unassigns a member identified by memberId
from a binding
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.roles.read
Lists all resources that make up the Resource Set
OK
Forbidden
Not Found
Too Many Requests
{- "resources": [
- {
- "id": "ire106sQKoHoXXsAe0g4",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
}, - {
- "id": "ire106riDrTYl4qA70g4",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
}, - {
- "id": "irezvo4AwE2ngpMw40g3",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
- "_links": {
}
}
], - "_links": {
}
}
okta.roles.manage
Adds more resources to a Resource Set
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "id": "iamoJDFKaJxGIr0oamd9g",
- "label": "SF-IT-People",
- "description": "People in the IT department of San Francisco",
- "created": "2021-02-06T16:20:57.000Z",
- "lastUpdated": "2021-02-06T16:20:57.000Z",
- "_links": {
- "resources": {
}, - "bindings": {
}
}
}
okta.roles.manage
Deletes a resource identified by resourceId
from a Resource Set
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}