# API Keys

## Getting Here <a href="#getting-here" id="getting-here"></a>

**Settings > User Management > API Keys**

***

## User Management - API Keys <a href="#user-management---api-keys" id="user-management---api-keys"></a>

The **API Keys** page under User Management allows you to view, manage, and create API keys for system integrations, access control, and automation.

***

### Getting Here <a href="#getting-here-1" id="getting-here-1"></a>

Navigate to:\
**Settings > User Management > API Keys**

***

### Page Overview <a href="#page-overview" id="page-overview"></a>

#### Top Action Buttons <a href="#top-action-buttons" id="top-action-buttons"></a>

1. **ADD API KEY**
   * **Description**: Initiates the creation of a new API key.
   * **Behavior**: Opens a form to define API key details, including roles and permissions.
2. **API SHARED SECRET**
   * **Description**: Allows retrieval or creation of a shared secret for API integrations.

***

### API Keys Table <a href="#api-keys-table" id="api-keys-table"></a>

The table provides an overview of all API keys and their details. The table contains the following columns:

| Field           | Description                                                                                               |
| --------------- | --------------------------------------------------------------------------------------------------------- |
| **Name / Desc** | The name or description of the API key. Includes additional details such as its purpose or usage context. |
| **Role**        | The role associated with the API key, defining its permissions. Possible values: `ADMIN` or `READONLY`.   |
| **Last Login**  | The last recorded use of the API key. If never used, displays `Never`.                                    |

***

#### Example Table Output <a href="#example-table-output" id="example-table-output"></a>

| Name / Desc             | Role     | Last Login          |
| ----------------------- | -------- | ------------------- |
| tcross\_ro              | READONLY | 2024-07-29 18:59:11 |
| srdkn                   | ADMIN    | 2024-12-12 19:51:30 |
| rharman\_automation\_rw | ADMIN    | Never               |
| rharman\_automation\_ro | READONLY | 2024-12-16 13:00:02 |
| productreport           | READONLY | 2024-12-09 16:21:36 |
| djm\_dash               | ADMIN    | 2024-09-27 20:02:11 |
| chris\_ro               | READONLY | 2024-01-08 23:07:29 |
| accountd                | ADMIN    | 2024-12-16 19:47:38 |

***

### Table Features <a href="#table-features" id="table-features"></a>

1. **Name / Desc**
   * Displays the API key name, with a description or usage notes.
2. **Role**
   * Defines access permissions:
     * `ADMIN`: Full administrative privileges.
     * `READONLY`: Limited to read-only actions.
3. **Last Login**
   * Shows the most recent date and time the API key was used.
   * If the key has not been used, `Never` is displayed.

***

### Actions <a href="#actions" id="actions"></a>

* **Add API Key**: Use this to create and configure new API keys.
* **View Shared Secret**: Access or configure the shared API secret.

***

### Notes <a href="#notes" id="notes"></a>

* Regularly review API keys to ensure unused keys are deleted and active keys have appropriate roles.
* API keys with `ADMIN` permissions should be used cautiously to prevent unintended access.
* Monitor the **Last Login** column to identify and clean up inactive or unused API keys.

***

The **API Keys Page** enables secure and efficient management of API credentials, providing clear visibility into roles, usage, and access control.


---

# Agent Instructions: 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://docs.fusion.vectra.ai/settings/user-management/index.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.