Personal API access tokens
Read time: 2 minutes
Last edited: Apr 27, 2020
This topic explains how to use personal API access tokens to authenticate with the LaunchDarkly REST API, as well as constraints and suggestions for implementing them.
You can scope your personal API tokens to restrict the set of operations they can perform. For example, you can build an integration that only has read access to the REST API.
The available scoping options are:
- Built-in roles: Gives a token the same permissions as a
- Custom roles: Gives a token the same permissions as one of your team's existing custom roles. This option is only available if your LaunchDarkly plan includes custom roles.
- In-line custom roles: Gives a token a custom set of permissions in-line, rather than specifying it as an existing custom role. This option is only available if your LaunchDarkly plan includes custom roles.
When you create a new token, it has the same permissions that you do. Your tokens can never do more than you can in LaunchDarkly.
As a best practice, we recommend giving your tokens the smallest scope required for your integration. For example, if your integration is not designed to modify your Production environment, use a custom role or inline policy to restrict access appropriately.
If your own permissions are ever reduced, tokens you have created have reduced scope as well.
For example, if you are a Writer and create a Writer token, but then are downgraded to a Reader, your Writer token will behave like a Reader token.
You can create a personal API access token from the Account settings page.
To create a personal access token:
- Navigate to the Account settings page.
- Click into the Access tokens tab.
- Click + token. The Create an access token screen appears.
- Give your token a human-readable Name.
- Assign a Role to the token by choosing one from the dropdown.
- Click Save Token. The new token appears in the Access tokens page.
- Copy and save the token somewhere secure. After you leave this page, the token will be obscured.
After you create a token, you can Clone or Delete it from the "Access tokens" screen.
- Clone: Clones the access token. This allows you to create multiple access tokens with the same set of permissions, rather than having to fill out each token's information in the "Create an access token" screen.
- Delete: Deletes the access token. If you delete a token, API calls made with that token return
401 Unauthorizedstatus codes.
You can also manage existing tokens from the Authorizations tab. From that tab, you can change the scope of your tokens or delete them.
By default, all team members can create access tokens limited to their existing permissions. Team members with
reader level permissions can only create tokens with
reader permissions, whereas admins and owners can create tokens with any permission level.
You can restrict team members from creating or managing access tokens with custom roles.
To learn more, read Actions in custom roles.