đ Managing members' API keys is only available on Enterprise plans. To upgrade your plan, book a demo with our sales team.
Admins can see every API key their members own, and disable, enable, or delete any of those keys. Members create their own keys on the Developers page.
Who can manage members' API keys
Access to key management depends on your admin role. Workspace admin and organization admin roles are only available on Enterprise plans.
Workspace admins manage keys in that workspace from Workspace settings, in the API keys section.
Organization admins manage keys in every workspace of the organization from Organization settings, in the API keys section.
How do I find a member's API keys?
To find API keys in your workspace or organization:
Go to Workspace settings or Organization settings, and then select API keys.
To see the keys for one member, go to Users, select the ... menu next to the member, and then select View API keys.
The API keys list shows these columns:
Key: the key name and the last 4 characters of the key
Owner: the member who created the key
Workspace: the workspace that contains the key (Organization settings only)
Status: Active, Disabled, or Expired
Expires: the date the key expires
To see who disabled a key and when, select the Disabled status.
To narrow the list, filter by Owner, Workspace, Status, Scope, or Inherited.
âď¸ An owner marked Removed has left the workspace. Keys that belong to a removed owner are disabled. To learn more, check out What happens to API keys when a member is removed?.
How do I disable an API key?
When you disable an API key, requests that use the key stop working. To disable a key:
Go to API keys, select the ... menu next to the key, and then select Disable.
Enter a reason. The reason is optional and can be up to 200 characters.
Select Disable key.
After you disable a key:
Requests that use the key fail within 1 minute.
The owner receives an email with your name and the reason. Studio does not show the reason to the owner.
The owner or any admin can enable the key again.
Synthesia sends no email if the owner is deactivated or if you are the owner of the key.
How do I disable all of a member's API keys?
To disable every API key that belongs to one member:
Go to Users, select the ... menu next to the member, and then select Disable all API keys.
Enter one reason for all keys. The reason is optional.
Select Disable [n] keys.
Disable all API keys works differently depending on where you start:
In Workspace settings, the action covers the keys in that workspace.
In Organization settings, the action covers the keys in every workspace.
Synthesia skips keys that are already disabled, and those keys keep their original reason. The member receives one email that lists the disabled keys. Synthesia does not offer an "enable all" action, so enable each key one at a time.
How do I enable an API key?
To enable a disabled API key:
Go to API keys.
Select the ... menu next to the key.
Select Enable.
Synthesia enables the key without a confirmation step and does not send an email.
How do I delete an API key?
To delete an API key:
Go to API keys, select the ... menu next to the key, and then select Delete.
Select Delete key.
âď¸ Deleting an API key cannot be undone. Requests that use the key fail within 1 minute, and the owner receives an email with your name.
đŹ FAQs
Why is Enable unavailable for an API key?
Why is Enable unavailable for an API key?
Enable is unavailable for an API key when the key owner is deactivated or is no longer a member of the workspace. Ask a current member to create a new key.
Why do I see "This key cannot be enabled because its owner is on a restricted license"?
Why do I see "This key cannot be enabled because its owner is on a restricted license"?
Members on a restricted license cannot own API keys. Ask another member to create a new key.
Why do I see "This key cannot be enabled because the workspace plan no longer includes all of its scopes"?
Why do I see "This key cannot be enabled because the workspace plan no longer includes all of its scopes"?
An API key cannot be enabled when the workspace plan no longer includes all of the key's scopes. Create a new key with scopes that your plan includes.
Why do I see "This key cannot be enabled because it has expired"?
Why do I see "This key cannot be enabled because it has expired"?
An expired API key cannot be enabled. Create a new key.
Why do I see "This key cannot be enabled because its workspace is scheduled for deletion"?
Why do I see "This key cannot be enabled because its workspace is scheduled for deletion"?
An API key cannot be enabled when its workspace is scheduled for deletion.
Can the owner enable an API key that an admin disabled?
Can the owner enable an API key that an admin disabled?
Yes, the owner can enable a disabled API key from the Developers page, under the same conditions that apply to admins. To stop a key for good, delete the key.
What do integrations see when an admin disables an API key?
What do integrations see when an admin disables an API key?
An integration that uses a disabled API key receives the same error as an invalid key. The error does not say that an admin disabled the key.
How can I see who disabled, enabled, or deleted an API key?
How can I see who disabled, enabled, or deleted an API key?
To see who disabled, enabled, or deleted an API key, go to Organization settings and select Audit logs.
đ To learn more, check out Developers and How do I use the Synthesia API?.