policy_mappings

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

Overview

Name	policy_mappings
Type	Resource
Id	okta.policies.policy_mappings

Fields

The following fields are returned by SELECT queries:

get_policy_mapping

Name	Datatype	Description
id	string
_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.

list_policy_mappings

Name	Datatype	Description
id	string
_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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_policy_mapping	select	policyId, mappingId, subdomain		Retrieves a resource mapping for a policy identified by policyId and mappingId
list_policy_mappings	select	policyId, subdomain		Lists all resources mapped to a policy identified by policyId
delete_policy_resource_mapping	delete	policyId, mappingId, subdomain		Deletes the resource mapping for a policy identified by policyId and mappingId
map_resource_to_policy	exec	policyId, subdomain		Maps a resource to a policy identified by policyId > Note: Use the Assign an app sign-in policy endpoint to assign an app sign-in policy to an app.

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
mappingId	string	id of the policy resource Mapping
policyId	string	id of the policy
subdomain	string	(default: my-org)

SELECT examples

get_policy_mapping

Retrieves a resource mapping for a policy identified by policyId and mappingId

SELECT
id,
_links
FROM okta.policies.policy_mappings
WHERE policyId = '{{ policyId }}' -- required
AND mappingId = '{{ mappingId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_policy_mappings

Lists all resources mapped to a policy identified by policyId

SELECT
id,
_links
FROM okta.policies.policy_mappings
WHERE policyId = '{{ policyId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

DELETE examples

delete_policy_resource_mapping

Deletes the resource mapping for a policy identified by policyId and mappingId

DELETE FROM okta.policies.policy_mappings
WHERE policyId = '{{ policyId }}' --required
AND mappingId = '{{ mappingId }}' --required
AND subdomain = '{{ subdomain }}' --required
;

Lifecycle Methods

map_resource_to_policy

Maps a resource to a policy identified by policyId

> Note: Use the Assign an app sign-in policy endpoint to assign an app sign-in policy to an app.

EXEC okta.policies.policy_mappings.map_resource_to_policy 
@policyId='{{ policyId }}' --required, 
@subdomain='{{ subdomain }}' --required 
@@json=
'{
"resourceId": "{{ resourceId }}", 
"resourceType": "{{ resourceType }}"
}'
;