Skip to main content

Create your first API key

Use this guide after you can already sign in to Tarnished in the browser.

What API keys are for​

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

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

Create the key in Tarnished​

  1. Sign in to Tarnished.
  2. Open Settings.
  3. Open the API Keys section.
  4. Create a new API key.
  5. Choose the preset that matches the client you plan to use.
  6. Copy the raw key value immediately.

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

Choose the right preset​

Use:

  • CLI for the Tarnished CLI
  • extension for the browser extension
  • read only for narrow reporting-style integrations
  • import/export for focused data portability workflows

Verify the key with the CLI​

If you are using the Tarnished CLI:

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

Use the key with the browser extension​

Open the extension settings and enter:

  • the Tarnished app URL
  • the API key you just created

Next steps​