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:

list_profile_mappings

Name	Datatype	Description
id	string	Unique identifier for profile mapping
_links		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.
source		The parameter is the source of a profile mapping and is a valid JSON Schema Draft 4 document with the following properties. The data type can be an app instance or an Okta object. > Note: If the source is Okta and the UserTypes feature isn't enabled, then the source _links only has a link to the schema.
target		The parameter is the target of a profile mapping and is a valid JSON Schema Draft 4 document with the following properties. The data type can be an app instance or an Okta object. > Note: If the target is Okta and the UserTypes feature isn't enabled, then the target _links only has a link to the schema.

get_profile_mapping

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
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.
get_profile_mapping	select	subdomain		Retrieves a single profile mapping referenced by its ID
update_profile_mapping	update	subdomain, data__properties, data__expression, data__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
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	Mapping id that specifies the pagination cursor for the next page of mappings
limit	integer (int32)	Specifies the number of results per page
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

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
id,
_links,
source,
target
FROM okta.mappings.profile_mappings
WHERE subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
AND sourceId = '{{ sourceId }}'
AND targetId = '{{ targetId }}';

get_profile_mapping

Retrieves a single profile mapping referenced by its ID

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

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 
data__properties = '{{ properties }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__properties = '{{ properties }}' --required;