1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

docs: Project api token (#3405)

<!-- 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>
This commit is contained in:
andreas-unleash 2023-03-29 11:39:37 +03:00 committed by GitHub
parent 7d725c6eb7
commit 5c27153e50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 46 additions and 0 deletions

View File

@ -0,0 +1,33 @@
---
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)

View File

@ -21,6 +21,7 @@ This section describes what API tokens are. For information on how to create the
Use API tokens to connect to the Unleash server API. API tokens come in four distinct types: Use API tokens to connect to the Unleash server API. API tokens come in four distinct types:
- [Admin tokens](#admin-tokens) - [Admin tokens](#admin-tokens)
- [Project level access tokens](#project-access-tokens)
- [Personal access tokens](#personal-access-tokens) - [Personal access tokens](#personal-access-tokens)
- [Client tokens](#client-tokens) - [Client tokens](#client-tokens)
- [Front-end tokens](#front-end-tokens) - [Front-end tokens](#front-end-tokens)
@ -55,6 +56,18 @@ Do **not** use admin tokens for:
Support for scoped admin tokens with more fine-grained permissions is currently in the planning stage. Support for scoped admin tokens with more fine-grained permissions is currently in the planning stage.
### Project level access tokens
All project members can see any `CLIENT` (server-side client token) and `FRONTEND` (client-side client token) respectively.
Use personal access tokens to:
- Provide more fine-grained permissions for automation than an admin token provides
- Give access to all project members (or anyone with `READ_PROJECT_API_TOKEN` permission) to read the token
- Give access to the project owner (or anyone with `CREATE_PROJECT_API_TOKEN` permission) to create a token,
### Personal access tokens ### Personal access tokens
**Personal access tokens** are a special form of admin tokens and grant access to the same resources that the user that created them has access to. These permissions are dynamic, so if a user's permissions change through addition of a custom role, the token will likewise have altered permissions. **Personal access tokens** are a special form of admin tokens and grant access to the same resources that the user that created them has access to. These permissions are dynamic, so if a user's permissions change through addition of a custom role, the token will likewise have altered permissions.

Binary file not shown.

After

Width:  |  Height:  |  Size: 300 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 298 KiB