mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
5c27153e50
<!-- Thanks for creating a PR! To make it easier for reviewers and everyone else to understand what your changes relate to, please add some relevant content to the headings below. Feel free to ignore or delete sections that you don't think are relevant. Thank you! ❤️ --> ## About the changes <!-- Describe the changes introduced. What are they and why are they being introduced? Feel free to also add screenshots or steps to view the changes if they're visual. --> <!-- Does it close an issue? Multiple? --> Closes # <!-- (For internal contributors): Does it relate to an issue on public roadmap? --> <!-- Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item: # --> ### Important files <!-- PRs can contain a lot of changes, but not all changes are equally important. Where should a reviewer start looking to get an overview of the changes? Are any files particularly important? --> ## Discussion points <!-- Anything about the PR you'd like to discuss before it gets merged? Got any questions or doubts? --> --------- Signed-off-by: andreas-unleash <andreas@getunleash.ai>
34 lines
1.8 KiB
Plaintext
34 lines
1.8 KiB
Plaintext
---
|
|
title: How to create Project API Tokens
|
|
---
|
|
|
|
:::info Permissions
|
|
|
|
Creating Project API tokens requires you to have the `CREATE_PROJECT_API_TOKEN` permission.
|
|
|
|
:::
|
|
|
|
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 Project _API access_ page in the admin UI (available at the URL `/admin/projects/<project-name>/api-access`). Use the navigation tab "Project Settings" and select "API access".
|
|
|
|
![The Project overview "Project settings" submenu with the API access item highlighted.](/img/configure_project_api.png)
|
|
|
|
On the API access page, use the "New API token" button to navigate to the token creation form.
|
|
|
|
![The Project API access page with the "New API token" button highlighted.](/img/admin_new_project_api_key_button.png)
|
|
|
|
## Step 2: Fill in the API token form {#step-2}
|
|
|
|
![Project API token creation form. ](/img/admin_create_project_token_form.png)
|
|
|
|
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 Project API tokens
|
|
|
|
When you have created the Project API token, it will be listed on the Project API access page. If you have the required permissions to see the token (`READ_PROJECT_API_TOKEN`), you can copy it for easy use in your applications.
|
|
|
|
![API access token table with a "copy token" button highlighted.](/img/copy_project_token.png)
|