Profile Mappings

The Mappings API provides operations to manage the mapping of Profile properties between an Okta User and an App User using Okta Expression Language. More information on Okta User and App User Profiles can be found in Okta's User profiles.

List all Profile Mappings
OAuth 2.0: okta.profileMappings.read

Lists all profile mappings in your organization with pagination. You can return a subset of profile mappings that match a supported sourceId and/or targetId. The results are paginated according to the limit parameter. If there are multiple pages of results, the Link header contains a next link that should be treated as an opaque value (follow it, don't parse it).

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.

Request
query Parameters
after
string

Mapping id that specifies the pagination cursor for the next page of mappings

limit
integer <int32>
Default: 20

Specifies the number of results per page (maximum 200)

sourceId
string

The UserType 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 UserType 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.

Responses
200

Success

403

Forbidden

429

Too Many Requests

get/api/v1/mappings
Request samples
Response samples
application/json
[]

Retrieve a Profile Mapping
OAuth 2.0: okta.profileMappings.read

Retrieves a single Profile Mapping referenced by its ID

Request
path Parameters
mappingId
required
string

id of the Mapping

Example: cB6u7X8mptebWkffatKA
Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/mappings/{mappingId}
Request samples
Response samples
application/json
{}

Update a Profile Mapping
OAuth 2.0: okta.profileMappings.manage

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

Request
path Parameters
mappingId
required
string

id of the Mapping

Example: cB6u7X8mptebWkffatKA
Request Body schema: application/json
required
required
object
additional property
object (ProfileMappingProperty)

A target property, in string form, that maps to a valid JSON Schema Draft document.

expression
string

Combination or single source properties that are mapped to the target property

pushStatus
string (ProfileMappingPropertyPushStatus)

Indicates whether to update target properties for user create and update or just for user create.

Having a pushStatus of PUSH causes properties in the target to be updated on create and update. Having a pushStatus of DONT_PUSH causes properties in the target to be updated only on create.

Enum: "DONT_PUSH" "PUSH"
Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/mappings/{mappingId}
Request samples
application/json
{
  • "properties": {
    • "additionalProperties": {
      }
    }
}
Response samples
application/json
{}