Edit API Key
You can edit an API key you have already created. The following attributes of an API key can be changed:
Attribute | Description | Edit |
---|---|---|
API Key Name | The user assigned name of the API key. | ✅ |
Description | An optional description about the key. | ✅ |
Expiration Date | The expiration date of the key. | ✅ |
Value | The API key value. | ❌ |
Tenant administrators can edit an API key on behalf of any user within the tenant. Select the Tenant tab below to learn more about editing an API key as a tenant admin.
Tenant administrators can only edit the API key name, description, and expiration date. The API key value and the assigned user cannot be edited.
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.
Edit API Key
- 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 Edit.
Make the necessary changes to the API key attributes and click Save.
- 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 Edit.
- Make the necessary changes to the API key attributes and click Save.
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 changes you made to the API key attributes are reflected in the table, including API key name, description, and expiration date.
- 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 altered API key in the table.
- Verify the changes you made to the API key attributes are reflected in the table, including the API key name, description, and expiration date.