API keys
API keys
Create and manage secret credentials for scripts and tools that connect to Verentis.
An API key is a secret credential that lets a script or tool connect to Verentis without a person signing in.
A credential is proof that something is allowed to connect. Treat an API key secret like a password.
Learn how API keys fit with other identity types in Identities.
Keep the secret safe
Store the API key secret somewhere safe. It is typically shown only once.
Set an expiry
An expiry is the date when the key stops working. Setting one helps limit risk if a key is forgotten or exposed.
API key list
The API Keys screen lists each key's name, status, and expiry.
Status tells you whether the key can currently be used. Expiry tells you when the key stops working.
API key detail
Open a key to see its name, expiry, and grants.
A grant means giving a role or permission to an identity. From the key detail page, you can:
- edit the name or expiry
- revoke the key
- regenerate the key
- view grants
- revoke grants
Create an API key
Open API Keys
In the Account app, select API Keys in the left sidebar.
Start creating a key
Select the action to create a new API key.
Add the key details
Enter a name. Set an expiry if the screen asks for one or offers one.
Choose access
Add only the permissions the script or tool needs.
Save and copy the secret
Create the key, then copy the secret and store it safely.
Revoke a key
Revoking a key stops it from being used.
Open API Keys
In the Account app, select API Keys in the left sidebar.
Choose the key
Open the key you want to stop using.
Revoke the key
Select the revoke action, then confirm if Verentis asks you to confirm.