Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add api key roles information #94

Merged
merged 1 commit into from
Jun 14, 2024
+13 −9
Merged

docs: add api key roles information #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions docs/feature-flags/api-keys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,31 @@ tags: ['integration', 'feature-flag']

import CenteredImg from '@site/src/components/centered-img/CenteredImg';

On this page your find information about what are API Keys, how to create them and their role on Bucketeer system.
The API keys authorizes and control access to the feature flag management system, providing authentication capabilities that ensure secure connections between your application and the server.<br />
Each API key is associated with a specific environment, allowing you to identify and link your application to the desired user group.

## What are API Keys

When working with flags in Bucketeer, API keys are essential. They authorize and control access to the feature flag management system, providing authentication capabilities that ensure secure connections between your application and the Bucketeer management service. Each API key is associated with a specific project and environment, allowing you to identify and link your application to the desired user group. By requiring a valid API key for accessing the flag information, the security and integrity of the system is maintained, reducing the risk of unauthorized entry or manipulation with feature flag configurations.
## Creating an API Key

When setting up the SDK on your application, you must include a valid API key. This key is necessary for the server to recognize that the request is valid when the SDK performs a server request. If you provide an invalid API key during configuration, the server will deny the request. For more information on configuring the SDK, refer to the [SDK's documentation](../sdk).
To create an API key, you need to be an Admin or have an environment account with the Owner role. Other members can see the APY keys but can't manage them.

## Creating an API Key
The API key has 2 roles.

To create an API Key, you need to be an Admin or have an environment account with the Owner role. Other members can see the APY keys but can't manage them.
- **Client SDK:** Allows all SDKs to evaluate end users on the Bucketeer server.
- **Server SDK:** Allows the server SDK (Golang) to evaluate end users locally within the SDK.

To generate a new API key in the Bucketeer dashboard, navigate to the **API Keys** tab. This section will present a list of all currently available API keys. If you wish to create a new one, click the **+ Add** button. A side panel will appear on the right side of your screen. Enter a name for the new key, limited to one hundred characters, and finalize the process by clicking **Submit**. The new key will show up at the top of the **API Keys** list.
To generate a new API key, click the **+ Add** button on the **API Keys** page.<br />

<CenteredImg
imgURL="img/feature-flags/api-keys/create-api-key.png"
alt="Account dashboard tab"
wSize="100%"
/>

The Bucketeer team advises giving each API key a meaningful name based on its associated feature or project to make it easy to manage. Avoid using randomly generated names as they can cause confusion and make it difficult to identify where the API key is being used.
:::tip

Choose a meaningful name for the API key based on its associated feature or project to make it easy to manage. Avoid random names, as they can cause confusion and make it difficult to identify where the API key is used.

:::

## Manage your API Keys

Expand Down
Loading