role_resource_set_resources

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

Overview

Name	role_resource_set_resources
Type	Resource
Id	okta.iam.role_resource_set_resources

Fields

The following fields are returned by SELECT queries:

get_resource_set_resource

Name	Datatype	Description
id	string	Unique ID of the resource set resource object
_links	object	Related discoverable resources
conditions	object	Conditions for further restricting a resource.
created	string (date-time)	Timestamp when the resource set resource object was created
lastUpdated	string (date-time)	Timestamp when this object was last updated
orn	string	The Okta Resource Name (ORN) of the resource

list_resource_set_resources

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.
resources	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_set_resource	select	resourceSetIdOrLabel, resourceId, subdomain		Retrieves a resource identified by resourceId in a resource set
list_resource_set_resources	select	resourceSetIdOrLabel, subdomain	after, limit	Lists all resources for the resource set
add_resource_set_resource	insert	resourceSetIdOrLabel, subdomain, resourceOrnOrUrl, conditions		Adds a resource with conditions for a resource set
add_resource_set_resources	update	resourceSetIdOrLabel, subdomain		Adds more resources to a resource set
replace_resource_set_resource	replace	resourceSetIdOrLabel, resourceId, subdomain		Replaces the conditions of a resource identified by resourceId in a resource set
delete_resource_set_resource	delete	resourceSetIdOrLabel, resourceId, subdomain		Deletes a resource (identified by resourceId) from a resource set

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
resourceId	string	id of the resource
resourceSetIdOrLabel	string	id or label of the resource set
subdomain	string	(default: my-org)
after	string	Specifies the pagination cursor for the next page of targets
limit	integer (int32)	Specifies the number of results returned. Defaults to 100.

SELECT examples

get_resource_set_resource

Retrieves a resource identified by resourceId in a resource set

SELECT
id,
_links,
conditions,
created,
lastUpdated,
orn
FROM okta.iam.role_resource_set_resources
WHERE resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' -- required
AND resourceId = '{{ resourceId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_resource_set_resources

Lists all resources for the resource set

SELECT
_links,
resources
FROM okta.iam.role_resource_set_resources
WHERE resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
;

INSERT examples

add_resource_set_resource

Adds a resource with conditions for a resource set

INSERT INTO okta.iam.role_resource_set_resources (
conditions,
resourceOrnOrUrl,
resourceSetIdOrLabel,
subdomain
)
SELECT 
'{{ conditions }}' /* required */,
'{{ resourceOrnOrUrl }}' /* required */,
'{{ resourceSetIdOrLabel }}',
'{{ subdomain }}'
RETURNING
id,
_links,
conditions,
created,
lastUpdated,
orn
;

Manifest

# Description fields are for documentation purposes
- name: role_resource_set_resources
props:
  - name: resourceSetIdOrLabel
    value: "{{ resourceSetIdOrLabel }}"
    description: Required parameter for the role_resource_set_resources resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the role_resource_set_resources resource.
  - name: conditions
    description: |
      Conditions for further restricting a resource.
    value:
      Exclude:
        okta:ORN:
          - "{{ okta:ORN }}"
  - name: resourceOrnOrUrl
    value: "{{ resourceOrnOrUrl }}"
    description: |
      Resource in ORN or REST API URL format

UPDATE examples

add_resource_set_resources

Adds more resources to a resource set

UPDATE okta.iam.role_resource_set_resources
SET 
additions = '{{ additions }}'
WHERE 
resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' --required
AND subdomain = '{{ subdomain }}' --required
RETURNING
id,
_links,
created,
description,
label,
lastUpdated;

REPLACE examples

replace_resource_set_resource

Replaces the conditions of a resource identified by resourceId in a resource set

REPLACE okta.iam.role_resource_set_resources
SET 
conditions = '{{ conditions }}'
WHERE 
resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' --required
AND resourceId = '{{ resourceId }}' --required
AND subdomain = '{{ subdomain }}' --required
RETURNING
id,
_links,
conditions,
created,
lastUpdated,
orn;

DELETE examples

delete_resource_set_resource

Deletes a resource (identified by resourceId) from a resource set

DELETE FROM okta.iam.role_resource_set_resources
WHERE resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' --required
AND resourceId = '{{ resourceId }}' --required
AND subdomain = '{{ subdomain }}' --required
;