Token types
A token has the form
ms_<prefix>_<secret>, and a RUM client token msrum_…. The prefix finds the
token, and only a hash of the secret is stored. Send a token as a bearer credential, like a login
session:
_sys organization.
Create an API token
- Open API tokens and select Create API token.
- Enter a Name, for example
collector-production. - Choose the Principal: Current user, or a service account.
- Choose the Role. A token of a service account inherits the role of the account. A personal token takes Default intake (write only) or an organization role. The role cannot hold a permission that the creator lacks.
- Set Expires in days: 365 by default, at most 1825. Leave it empty for a token that never expires.
- Select Create token, then Copy token. The token is shown only this once.
api_tokens.read, and creating or revoking them requires
api_tokens.manage.
Service accounts
Use a service account for a collector, a CI pipeline, an integration, or an AI agent that runs without a person. Then a member leaving the workspace never breaks the automation.- Open Service accounts and select Create service account.
- Enter a Name, for example
deployment-automation, a Description, and a Role. - Select Create account and token, and copy the initial API token. It expires in 365 days and is shown only once.
The Principal ID of the account identifies it in audit records and access grants. Reading service
accounts requires
service_accounts.read, and changing them requires service_accounts.manage.
Choose a token
A login session expires after 24 hours by default (
[auth].token_ttl_secs), so never give one to a
sender that runs continuously.
Tokens API
See Issue an API token, List API tokens, and
Revoke an API token.