Revoke API Key
You can revoke an API key you created in Palette. A tenant admin can also revoke an API key created by another user within the tenant. A revoked API key cannot be used to authenticate API requests and requires a re-activation to be used again.
Tenant administrators can revoke an API key in the tenant. Select the Tenant tab below to learn more about revoking an API key as a tenant admin.
Use the steps outlined below for the workflow you want to perform:
Revoke API Key
Use the following steps to revoke an API key.
Prerequisites
- User
- Tenant
-
You must have a Palette account, and you must be logged in.
-
An existing API key.
-
You must have a Palette account, and you must be logged in.
-
An existing API key.
-
Tenant administrator access.
Revoke
- User
- Tenant
-
Log in to Palette.
-
Navigate to the User Menu, and select My API Keys.
-
Identify your API key in the table, and click on the three-dot Menu.
-
Click on Revoke.
-
Log in to Palette as a tenant admin.
-
Switch to the Tenant Admin scope.
-
Navigate to the left Main Menu and select Tenant Settings.
-
From the Tenant Settings Menu, select API Keys.
-
Identify your API key in the table, and click on the three-dot Menu.
-
Click on Revoke.
Validate
- User
- Tenant
-
Log in to Palette.
-
Navigate to the User Menu, and select My API Keys.
-
Identify your API key in the table.
-
Verify the Active column in the table is set to Inactive for your API key.
-
Log in to Palette as a tenant admin.
-
Switch to the Tenant Admin scope.
-
Navigate to the left Main Menu and select Tenant Settings.
-
From the Tenant Settings Menu, select API Keys.
-
Verify the Active column in the table is set to Inactive for the API key you revoked.
Reactivate API Key
Use the following steps to reactivate an API key that has been revoked.
Prerequisites
- User
- Tenant
-
You must have a Palette account, and you must be logged in.
-
An existing API key.
-
You must have a Palette account, and you must be logged in.
-
An existing API key.
-
Tenant administrator access.
Activate
- User
- Tenant
-
Log in to Palette.
-
Navigate to the User Menu, and select My API Keys.
-
Identify your API key in the table, and click on the three-dot Menu.
-
Click on Re-activate.
-
Log in to Palette as a tenant admin.
-
Switch to the Tenant Admin scope.
-
Navigate to the left Main Menu and select Tenant Settings.
-
From the Tenant Settings Menu, select API Keys.
-
Identify the API key in the table you want to activate, and click on the three-dot Menu.
-
Click on Re-activate.
Validate
- User
- Tenant
-
Log in to Palette.
-
Navigate to the User Menu, and select My API Keys.
-
Identify your API key in the table.
-
Verify the Active column in the table is set to Active for your API key.
-
Log in to Palette as a tenant admin.
-
Switch to the Tenant Admin scope.
-
Navigate to the left Main Menu and select Tenant Settings.
-
From the Tenant Settings Menu, select API Keys.
-
Verify the Active column in the table is set to Active for the API key you re-activated.