Skip to main content

API keys

This tab displays a list of API keys that have been created for the tenant. You can use API keys to make requests to the CentralAuth API from an external system. Check the API docs for more information. An API key created under a tenant can be used for this tenant and all organizations under this tenant.

caution

Please ensure that you keep your API keys secure. Treat them like a password and do not share them with anyone outside your team.

Creating an API key

To create an API key, click on the Add API key button. You will be prompted to enter a name for the API key. Once you have entered a name, click on the Save button. A popup is displayed with the created API key. You can copy the API key by clicking on the clipboard icon.

note

You can only view the API key once. If you lose the API key, you will need to create a new one.

Renaming an API key

To rename an API key, click on the pencil icon next to the API key you want to rename. You will be prompted to enter a new name for the API key. Once you have entered a new name, click on the Save button.

Deleting an API key

To delete an API key, click on the trash icon next to the API key you want to delete. You will be prompted to confirm the deletion. Click on the Delete button to confirm the deletion.