ReferencePassport API

Authenticate with the Passport API

Every request to the Passport API must include an organization API key. This page covers how to create, use, and revoke one.

Create an API key

In the Passport header, click Org Settings, then select API keys. This is where you create and revoke organization API keys for programmatic access to Passport.

To create a key, do the following:

  1. Click Org Settings.
  2. Select API keys.
  3. Click Create API key.
  4. Enter a name.
  5. Click Create key.

The key is only shown once. We recommend storing it in your organization’s secret store.

Click Show to display the key, and Copy key to copy it to your clipboard.

View your API keys

The API keys tab lists each key’s name, a partial view of the key, its creation date, its last used date, and the actions available for it.

Revoke an API key

In the Passport header, click Org Settings, then select API keys.

To revoke a key, do the following:

  1. Click Org Settings.
  2. Select API keys.
  3. In the Actions column for the key, click Revoke.
  4. Click Revoke key to confirm.