Configurer l’accès à la clé API

L’authentification par clé API fournit un mécanisme d’authentification sécurisé pour les applications externes accédant à l’API d’ALM.

Présentation de l’authentification par clé API

L’authentification par clé API fournit un mécanisme d’authentification sécurisé pour les applications externes accédant à l’API d’ALM.

  • Chaque clé API comprend un ID de client et une Clé API que les applications doivent utiliser lors de l’authentification.
  • Chaque clé API est associée à un utilisateur ALM. Par conséquent, lorsqu’une application utilise une clé API pour accéder à ALM, l’application est limitée par les autorisations de son utilisateur.
  • Vous ne pouvez utiliser qu’une clé API active pour accéder à ALM.

  • Si vous désactivez ou supprimez un utilisateur dans ALM, les clés API de l’utilisateur sont également supprimées.

Lorsque vous écrivez des extensions ALM ou des scripts API, obtenez un ID client et une clé API auprès de l’administrateur, et utilisez-les pour l’authentification. Pour plus de détails sur l’authentification des clés d’API lors de l’utilisation de REST et OTA, voir Aide aux développeurs.

Retour en haut

Utilisation des clés API

En tant qu’administrateur du site ALM, vous pouvez créer, supprimer, révoquer et régénérer les clés API. En tant qu’utilisateur de base, ce que vous pouvez faire avec les clés API associées dépend de la configuration du paramètre de site APIKEY_SELF_SERVICE_LEVEL. Pour plus d’informations sur ce paramètre, voir Paramètres du site ALM.

SaaS : Lors de la gestion des clés API, les options varient en fonction de l’administrateur client actuellement connecté.

  1. (Facultatif) Définissez le délai d’expiration de la clé API.

    Par défaut, les clés API n’expirent que si elles sont révoquées. Pour définir un délai d’expiration, vous pouvez définir le paramètre de site APIKEY_EXPIRE_DAYS. Ce paramètre n’a pas d’impact sur les clés API existantes.

    Pour plus de détails, voir Paramètres de site ALM.

  2. Dans la fenêtre Options d’Application Lifecycle Management, cliquez sur le lien Clés API. Dans la fenêtre de connexion aux clés API, entrer votre nom d’utilisateur et votre mot de passe.

  3. Gérez les clés API.

    Créer une clé API

    Pour créer une clé API :

    1. Cliquer sur Accès API.

    2. Dans le champ Nom de la clé API, fournir un nom pour la clé.

    3. Dans le champ Utilisateur, sélectionner un utilisateur à associer à la clé. Les autorisations utilisateur sont accordées à toute application qui accède à ALM à l’aide de cette clé API.

      SaaS : La liste des utilisateurs disponibles varie en fonction de l’administrateur client actuellement connecté.

    4. Cliquez sur Créer.

      Vous recevez un ID de client et le secret de la clé API, que vous devez fournir à la personne qui doit utiliser cette clé à des fins d’authentification. Conservez-les en lieu sûr, car il est impossible de récupérer le secret en cas de perte. Si vous le perdez, révoquer la clé et la régénérer pour en recevoir une nouvelle.

    Le paramètre de site APIKEY_MAX_NUM_PER_USER limite le nombre maximum de clés API que vous pouvez créer pour un utilisateur. Vous ne pouvez pas créer ou régénérer des clés API pour l’utilisateur au-delà de cette limite. Pour plus d’informations sur ce paramètre, voir Paramètres du site ALM.
    Supprimer une clé API

    Pour supprimer une clé API, sélectionner la clé dans la liste et cliquer sur Supprimer la clé.

    Le propriétaire de la clé API reçoit une notification par e-mail après la suppression. Si vous êtes un utilisateur de base ayant le contrôle complet de vos clés API, vous ne recevez pas de notifications lorsque vous supprimez vos propres clés API.
    Révoquer une clé API

    Révoquez une clé API lorsque vous souhaitez empêcher temporairement ALM d’accéder à la clé API.

    Pour révoquer une clé API, la sélectionner dans la liste et cliquer sur Révoquer la clé.

    Le propriétaire de la clé API reçoit une notification par e-mail après la révocation. Si vous êtes un utilisateur de base ayant le contrôle complet de vos clés API, vous ne recevez pas de notifications lorsque vous révoquez vos propres clés API.
    Régénérer une clé API

    Vous pouvez régénérer une clé API révoquée en vue de réactiver la clé et de fournir un nouveau secret de clé API à utiliser avec l’ID de client original.

    Pour régénérer une clé API, sélectionner la clé dans la liste et cliquer sur Régénérer la clé.
    Actualiser Cliquer sur Actualiser pour actualiser la liste des clés API.
    Consulter la date d’expiration

    La colonne Date d’expiration s’affiche lorsqu’une clé API expire.

    Si une clé API expire dans les 10 jours, un avertissement apparaît en regard de la date d’expiration : Expire dans <N> jours. La clé API expirera à minuit (12 h 00) le jour d’expiration.

Retour en haut