Skip to navigation

Update service account

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. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The id of the service account, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
email_addrstringOptional
Email address of the user in your primary identity system.
record_idstringOptional>=1 character
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_namestringOptional
Full name of the user.
user_namestringOptional
Username of the user.
first_namestringOptional
First name of the user.
last_namestringOptional
Last name of the user.
rolestringOptional
Role or job title of the user.
manager_email_addrstringOptional
Email address of the user's manager.
departmentstringOptional
Department of the user.
locationstringOptional
Location of the user.
country_codestringOptional
Country code of the user.
citystringOptional
City of the user.
regionstringOptional
Region of the user.
divisionstringOptional
Division of the user.
timezonestringOptional
Timezone of the user.
employee_idstringOptional
Employee ID of the user.
cost_center_namestringOptional
Cost center name of the user.
work_statusstringOptional

Employment classification of the user. One of: CONTINGENT, INTERN, FULL_TIME.

additional_email_addrslist of stringsOptional
Additional email addresses that identify this user.
channel_id_infolist of objectsOptional
Identities of the user in each connected chat system.
itsm_id_infolist of objectsOptional

Identities of the user in each connected ITSM system. Each entry enables built-in ticketing for that system.

idm_id_infolist of objectsOptional
Identities of the user in each connected identity management system. Each entry enables access requests for that system.
tagslist of enumsOptional

Moveworks user tags assigned to the user, e.g. VIP, IT_AGENT, TESTER or SERVICE_ACCOUNT.

custom_attributesobjectOptional
Custom attributes attached to the user. Replaced as a whole on update.

Response

The updated service account, at its new version
idstringOptionalRead-only
Unique identifier of the service account, assigned by the server.
email_addrstringOptional
Email address of the user in your primary identity system.
record_idstringOptional>=1 character
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_namestringOptional
Full name of the user.
user_namestringOptional
Username of the user.
first_namestringOptional
First name of the user.
last_namestringOptional
Last name of the user.
rolestringOptional
Role or job title of the user.
manager_email_addrstringOptional
Email address of the user's manager.
departmentstringOptional
Department of the user.
locationstringOptional
Location of the user.
country_codestringOptional
Country code of the user.
citystringOptional
City of the user.
regionstringOptional
Region of the user.
divisionstringOptional
Division of the user.
timezonestringOptional
Timezone of the user.
employee_idstringOptional
Employee ID of the user.
cost_center_namestringOptional
Cost center name of the user.
work_statusstringOptional

Employment classification of the user. One of: CONTINGENT, INTERN, FULL_TIME.

additional_email_addrslist of stringsOptional
Additional email addresses that identify this user.
channel_id_infolist of objectsOptional
Identities of the user in each connected chat system.
itsm_id_infolist of objectsOptional

Identities of the user in each connected ITSM system. Each entry enables built-in ticketing for that system.

idm_id_infolist of objectsOptional
Identities of the user in each connected identity management system. Each entry enables access requests for that system.
tagslist of enumsOptional

Moveworks user tags assigned to the user, e.g. VIP, IT_AGENT, TESTER or SERVICE_ACCOUNT.

custom_attributesobjectOptional
Custom attributes attached to the user. Replaced as a whole on update.
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.

Errors

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