API Keys

To create an API Key

Creating a Tenant API Key

Create and manage Tenant API Keys for access to your Tenant within the Contextual.io tenant workspace.

Steps to create a new Tenant API Key:

1. Navigate to the API Keys Page

   • Go to the Tenant API > API Keys page in your Contextual tenant workspace.

2. Create a New API Key

   • Click the "+" icon in the upper right corner of the data grid.

3. Enter a Name

   • API Key Name: Provide a friendly name for your API Key. This name will be displayed in various tables and lists.

   • Format: The name should consist of lowercase letters, numbers, and dashes, and can be up to 256 characters long.

   • Note: You can change this name at any time.

4. Enter a Description

   • API Key Description: Provide a description for your API Key to help identify its purpose.

   • Format: The description can include letters, numbers, spaces, dashes, and most special characters.

   • Note: The description can be modified at any time.

5. Save Your API Key

   • Once you have entered the required information, click the Create button to generate the API Key.

Notes

• Security: Handle your Client Secret with care. Consider a process to rotate it periodically to maintain security.

• Permissions: Review and adjust permissions regularly to ensure they align with your security policies and usage needs.