Skip to navigation

Get assistant account

View as Markdown

Returns your organization’s assistant account. There is one per organization, so there is no id.

Authentication

AuthorizationBearer

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

Response

Your organization's assistant account
email_addrstringOptional
Email address of the bot service account in your primary identity system.
record_idstringOptional>=1 character
Value that identifies the bot account across your systems, typically its email address. Must match your organization's joining key.
full_namestringOptional
Full name of the bot service account.
itsm_id_infolist of objectsOptional

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

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

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error