Your API key authenticates your integration with Incode's APIs and is associated with your account. This tab shows a table with information about the API keys used in your Incode implementation. You cannot change any of the information, but you can:
- Generate new keys
- Copy existing keys
- Revoke existing keys
| Field | Description |
|---|---|
| Name | The name Incode assigned to the API key. If the key is active, a green dot appears. If the key has been revoked, a gray dot appears. |
| Client ID | The unique ID of the client the API key belongs to. |
| API Key | The API key value. |
| Last Updated | This field updates only when a key is revoked. If the key is still active, the field shows the same value as Time Created. |
| Time Created | The date and time the key was originally created. |
Generate a New API Key
- In the left menu, click Configuration.
- Click the API Keys tab.
- Click Generate New API Key in the lower right corner of the page.
A notification appears to confirm the API key is being generated. After it's generated, the new key appears at the top of the API keys table.
Copy an Existing API Key
- In the left menu, click Configuration.
- Click the API Keys tab.
- Find the key you want to copy and click Copy in the API Key column for that key.
Revoke an Existing API Key
Warning
This action cannot be undone.
- In the left menu, click Configuration.
- Click the API Keys tab.
- Find the key you want to revoke and click Revoke in the Name column for that key.
API Key Security
Treat your API key like any other credential. Store it securely and keep it server-side instead of client-side or in front-end code. Avoid sharing it in tickets, emails, images, or public repositories. If a key may have been exposed, generate a new key and revoke the affected one.