Skip to navigation

Identity Service Accounts

View as Markdown

platform.identity.service-accounts

Manually-defined service/admin accounts (user-profile fields + per-system ITSM/IDM/channel identities).

  • Endpoint: /platform/identity/service-accounts | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • 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/service-accountsList service accounts
POST/platform/identity/service-accountsCreate service account
GET/platform/identity/service-accounts/{id}Get service account
PATCH/platform/identity/service-accounts/{id}Update service account

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of the service account, assigned by the server.
email_addrstringEmail address of the user in your primary identity system.
record_idstring✅Value that identifies this user across your systems, typically the email address. Must match your organization’s joining key and be unique across service accounts. Required on create.
full_namestringFull name of the user.
user_namestringUsername of the user.
first_namestringFirst name of the user.
last_namestringLast name of the user.
rolestringRole or job title of the user.
manager_email_addrstringEmail address of the user’s manager.
departmentstringDepartment of the user.
locationstringLocation of the user.
country_codestringCountry code of the user.
citystringCity of the user.
regionstringRegion of the user.
divisionstringDivision of the user.
timezonestringTimezone of the user.
employee_idstringEmployee ID of the user.
cost_center_namestringCost center name of the user.
work_statusstringEmployment classification of the user. One of: CONTINGENT, INTERN, FULL_TIME.
additional_email_addrsarray<string>Additional email addresses that identify this user.
channel_id_infoarray<ChannelIdInfo>Identities of the user in each connected chat system.
itsm_id_infoarray<ITSMIdInfo>Identities of the user in each connected ITSM system. Each entry enables built-in ticketing for that system.
idm_id_infoarray<IDMIdInfo>Identities of the user in each connected identity management system. Each entry enables access requests for that system.
tagsarray<enum>Moveworks user tags assigned to the user, e.g. VIP, IT_AGENT, TESTER or SERVICE_ACCOUNT. One of: BASIC_USER, VIP, FIELD_AGENT, KNOWLEDGE_WORKER, IT_AGENT, TESTER, SUPPORTED_LANGUAGE_USER, SERVICE_ACCOUNT, … (16 values).
custom_attributesobjectCustom attributes attached to the user. Replaced as a whole on update.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Example create body

{
"email_addr": "user@example.com",
"record_id": "<id>",
"full_name": "example-name",
"user_name": "example-name",
"first_name": "example-name",
"last_name": "example-name",
"role": "<string>",
"manager_email_addr": "user@example.com",
"department": "<string>",
"version": {
"change_description": "Create service account"
}
}