API ReferenceService Accounts

Generate a Service Account Token

View as Markdown
Exchanges a service account API key for a short-lived access token. On success, the response contains an access token that can be used to authenticate downstream service-to-service requests on behalf of the service account. The token is a JWT that encodes the service account's identity and permissions, and is valid for 15 minutes. **Note:** - The API key must belong to a service account. API keys that belong to regular users aren't supported. - This endpoint authorizes the service account API through the `x-api-key` passed as a header. - This endpoint has a rate limit of 10 requests per 10 second window per user.

Authentication

x-api-keystring
API Key authentication via header
OR
Authorizationstring
A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Headers

x-api-keystringRequired
The service account API key, in PMAK format.

Response

Token Created
access_tokenstring

The JWT access token to use to authenticate downstream service-to-service requests.

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error