role_resource_sets

Creates, updates, deletes, gets or lists a role_resource_sets resource.

Overview

Name	role_resource_sets
Type	Resource
Id	okta.iam.role_resource_sets

Fields

The following fields are returned by SELECT queries:

list_resource_sets

Name	Datatype	Description
_links	object	Specifies link relations (see Web Linking) available for the current status of an application using the JSON Hypertext Application Language specification. Use the LinksNext object for dynamic discovery of related resources and lifecycle operations.
resource-sets	array

get_resource_set

Name	Datatype	Description
id	string	Unique ID for the resource set object
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
created	string (date-time)	Timestamp when the role was created
description	string	Description of the resource set
label	string	Unique label for the resource set
lastUpdated	string (date-time)	Timestamp when the role was last updated

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_resource_sets	select	subdomain	after	Lists all resource sets with pagination support
get_resource_set	select	subdomain		Retrieves a resource set by resourceSetIdOrLabel
create_resource_set	insert	subdomain, data__description, data__label, data__resources		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.
replace_resource_set	replace	subdomain		Replaces the label and description of a resource set
delete_resource_set	delete	subdomain		Deletes a resource set by resourceSetIdOrLabel

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)
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.

SELECT examples

list_resource_sets

Lists all resource sets with pagination support

SELECT
_links,
resource-sets
FROM okta.iam.role_resource_sets
WHERE subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
;

get_resource_set

Retrieves a resource set by resourceSetIdOrLabel

SELECT
id,
_links,
created,
description,
label,
lastUpdated
FROM okta.iam.role_resource_sets
WHERE subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_resource_set

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.

INSERT INTO okta.iam.role_resource_sets (
data__description,
data__label,
data__resources,
subdomain
)
SELECT 
'{{ description }}' /* required */,
'{{ label }}' /* required */,
'{{ resources }}' /* required */,
'{{ subdomain }}'
RETURNING
id,
_links,
created,
description,
label,
lastUpdated
;

Manifest

# Description fields are for documentation purposes
- name: role_resource_sets
  props:
    - name: subdomain
      value: string
      description: Required parameter for the role_resource_sets resource.
    - name: description
      value: string
      description: >
        Description of the resource set
        
    - name: label
      value: string
      description: >
        Unique name for the resource set
        
    - name: resources
      value: array
      description: >
        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](https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn).
        

REPLACE examples

replace_resource_set

Replaces the label and description of a resource set

REPLACE okta.iam.role_resource_sets
SET 
data__description = '{{ description }}',
data__label = '{{ label }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
_links,
created,
description,
label,
lastUpdated
;

DELETE examples

delete_resource_set

Deletes a resource set by resourceSetIdOrLabel

DELETE FROM okta.iam.role_resource_sets
WHERE subdomain = '{{ subdomain }}' --required
;