API tokens allow third-party services to establish communication with the Staffbase platform. It is a good practice to audit the API tokens and disable or delete the ones you no longer require.
Editing an API Token
You can edit an API token to change its name, access level, or allowed IP ranges.
- In the Studio, navigate to Settings > API Access.
The API Tokens page opens. - Under Actions, click the three dots next to the API token you want to edit to open the action menu. The action menu opens.
- Click Edit.
- Edit the API token details.
- Click Save.
You have edited the API token. You can edit it again anytime.
Rotating an API Token
You can rotate an API token to generate a new secret while keeping the same token ID and permissions. This is useful if you suspect the token has been exposed or as part of regular security practices.
- In the Studio, navigate to Settings > API Access.
The API Tokens page opens. - Under Actions, click the three dots next to the API token you want to rotate to open the action menu. The action menu opens.
- Click Rotate.
The confirmation dialog opens. - Click Rotate.
The new token displays in the API Tokens overview.
Click the copy icon to copy and securely store the new secret. You have rotated the API token. The token continues to work with the same permissions, but now requires the new secret for all integrations. Update all integrations that use this API token with the new secret.
Enabling an API Token
You can re-enable an API token that you previously disabled.
- In the Studio, navigate to Settings > API Access.
The API Tokens page opens. - Under Actions, click the three dots to open the action menu.
The action menu opens. - Click Enable.
The confirmation dialog opens. - Click Enable.
You have re-enabled the API token. Now, the API token can be used for integrations.
Deleting an API Token
You can permanently delete an API token from the platform.
- In the Studio, navigate to Settings > API Access.
The API Tokens page opens. - Under Actions, click the three dots to open the action menu.
The action menu opens. - Click Delete.
The confirmation dialog opens. - Click Delete.
You have permanently deleted the API token.
Comments
0 comments
Please sign in to leave a comment.