role_resource_set_binding_members
Creates, updates, deletes, gets or lists a role_resource_set_binding_members resource.
Overview​
| Name | role_resource_set_binding_members |
| Type | Resource |
| Id | okta.iam.role_resource_set_binding_members |
Fields​
The following fields are returned by SELECT queries:
- get_member_of_binding
- list_members_of_binding
| Name | Datatype | Description |
|---|---|---|
id | string | Role resource set binding member ID |
_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 member was created |
lastUpdated | string (date-time) | Timestamp when the member was last updated |
| Name | Datatype | Description |
|---|---|---|
_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. |
members | array | The members of the role resource set binding. If there are more than 100 members for the binding, then the _links.next resource is returned with the next list of members. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_member_of_binding | select | resourceSetIdOrLabel, roleIdOrLabel, memberId, subdomain | Retrieves a member (identified by memberId) that belongs to a role resource set binding | |
list_members_of_binding | select | resourceSetIdOrLabel, roleIdOrLabel, subdomain | after | Lists all members of a role resource set binding with pagination support |
add_members_to_binding | update | resourceSetIdOrLabel, roleIdOrLabel, subdomain | Adds more members to a role resource set binding | |
unassign_member_from_binding | delete | resourceSetIdOrLabel, roleIdOrLabel, memberId, subdomain | Unassigns a member (identified by memberId) from a role resource set binding |
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 |
|---|---|---|
memberId | string | id of the member |
resourceSetIdOrLabel | string | id or label of the resource set |
roleIdOrLabel | string | id or label of the role |
subdomain | string | (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 and Link header. |
SELECT examples​
- get_member_of_binding
- list_members_of_binding
Retrieves a member (identified by memberId) that belongs to a role resource set binding
SELECT
id,
_links,
created,
lastUpdated
FROM okta.iam.role_resource_set_binding_members
WHERE resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' -- required
AND roleIdOrLabel = '{{ roleIdOrLabel }}' -- required
AND memberId = '{{ memberId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;
Lists all members of a role resource set binding with pagination support
SELECT
_links,
members
FROM okta.iam.role_resource_set_binding_members
WHERE resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' -- required
AND roleIdOrLabel = '{{ roleIdOrLabel }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
;
UPDATE examples​
- add_members_to_binding
Adds more members to a role resource set binding
UPDATE okta.iam.role_resource_set_binding_members
SET
additions = '{{ additions }}'
WHERE
resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' --required
AND roleIdOrLabel = '{{ roleIdOrLabel }}' --required
AND subdomain = '{{ subdomain }}' --required
RETURNING
_links;
DELETE examples​
- unassign_member_from_binding
Unassigns a member (identified by memberId) from a role resource set binding
DELETE FROM okta.iam.role_resource_set_binding_members
WHERE resourceSetIdOrLabel = '{{ resourceSetIdOrLabel }}' --required
AND roleIdOrLabel = '{{ roleIdOrLabel }}' --required
AND memberId = '{{ memberId }}' --required
AND subdomain = '{{ subdomain }}' --required
;