Articles in this section

API Keys

Updated

This article explains the API Keys tab accessible from the Admin Center.

  Prerequisites

Overview 

The API Keys tab will allow you to create the necessary tokens containing the necessary scopes and permissions to interact with SCIM or Templafy API. The following scopes will be available:

How to create a key

  1. In the API Keys tab, click Create key
  2. Provide a name to the key
  3. Click Next  
  4. Select the desired scopes
  5. Click Create
  6. Click Copy key

CreateKey.gif

  Note

  • Keys are unique and non-recoverable. If you lose a key, you will have to regenerate a new one.
  • The name of a key cannot be edited after its creation.

How to edit scope of a key

  1. In the API Keys tab, select the key you would like to edit
  2. Navigate to the Scopes tab
  3. Select/unselect the desired scope from the list
  4. Click Save

AddScope.gif

How to regenerate a key

  1. In the API Keys tab, select the key you would like to edit 
  2. Click on the ellipsis menu
  3. Click Regenerate key
  4. Click Confirm
  5. Click Copy key

 Note

Regenerating a key will invalidate the current one.

How to revoke a key

  1. In the API Keys tab, select the key you would like to edit
  2. Click Revoke key
  3. Click Confirm

 Note

  • You can see the revoked key by toggling on Show revoked keys.
  • Regenerating a revoked key will reactivate it. 
  • Once a key has been revoked, it can be deleted.

Related to

administration admin_role
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.