Aller au contenu principal

Clés API

Les clés API fournissent une authentification sécurisée pour accéder aux API REST de Qalyptus Server. Cette fonctionnalité permet aux utilisateurs de générer des jetons à durée limitée pour un accès programmatique aux fonctionnalités de Qalyptus tout en maintenant des contrôles de sécurité et une supervision administrative appropriés.

Vue d'ensemble​

Les clés API permettent :

  • Authentification API sécurisée : Accès basé sur des jetons aux endpoints REST
  • Intégration programmatique : Flux de travail automatisés et intégrations tierces
  • Accès contrôlé : Jetons à durée limitée avec expiration configurable
  • Supervision administrative : Gestion et surveillance centralisées de toutes les clés API
Avertissement de sécurité

Les clés API fournissent un accès complet équivalent aux permissions de l'utilisateur. Traitez-les comme des mots de passe et stockez-les en lieu sûr.

Activation des clés API​

Par défaut, la fonctionnalité de clés API est désactivée pour des raisons de sécurité.

Pour activer les clés API :

  1. Accédez à Administration > Paramètres > Clés API
  2. Activez l'option Clés API
  3. Configurez la Période d'expiration (1-365 jours, par défaut : 180 jours)
  4. Enregistrez la configuration
Exigences de permissions

Même lorsque les clés API sont activées globalement, les utilisateurs doivent disposer du rôle de permission approprié pour générer et utiliser des clés API.

Paramètres de configuration​

Période d'expiration​

Définit la durée de vie maximale pour les clés API nouvellement générées.

Options :

  • Plage : 1-365 jours
  • Par défaut : 180 jours
  • Recommandation : 30-90 jours pour une sécurité renforcée
Bonne pratique de sécurité

Des périodes d'expiration plus courtes réduisent les risques de sécurité mais nécessitent une rotation plus fréquente des clés. Équilibrez sécurité et besoins opérationnels.

API keys

Gestion des clés API par les utilisateurs​

Accès aux clés API​

Les utilisateurs peuvent gérer leurs clés API via : Profil utilisateur > Clés API

Visibilité

La section Clés API n'apparaît dans les profils utilisateur que lorsque la fonctionnalité est activée par les administrateurs.

Génération d'une clé API​

Pour créer une nouvelle clé API :

  1. Cliquez sur Générer une clé
  2. Saisissez un nom descriptif pour la clé
  3. Ajoutez une description optionnelle pour le contexte
  4. Sélectionnez une date d'expiration (dans la limite configurée)
  5. Copiez et stockez en lieu sûr la clé générée
Important

La clé API n'est affichée qu'une seule fois. Copiez-la et stockez-la immédiatement dans un endroit sécurisé. Elle ne pourra plus être récupérée.

API keys

Gestion des clés existantes​

Après la génération, les utilisateurs peuvent :

  • Mettre à jour le nom et la description des clés existantes
  • Consulter les dates d'expiration et les informations de création
Limitations des clés
  • Les dates d'expiration ne peuvent pas être prolongées après la création
  • Maximum de 1000 clés API par utilisateur
  • Les clés ne peuvent pas être régénérées ou récupérées si elles sont perdues

Gestion administrative​

Affichage de toutes les clés API​

Les administrateurs peuvent surveiller toutes les clés API des utilisateurs via : Administration > Système > Clés API

Informations disponibles​

  • Propriétaire de la clé et informations utilisateur
  • Date de création et expiration
  • Statut de la clé
  • Actions administratives (suppression/révocation)

Actions administratives​

Révocation des clés API :

  • Les administrateurs peuvent supprimer n'importe quelle clé API pour révoquer immédiatement l'accès
  • Utile en cas d'incidents de sécurité ou de départ d'utilisateurs
  • L'action est immédiate et ne peut pas être annulée

API keys

Meilleures pratiques de sécurité​

Pour les utilisateurs​

  • Stockage sécurisé : Stockez les clés API dans des gestionnaires de mots de passe ou des coffres-forts sécurisés
  • Portée limitée : Générez des clés distinctes pour différentes applications ou finalités
  • Rotation régulière : Remplacez les clés avant leur expiration, surtout pour les applications critiques
  • Surveillance de l'utilisation : Révisez régulièrement les clés actives et supprimez celles inutilisées

Pour les administrateurs​

  • Périodes d'expiration courtes : Configurez des limites d'expiration raisonnables (30-90 jours)
  • Audits réguliers : Surveillez l'utilisation des clés API et supprimez les clés inactives
  • Contrôles des permissions : Assurez-vous que seuls les utilisateurs autorisés ont les permissions de générer des clés API
  • Réponse aux incidents : Établissez des procédures de révocation immédiate des clés en cas de compromission

Dépannage​

La clé API ne fonctionne pas​

  1. Vérifiez que la clé n'a pas expiré
  2. Vérifiez les permissions utilisateur pour l'accès API
  3. Confirmez que les clés API sont activées globalement
  4. Validez le format de la clé et la méthode d'authentification

Impossible de générer des clés​

  1. Assurez-vous que les clés API sont activées par les administrateurs
  2. Vérifiez que l'utilisateur possède les rôles de permission appropriés
  3. Vérifiez si l'utilisateur a atteint la limite de 1000 clés
  4. Confirmez que la date d'expiration sélectionnée respecte les limites de la politique