Skip to main content

Configure API keys

Use this guide to create Tarnished API keys for machine clients.

What API keys are for​

Tarnished API keys are the supported auth model for machine clients such as:

  • the Tarnished CLI
  • the browser extension
  • other automation or integration clients

Create an API key in the web app​

  1. Sign in to Tarnished in the browser.
  2. Open Settings.
  3. Open the API Keys section.
  4. Create a new key.
  5. Copy the raw key value immediately.

You will not get the raw key value back later from the server.

Choose the right preset​

The backend currently supports preset families including:

  • full access
  • CLI
  • extension
  • read only
  • import/export
  • custom
  • use CLI for the Tarnished CLI
  • use extension for the browser extension
  • use read only for dashboards or reporting-style integrations
  • use import/export for narrow data portability workflows

Use the key with the CLI​

tarnished auth init --api-key 'your-api-key'
tarnished auth doctor
tarnished auth whoami

Use the key with the extension​

  1. Open the extension settings page.
  2. Enter the Tarnished app URL.
  3. Enter the API key.
  4. Save the settings.

Rotate or revoke keys​

Because the web app is the source of truth for API key lifecycle, rotate or revoke keys there rather than expecting the CLI or extension to do it remotely.