profile_mappings

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

Overview

Name	profile_mappings
Type	Resource
Id	okta.mappings.profile_mappings

Fields

The following fields are returned by SELECT queries:

get_profile_mapping

Name	Datatype	Description

list_profile_mappings

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile_mapping	select	mappingId, subdomain		Retrieves a single profile mapping referenced by its ID
list_profile_mappings	select	subdomain	after, limit, sourceId, targetId	Lists all profile mappings in your org with pagination. You can return a subset of profile mappings that match a supported sourceId and/or targetId. The results are [paginated]https://developer.okta.com/docs/api#pagination according to the limit parameter. If there are multiple pages of results, the Link header contains a next link that you should treat as an opaque value (follow it, don't parse it). See Link Header. The response is a collection of profile mappings that include a subset of the profile mapping object's parameters. The profile mapping object describes the properties mapping between an Okta user and an app user profile using JSON Schema Draft 4.
update_profile_mapping	update	mappingId, subdomain, properties, expression, pushStatus		Updates an existing profile mapping by adding, updating, or removing one or many property mappings

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 Mapping
subdomain	string	(default: my-org)
after	string	Mapping id that specifies the pagination cursor for the next page of mappings
limit	integer (int32)	Specifies the number of results per page > Note: If you encounter timeout errors with larger values, reduce the limit (for example, 50) and use pagination with the after parameter to retrieve the results.
sourceId	string	The user type or app instance ID that acts as the source of expressions in a mapping. If this parameter is included, all returned mappings have this as their source.id.
targetId	string	The user type or app instance ID that acts as the target of expressions in a mapping. If this parameter is included, all returned mappings have this as their target.id.

SELECT examples

get_profile_mapping

Retrieves a single profile mapping referenced by its ID

SELECT
*
FROM okta.mappings.profile_mappings
WHERE mappingId = '{{ mappingId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_profile_mappings

Lists all profile mappings in your org with pagination. You can return a subset of profile mappings that match a supported sourceId and/or targetId.

The results are [paginated]https://developer.okta.com/docs/api#pagination according to the limit parameter. If there are multiple pages of results, the Link header contains a next link that you should treat as an opaque value (follow it, don't parse it). See Link Header.

The response is a collection of profile mappings that include a subset of the profile mapping object's parameters. The profile mapping object describes
the properties mapping between an Okta user and an app user profile using JSON Schema Draft 4.

SELECT
*
FROM okta.mappings.profile_mappings
WHERE subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
AND sourceId = '{{ sourceId }}'
AND targetId = '{{ targetId }}'
;

UPDATE examples

update_profile_mapping

Updates an existing profile mapping by adding, updating, or removing one or many property mappings

UPDATE okta.mappings.profile_mappings
SET 
properties = '{{ properties }}'
WHERE 
mappingId = '{{ mappingId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND properties = '{{ properties }}' --required;