mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
47152cf05b
* refactor: user creation screen cleanup * feat: deprecation notice for google sso * fix: docs openid typo * invite link bar * invite link page * fix prettier docs * regenerated openapi * hooks for invite page api * update openapi * feat: invite link update * feat: add public signup token soft-delete * public signup frontend feature flag * fix: new user api issues * feat: allow for creating new user from invite link * Feat/invite user public controller (#2106) * added PublicInviteController for public urls * added PublicInviteController for public urls * added PublicInviteController for public urls * added PublicInviteController for public urls * fix test * fix test * update openapi * refactor: password reset props * fix: public invite schema and validation Co-authored-by: Fredrik Strand Oseberg <fredrik.no@gmail.com> * user invite frontend Co-authored-by: Fredrik Strand Oseberg <fredrik.no@gmail.com> * invite link delete confirmation dialog * refactor: password reset action * fix: new user invite loading state * fix: run ts check with ci * revert openapi changes * fix: invite token api interface * fix: openapi schema index * fix: update test snapshots * update frontend snapshot * fix: prettier ci * fix: updates after review Co-authored-by: andreas-unleash <104830839+andreas-unleash@users.noreply.github.com> Co-authored-by: Fredrik Strand Oseberg <fredrik.no@gmail.com>
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
---
|
|
id: api_access
|
|
title: How to use the Admin API
|
|
---
|
|
|
|
It is possible to integrate directly with the Admin API. In this guide we will explain all the steps to set it up.
|
|
|
|
## Step 1: Create API token {#step-1-create-api-token}
|
|
|
|
Please refer to [_how to create API tokens_](../user_guide/api-token) on how to create an API token. You'll need a token with `Admin` level access for this to work.
|
|
|
|
Please note that it may take up to 60 seconds for the new key to propagate to all Unleash instances due to eager caching.
|
|
|
|
:::note
|
|
|
|
If you need an API token to use in a client SDK you should create a "client token" as these have fewer access rights.
|
|
|
|
:::
|
|
|
|
## Step 2: Use Admin API {#step-2-use-admin-api}
|
|
|
|
Now that you have an access token with admin privileges we can use that to perform changes in our Unleash instance.
|
|
|
|
In the example below we will use the [Unleash Admin API](../api/admin/features) to enable the “Demo” feature toggle using curl.
|
|
|
|
```sh
|
|
curl -X POST -H "Content-Type: application/json" \
|
|
-H "Authorization: admintoken" \
|
|
https://app.unleash-hosted.com/demo/api/admin/features/Demo/toggle/on
|
|
```
|
|
|
|
**Great success!** We have now enabled the feature toggle. We can also verify that it was actually changed by the API user by navigating to the Event log (history) for this feature toggle.
|
|
|
|
|
|
|
|
## API overview {#api-overview}
|
|
|
|
You can find the full documentation on everything the Unleash API supports in the [Unleash API documentation](../api/admin/features).
|