Skip to navigation

Identity Bot Account (Assistant Account)

View as Markdown

platform.identity.assistant-account

The Moveworks assistant’s service account. Each itsm_id_info entry enables Built-In Ticketing for that connector.

  • Endpoint: /platform/identity/assistant-account | 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/assistant-accountGet assistant account
PATCH/platform/identity/assistant-accountUpdate assistant account

Fields

FieldTypeRequiredNotes
email_addrstringEmail address of the bot service account in your primary identity system.
record_idstringValue that identifies the bot account across your systems, typically its email address. Must match your organization’s joining key.
full_namestringFull name of the bot service account.
itsm_id_infoarray<ITSMIdInfo>Identities of the bot account in each connected ITSM system. Each entry enables built-in ticketing for that system.
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.

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.

{
"email_addr": "user@example.com",
"record_id": "<id>",
"full_name": "example-name",
"itsm_id_info": [
{
"itsm_user_id": "<id>",
"external_id": "<external-id>",
"first_name": "example-name",
"last_name": "example-name",
"full_name": "example-name",
"connector_id": "<connector-uuid>",
"item_ref": "<string>"
}
]
}