Skip to navigation

Update identity ingestion

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
sourceslist of objectsOptional

Identity sources used to build the Moveworks user profile. On update, include every source to keep; omitted sources are removed. 1 to 99 sources.

override_user_profile_mappingsmap from strings to stringsOptional

Mappings applied after all sources are merged, overriding user profile fields with values from other sources. On update, send the full map; omitted entries are removed.

Response

The updated identity ingestion, at its new version
sourceslist of objectsOptional

Identity sources used to build the Moveworks user profile. On update, include every source to keep; omitted sources are removed. 1 to 99 sources.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.
override_user_profile_mappingsmap from strings to stringsOptional

Mappings applied after all sources are merged, overriding user profile fields with values from other sources. On update, send the full map; omitted entries are removed.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error