The Resource Sets API provides operations to manage resource sets as a custom set of resources. See Supported resources.
Lists all resource sets with pagination support
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": {
}
}Creates a new resource set. See Supported resources.
Note: The maximum number of
resourcesallowed 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.
| 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. |
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": {
}
}
}Retrieves a resource set by resourceSetIdOrLabel
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": {
}
}
}Replaces the label and description of a resource set
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": {
}
}
}Deletes a resource set by resourceSetIdOrLabel
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": [ ]
}