---
title: "api_key | API GraphQL | Rolebase"
description: "Clé API, représente une clé API pour l'accès programmatique à l'API Rolebase. Les clés API authentifient et autorisent l'intégration avec des applications et services externes."
url: "https://rolebase.io/fr/developers/graphql-api/api_key"
---

[Rolebase](/) ⟩[Développeurs](/fr/developers) ⟩[API GraphQL](/fr/developers/graphql-api)

# api\_key

Clé API, représente une clé API pour l'accès programmatique à l'API Rolebase. Les clés API authentifient et autorisent l'intégration avec des applications et services externes.

## Champs

Champ

Type

Description

`id`

`uuid`

Identifiant unique de la clé API (généré automatiquement)

`userId`

`uuid`

Référence à l'utilisateur propriétaire de cette clé

`name`

`String`

Nom descriptif de la clé API

`value`

`String`

Valeur de la clé API (générée automatiquement, affichée une seule fois à la création)

`createdAt`

`Timestamp`

Date de création de la clé API (par défaut : horodatage actuel)

`lastUsedAt`

`Timestamp`

Date de dernière utilisation de la clé API pour s'authentifier ; null si jamais utilisée

`archivedAt`

`Timestamp`

Date d'archivage de la clé API ; null si actif

## Relations

### Relations objet

*   `user` — L'utilisateur auquel cette clé API appartient

## Exemples de requêtes

### Lister les clés API

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

## Exemples de mutations

### Créer une clé API

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

### Renommer une clé API

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

### Archiver une clé API

Les clés API sont archivées (suppression douce) en renseignant `archivedAt`, sans suppression physique.

```
mutation archiveApiKey($id: uuid!) {  update_api_key_by_pk(    pk_columns: { id: $id }    _set: { archivedAt: "2024-01-01T00:00:00Z" }  ) {    id  }}
```

## Permissions

La gestion des clés API est restreinte à l'utilisateur propriétaire :

*   Les utilisateurs peuvent créer, consulter, renommer et archiver uniquement leurs propres clés API

La `value` de la clé n'est affichée qu'une seule fois à la création -- conservez-la en lieu sûr. Les bonnes pratiques incluent la rotation régulière des clés, la surveillance de l'utilisation, la suppression des clés inutilisées et ne jamais les partager publiquement.