Administrator
API tokens are unique identifiers that allow third-party services to securely communicate with an application or system. API tokens are used frequently in integration scenarios where you need to establish communication between the Staffbase platform and third-party applications or systems. You can create API tokens in the Studio for third-party services to establish communication with the Staffbase platform. You can then use the tokens to request access to the Staffbase platform. You can create API tokens with different levels of access permissions.
You can create an API token by specifying the required access level. In addition, you can define specific Internet Protocol (IP) addresses or Classless Inter Domain Routing (CIDR) ranges that are allowed to use the API token. This setting allows you to restrict token exposure and reduce the risk of unauthorized use.
- In the Studio, navigate to open Settings > API Access.
- Click Create API token.
The API Tokens page opens. - Click Create API token.
The Create API token dialog opens. - In the Token Name field, provide a name.
-
Select an access level.
The level of access required for the API depends on the business use case. For example, Restricted Read-only access is sufficient for RSS feeds, whereas advanced integrations require Administrative access. - Optionally, expand Advanced to define allowed IP ranges.
- In the Allowed IP Ranges field, enter IP addresses or CIDR ranges that are permitted to use this token.
- Click Create.
The created token secret appears. -
Click Copy to copy the token secret.
The token secret is shown only once. If you navigate away before copying it, you cannot retrieve it again.
- Click OK.
You have successfully created and stored an API token. If you lose the token secret, you need to rotate the token or create a new token.
Comments
0 comments
Please sign in to leave a comment.