WitnessAI Documentation
List
Start Here
Start Here
Analytics
Analytics
Conversations
Conversations
Users
Users
Alerts
Alerts
Policy
Policy
Administration
Administration
Apps & Resources
Apps & Resources
Release Notes
Release Notes
Administrator Guide
Administrator Guide
API Keys
Use API Keys, under Administration > Configuration > API Keys, to create named keys with an expiration date that authenticate calls to the WitnessAI API. The Admin role and the roles above it can create and delete keys.
To create a key:
- Give it a Key Name.
- Choose an Expiration Date. The earliest date you can pick is tomorrow.
- Click the Generate user key button. It stays disabled until both Key Name and Expiration Date are set.
- Click the Copy icon. The API key will be copied to your system clipboard, and the following dialog will display.
- Immediately save the key in a safe location, like a secrets manager or a password manager. After you navigate away from the API Keys page, you will not be able to access or copy any API keys again.
- Super Admin users can copy any active or expired API key by clicking the copy icon in the API key’s “Actions” column.
Only users with Super Admin role are able to access API keys after they have been created and the page is exited.
View and manage keys
The table lists your keys, sorted by expiration date, soonest first.
Column | What it shows |
API Key Name | The key name you entered. |
Expiration | The expiration date, or an Expired label when the date has passed. |
Actions | Delete the key. The copy icon appears for a key you just created, and for any key when you have the Super Admin role. |
Delete a key
- In the Actions column, click the delete icon for the key.
- Confirm when asked Are you sure you want to delete this key?
The key is removed from the API Keys list.
For how to use a key, see the API Reference.
Made with Bullet