Skip to navigation
REST APIAuthentication and AuthorizationService Accounts

Create a service account.

View as Markdown
Used to create a service account.

Authentication

AuthorizationBearer
Bearer authentication

Request

Service account object to create
namestringRequiredformat: "^[a-z][-_a-z0-9]*[a-z0-9]$"2-255 characters
The name of the service account. The name must be unique within the organization and can only contain lowercase alphanumeric characters and hyphens. It must start and end with a letter.

Response

Executed successfully.
idstring
The unique identifier of the service account.
namestring
The name of the service account.
clientSecretstring
Secret credential paired with the client ID. Used to obtain authentication tokens. Displayed only once upon creation.
clientIdstringOptional
The client identifier associated with the service account. Used when requesting authentication tokens.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error