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.
okta.profileMappings.readLists 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.
Success
Forbidden
Too Many Requests
[- {
- "id": "prm1k47ghydIQOTBW0g4",
- "source": {
- "id": "otysbePhQ3yqt4cVv0g3",
- "name": "user",
- "type": "user",
- "_links": {
}
}, - "target": {
- "id": "0oa1qmn4LZQQEH0wZ0g4",
- "name": "okta_org2org",
- "type": "appuser",
- "_links": {
- "schema": {
}
}
},
}
]okta.profileMappings.readRetrieves a single Profile Mapping referenced by its ID
Success
Forbidden
Not Found
Too Many Requests
{- "id": "prm1k47ghydIQOTBW0g4",
- "source": {
- "id": "otysbePhQ3yqt4cVv0g3",
- "name": "user",
- "type": "user",
- "_links": {
}
}, - "target": {
- "id": "0oa1qmn4LZQQEH0wZ0g4",
- "name": "okta_org2org",
- "type": "appuser",
- "_links": {
- "schema": {
}
}
}, - "properties": {
- "firstName": {
- "expression": "user.firstName",
- "pushStatus": "PUSH"
}, - "lastName": {
- "expression": "user.lastName",
- "pushStatus": "PUSH"
}
},
}okta.profileMappings.manageUpdates an existing profile mapping by adding, updating, or removing one or many property mappings
required | object | ||||
| |||||
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "properties": {
- "additionalProperties": {
- "fullName": {
- "expression": "user.firstName + user.lastName",
- "pushStatus": "PUSH"
}, - "nickName": {
- "expression": "user.nickName",
- "pushStatus": "PUSH"
}
}
}
}{- "id": "prm1k47ghydIQOTBW0g4",
- "source": {
- "id": "otysbePhQ3yqt4cVv0g3",
- "name": "user",
- "type": "user",
- "_links": {
}
}, - "target": {
- "id": "0oa1qmn4LZQQEH0wZ0g4",
- "name": "okta_org2org",
- "type": "appuser",
- "_links": {
- "schema": {
}
}
}, - "properties": {
- "fullName": {
- "expression": "user.firstName + user.lastName",
- "pushStatus": "PUSH"
}, - "nickName": {
- "expression": "user.nickName",
- "pushStatus": "PUSH"
}
},
}