Rolebase Développeurs
Référence API

api_key

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

ChampTypeDescription
iduuidIdentifiant unique de la clé API (généré automatiquement)
userIduuidRéférence à l’utilisateur propriétaire de cette clé
nameStringNom descriptif de la clé API
valueStringValeur de la clé API (générée automatiquement, affichée une seule fois à la création)
createdAtTimestampDate de création de la clé API (par défaut : horodatage actuel)

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
  }
}

Supprimer une clé API

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

Permissions

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

  • Les utilisateurs peuvent créer, consulter, renommer et supprimer 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.