Skip to navigation

Identity Ingestion (Integration)

View as Markdown

platform.identity.integration

Identity ingestion: the sources (connectors) the Moveworks user profile is built from — primary source, per-source joining key/universal id, attribute-mapping benders, filters, and merge overrides.

  • Endpoint: /platform/identity/integration | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/platform/identity/integrationGet identity ingestion
PATCH/platform/identity/integrationUpdate identity ingestion

Fields

FieldTypeRequiredNotes
sourcesarray<Source>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_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.
override_user_profile_mappingsobjectMappings 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.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"sources": [
{
"connector_id": "<connector-uuid>",
"primary": true,
"processors": [
{
"item_ref": "<string>",
"user_timezone_processor": {
"...": "see UserTimezoneProcessor"
}
}
],
"filters": [
{
"item_ref": "<string>",
"generic_filter": {}
}
],
"item_ref": "<string>",
"joining_key": "<string>",
"user_profile_mappings": {}
}
],
"override_user_profile_mappings": {}
}