Skip to main content
4 min read

Personal Access Tokens

Personal Access Tokens

Tokens let external tools and scripts authenticate as you via the API. Keep them secret and treat them like passwords.

Open the profile avatar menu, then click Personal Access Tokens. You can also open the page from workspace settings when that route is enabled for your tenant.

Available for roles: Admin Workspace Admin Workspace User

Scope:

Catalog

The page lists tokens you already created. Each row shows metadata such as name and dates. The secret itself is never shown again after you close the reveal step.

Generate a new token

  1. Click Generate new token.
  2. Dialog title: Generate new token.
  3. Fill the form:
FieldRequiredExample
Token nameYesdocs-capture-ci-pipeline (placeholder: CI pipeline token)
ExpirationYes30 days (options: 1 day, 7 days, 30 days, 60 days, 90 days, 180 days, 1 year, or Custom)
DescriptionYesDocs capture token for CI examples.
  1. Enter a recognizable Token name.
  2. Choose an Expiration preset (or Custom for a specific date).
  3. Enter a Description of what the token is for.
  4. Click Generate token to create it, or Cancel / Close to discard.

Copy the secret once

After generation, a reveal step shows the token secret.

  1. Copy the token immediately and store it in a secure secret store.
  2. Confirm you have copied it (for example I've copied the token) before closing.
  3. You cannot view the secret again later. If you lose it, regenerate or create a new token.
tip

Keep tokens secret. Do not commit them to source control or share them in chat.

Manage an existing token

From the row Actions menu:

ActionWhat it does
RegenerateIssues a new secret for the same token. The old secret stops working. Copy the new value from the reveal step.
DeleteRemoves the token permanently. Scripts using it fail until you create a replacement.

Use short-lived tokens for CI when you can, and delete tokens you no longer need.