API Keys

About this article

In this article, we will explain what API Keys tab is in the Account section and how to use it. 

• What is the API Keys tab? 
• How to create a key? 
• How to add scopes to a key?
• How to delete scopes from a key?
• How to regenerate a key? 
• How to revoke a key? 

 

Prerequisites

Admin or owner access in Templafy tenant Public API module enabled

 

What is the API Keys tab? 

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:

• SCIM
  • scim

Reference: How to set up SCIM

• Templafy API
  • library.read
  • library.readwrite
  • library.generate
  • datasources.read
  • datasources.readwrite
  • spaces.read

Reference: What is the Templafy Public API?

 

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

 

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

 

How to add scopes to a key?

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

 

Adding a scope doesn't require the generation of the key

 

How to remove scopes from a key?

1. In the API Keys tab, select the key you would like to edit 
2. Navigate to the Scopes tab 
3. Unselect the scope
4. Click Save

 

Deleting a scope doesn't require the generation of the key

 

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

 

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

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 articles

How to set up SCIM What is the Templafy Public API? How to activate and deactivate modules