---
title: "API Key"
url: "https://rolebase.io/en/api/api_key"
---

[Rolebase](/) ⟩ [API Reference](/en/api)

 API Reference

# `api_key`

Represents an API key for programmatic access to the Rolebase API. API keys authenticate and authorize integration with external applications and services.

## Fields

Field

Type

Description

`id`

`uuid`

Unique identifier for the API key (auto-generated)

`userId`

`uuid`

Reference to the user who owns this key

`name`

`String`

Descriptive name for the API key

`value`

`String`

The actual API key value (auto-generated, shown once on creation)

`createdAt`

`Timestamp`

When the API key was created (defaults to current timestamp)

## Relationships

### Object Relationships

*   `user` — The user this API key belongs to

## Query Examples

### List API Keys

```
query apiKeys($userId: uuid!) {
  api_key(where: { userId: { _eq: $userId } }) {
    id
    name
    value
    createdAt
  }
}
```

## Mutation Examples

### Create an API Key

```
mutation createApiKey($userId: uuid!, $name: String!) {
  insert_api_key_one(object: { userId: $userId, name: $name }) {
    id
    name
    value
    createdAt
  }
}
```

### Rename an API Key

```
mutation renameApiKey($id: uuid!, $name: String!) {
  update_api_key_by_pk(pk_columns: { id: $id }, _set: { name: $name }) {
    id
    name
    value
    createdAt
  }
}
```

### Delete an API Key

```
mutation deleteApiKey($id: uuid!) {
  delete_api_key_by_pk(id: $id) {
    id
  }
}
```

## Permissions

API key management is restricted to the owning user:

*   Users can create, view, rename, and delete their own API keys only

The key `value` is only shown once upon creation — store it securely. Best practices include regularly rotating keys, monitoring usage, deleting unused keys, and never sharing them publicly.