1. Docs
  2. Keys & Credentials
  3. Create and manage publishable keys

Create and manage publishable keys

Create a web or native publishable key in the Developer Console, rename it, and revoke it.

Create a publishable key

In the Developer Console, Access Control → Integrations → Publishable Keys lists the Environment's keys, each tagged WEB or NATIVE, with an overview donut split by type. A publishable key identifies your application to the Direct API from a browser or a native app; it is not a secret.

Application
Developer Console
Path
Access ControlIntegrationsPublishable Keys
Opens with
  • publishable_keys.view Read the Environment's publishable keys.
Context
Select an Application and an Environment in the switcher first; the page belongs to that Environment.
Create a publishable key
Open Publishable Keys from the left nav under Access Control → Integrations and click Create Key. The Create publishable key dialog opens.Name the key and choose its type: Web for a browser, or Native for a mobile or desktop app. The hint under the type explains how each returns tokens.Confirm. A toast confirms it, the key appears in the list with its tag, and the donut count updates.

Rename or revoke a key

A key's name is for you; its value never changes. Revoking is permanent.

Rename or revoke a key
Click a key's row. The Rename key dialog opens with the name pre-filled; Save Changes enables once the name differs. Save, and a toast confirms it.To revoke, use Revoke on the row. The Revoke key dialog asks you to type the key's name before it enables for a native key. Confirm; a toast confirms it and the row disappears.The Environment's last WEB key cannot be revoked: the dialog refuses inside itself, explaining that it is the Environment's last web key, and the key stays listed. Create a replacement first.
If you don't see this

Each control on the Publishable Keys page exists only for someone who may use it. When something described above is missing, one of these is why:

Publishable Keys is not under Integrations. Either no Application and Environment is selected yet, or your administrator role does not carry publishable_keys.view.There is no Create Key, and rows offer no rename or Revoke. You hold publishable_keys.view but not publishable_keys.manage.Revoke refuses. That is the Environment's last web key. The Direct API and hosted login in that Environment need one.
Which credential each integration path uses →
Environment
API version
v1.0
 On this page Was this page helpful?

Tell us how we can improve this guide.

Canopy