mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
2cd5028125
* refactor how-to guide for creating a token * fix token links * update SDK reference * beginning of direct api guide * refactored frontend api guide * lint staged breaking notes * update docs - cors for frontend * update token guide images * update after review * Apply suggestions from code review `website/docs/user_guide/token.mdx` Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Apply suggestions from code review `website/docs/topics/frontend-api.md` Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Apply suggestions from code review Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Apply suggestions from code review Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * pr review * docs: Add info about front-end tokens + formatting * docs: add info about token anatomy * docs: link to correct place in doc * docs: replace "direct access API" -> "front-end API" * docs: rename file frontend-api -> front-end-api Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
39 lines
1.9 KiB
Plaintext
39 lines
1.9 KiB
Plaintext
---
|
|
id: api-token
|
|
title: How to create API Tokens
|
|
---
|
|
|
|
import newTokenImage from '/img/admin_create_token_form.png';
|
|
|
|
::: info Permissions
|
|
|
|
Creating API tokens requires you to have the `CREATE_API_TOKEN` permission. This means that, as of now, **only instance admins can create API tokens.**
|
|
|
|
All users can see tokens with `CLIENT` level access, but only instance admins can see tokens with `ADMIN` level access.
|
|
|
|
:::
|
|
|
|
Unleash SDKs use API tokens to authenticate to the Unleash API. Unleash supports different types of API tokens, each with different levels of access and privileges. Refer to the [API tokens and client keys](../reference/api-tokens-and-client-keys.mdx) article for complete overview of the different token types.
|
|
|
|
## Step 1: Navigate to the API token creation form {#step-1}
|
|
|
|
Navigate to the _API access_ page in the admin UI (available at the URL `/admin/api`). Use the navigation menu item "Configure" and select "API access".
|
|
|
|
|
|
|
|
On the API access page, use the "New API token" button to navigate to the token creation form.
|
|
|
|
|
|
|
|
## Step 2: Fill in the API token form {#step-2}
|
|
|
|
|
|
|
|
Fill in the form with the desired values for the token you want to create. Refer to the [API tokens and client keys](../reference/api-tokens-and-client-keys.mdx#token-data) article for a detailed explanation of what all the fields mean.
|
|
|
|
## Using API tokens
|
|
|
|
When you have created the API token, it will be listed on the API access page. If you have the required permissions to see the token, you can copy it for easy use in your applications.
|
|
|
|
|