> For the complete documentation index, see [llms.txt](https://brightwind.gitbook.io/brighthub-user-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://brightwind.gitbook.io/brighthub-user-docs/api-reference/api-key-management.md).

# API Key Management

{% hint style="info" %}
For instructions on using your API key to authenticate and access BrightHub APIs, visit the [How to Use API Keys](https://brightwind.gitbook.io/brighthub-user-docs/api-reference/how-to-use-api-keys).
{% endhint %}

### **Overview**

API Key Management enables you to securely create and manage programmatic access to BrightHub APIs — especially useful if you’re using Microsoft Azure SSO and cannot sign in with a username and password.

With API Keys, you can authenticate API requests without the need for manual login. You can create up to **two API Keys** (active or inactive) at any time. Each API Key includes:

* **Client ID** — an identifier
* **Client Secret** — shown only once at creation for security

> ⚠️ Important: Keep your **Client Secret** safe! If lost, you’ll need to delete the key and generate a new one.

### **Manage Your API Keys**

You’ll find the Manage API Keys section in your **Account Settings**, accessible via your user icon in the top-right corner.

This section provides:

* A clear table of your current API Keys (maximum of 2)
* Options to **Create**, **Deactivate**, **Activate**, or **Delete** each key
* Key information at a glance — including creation date, last use, and expiration date

<figure><img src="/files/WlLedRg3IuhGoBsdx0Pr" alt=""><figcaption></figcaption></figure>

<p align="center"><sup><strong>Figure 1:</strong> Screenshot of the <em>Manage API Keys</em> section in your account settings.</sup></p>

### **Creating a New API Key**

* Click '**+ CREATE NEW API KEY'**, at the top right of the table.
  * If you already have two API Keys, this button will be disabled with a tooltip explaining why.![](https://brightwind.gitbook.io/brighthub-user-docs/~gitbook/image?url=https%3A%2F%2F333952756-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FY7yCeuezA9Qqi1zivKDu%252Fuploads%252FEaUYpM0A2iCiZEg7kP69%252Fimage.png%3Falt%3Dmedia%26token%3D72ba0e90-70c5-452f-8964-c87cb1b6ad90\&width=300\&dpr=4\&quality=100\&sign=5b0ba6d3\&sv=2)

<p align="center"><sup><strong>Figure 2:</strong> Screenshot of the tooltip explaining why the user is not able to add new API Key.</sup></p>

* In the dialog, enter an optional **Description** (up to 100 characters) to help you remember its purpose.
* Click **Create Key**.
* You’ll see a second confirmation dialog showing:
  * **Client Id** — always visible and copyable
  * **Client Secret** — hidden by default; click the eye icon to reveal and hide again as needed
    * Use the copy icon to quickly copy either value.
* You can also download both values in a `.csv` file.

![](https://brightwind.gitbook.io/brighthub-user-docs/~gitbook/image?url=https%3A%2F%2F333952756-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FY7yCeuezA9Qqi1zivKDu%252Fuploads%252FwTIdmUMYaOkPHQaQHUSw%252FScreenshot%25202025-11-05%2520at%25206.51.40%25E2%2580%25AFPM.png%3Falt%3Dmedia%26token%3D119ac51a-3857-484b-8799-afee42a5ebbd\&width=768\&dpr=4\&quality=100\&sign=fc09b828\&sv=2)![](https://brightwind.gitbook.io/brighthub-user-docs/~gitbook/image?url=https%3A%2F%2F333952756-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FY7yCeuezA9Qqi1zivKDu%252Fuploads%252Fsx6CTPcsj5lEcjX823Bj%252FScreenshot%25202025-11-05%2520at%25206.52.01%25E2%2580%25AFPM.png%3Falt%3Dmedia%26token%3D279215c9-d0fa-4af0-b7fe-f9ed258d42d4\&width=768\&dpr=4\&quality=100\&sign=842c9760\&sv=2)

<p align="center"><sup><strong>Figures 3 &#x26; 4:</strong> Screenshots of the dialogs for creating a new API Key</sup></p>

> ⚠️ Important: Copy or download your **Client Secret** now — this is your only chance to save it securely.

### **Deactivating a Key**

* **When to use:** Temporarily disable an API Key without deleting it.
  * In the table, click the **Deactivate** icon, to the right.
  * A confirmation dialog will appear showing the **Last Used** timestamp.
  * After confirmation: the status changes to **Inactive**.

### **Activating a Key**

* **When to use:** Restore an inactive API Key to active state.
  * In the table, click the **Activate** icon, to the right.
  * Confirm your action.
  * After confirmation: the status changes to **Active**.

### **Deleting a Key**

* **Precondition:** Only inactive API Keys can be deleted.

  * If the API Key is active, the Delete icon is disabled with the tooltip: *“You must deactivate the API Key before you can delete it.”*
  * If the API Key is inactive, the Delete icon is enabled. Click **Delete** to open a confirmation dialog. After confirmation, the key is **permanently removed** from your account.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://brightwind.gitbook.io/brighthub-user-docs/api-reference/api-key-management.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.