mirror of
https://github.com/Unleash/unleash.git
synced 2025-02-19 00:15:43 +01:00
51 lines
1.8 KiB
Markdown
51 lines
1.8 KiB
Markdown
---
|
|
id: api-token
|
|
title: How to create API Tokens
|
|
---
|
|
|
|
In order to connect to Unleash clients will need an API token to grant access. A client SDK will need to token with "client privileges", which allows them to fetch feature toggle configuration and post usage metrics back.
|
|
|
|
## Create API Token {#create-api-token}
|
|
|
|
### Permissions {#permissions}
|
|
|
|
To create an API token you'll need the CREATE_API_TOKEN permission level, at the time of writing (v4.0.0), this level is only set for instance admins.
|
|
|
|
Eventually one should be able to customize which users has access to create tokens.
|
|
|
|
All users are able to see tokens with CLIENT level access, but only instance admins can see tokens with ADMIN level access.
|
|
|
|
### Step-by-step {#step-by-step}
|
|
|
|
**1. Select `Advanced` from the top-line menu**
|
|
|
|
|
|
**2. Select `API Access` from the dropdown**
|
|
|
|
|
|
|
|
**3. Select `API ACCESS` from the tab men**
|
|
|
|
|
|
**4. Click `Add new API key` at the top right of the page**
|
|
|
|
|
|
|
|
**Client keys**
|
|
|
|
4a. If you're configuring an SDK select `Client` in the pop-up. And give the key an identifying name allowing you to recognize it later
|
|
|
|
|
|
|
|
5a. Copy the `Secret` column and add this to your client
|
|
|
|
|
|
|
|
**Admin operations**
|
|
|
|
4a. If you're going to be using the admin interface via CURL you'll need a key with `Admin` rights. Select `Admin` in the `Add new API key` popup.
|
|
|
|
Remember to give the key a username allowing you to recognize the key in audit logs later
|
|
|
|
5a. Copy the key in the `Secret` column and use it in your authorization header. For curl, that would be `-H "Authorization: <yoursecrethere>"`
|