Skip to main content
An API token authenticates requests to the Nuon Control Plane API. Use one to call the API, drive the CLI in CI/CD, or integrate Nuon into your own product.

​
Token types

  • Service account token — the supported kind of API token. The token belongs to a service account and acts as that account, with the account’s role, in the current org only. Create a service account with the role you want, then create one or more tokens for it.
  • Personal token (legacy, deprecated) — a token issued against a person’s own account. Personal tokens are deprecated because they carry all of their creator’s access, in every org that person belongs to. Existing personal tokens keep working until they are revoked; org admins can find and revoke them in the dashboard under Settings → API tokens, in the legacy personal tokens section.

​
Token properties

A token’s permissions come from its service account’s role. See Access control for the available roles. Creating and managing API tokens requires org admin access.

​
Managing tokens

In the dashboard, go to Settings → API tokens to see and revoke the tokens in the org. In the CLI, tokens are managed through service accounts. A token’s access comes from the account it belongs to, so you create a service account with the role you want, then create tokens for it.

​
Creating a token

Create a service account with a role, then create a token for it:
Tokens expire after one year by default. Use --duration to change that:
Tokens are shown only once at creation time. Store the value somewhere safe (a secret manager or CI secret); you cannot retrieve it again later.

​
Listing tokens

List every service account token in the org:
Only list the tokens for one service account:
Search tokens by name or ID:
Token secrets are never returned.

​
Revoking tokens

Delete a token to revoke its access immediately:
The nuon orgs api-tokens commands are deprecated. They still work, but print a warning pointing to the commands above.

​
Using a token

To use a token, include it in API requests as a Bearer credential in the Authorization header:
You can also use a token with the CLI by setting it as the value of the NUON_API_TOKEN environment variable or the api_token config value.