Gestion des clés API

Le module Administration du site vous permet de créer et de gérer des clés API pour les applications externes accédant à l’API d’OpenText Application Quality Management.

Présentation des clés API

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

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

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

Lorsque vous écrivez des extensions 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 Développer.

Retour en haut

Autorisations

Par défaut, seuls les administrateurs de site (pour les installations locales) et les administrateurs de client (pour les solutions SaaS) peuvent créer et gérer des clés API pour les utilisateurs, à l’aide de l’onglet Administration du site > Utilisateurs > Gestion des clés API. Pour plus d’informations, voir Créer et gérer des clés API pour n’importe quel utilisateur.

Si vous n’êtes pas un administrateur de site ou de client, vous pouvez créer et gérer vos propres clés API à partir de Administration du site > Mes paramètres > Ma clé API, en fonction de la configuration du paramètre APIKEY_SELF_SERVICE_LEVEL. Pour plus d’informations, voir Créer et gérer vos propres clés API.

Retour en haut

Créer et gérer des clés API pour n’importe quel utilisateur

En tant qu’administrateur de site ou de client, vous pouvez créer, supprimer, révoquer et régénérer des clés API pour tout utilisateur actif.

Pour créer une clé API :

  1. Ouvrez Administration du site > Utilisateurs > Gestion des clés API.

  2. Cliquez sur Ajouter une clé API et fournissez les informations suivantes :

    Champ Description
    Nom de clé API Attribuez un nom à la clé.
    Propriétaire

    Sélectionnez un utilisateur à associer à la clé. Les autorisations de l’utilisateur sont accordées à toute application qui accède au système à l’aide de cette clé API.

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

    Indiquez quand la clé API doit expirer.

    Le délai d’expiration que vous avez défini pour cette API :

    • Remplace le délai d’expiration défini globalement par le paramètre de site APIKEY_EXPIRE_DAYS. Pour plus de détails, voir Paramètres du site.

    • Ne doit pas être postérieur à la valeur du paramètre de site APIKEY_EXPIRE_DAYS.
    Étendue

    Activez ou désactivez OData pour la clé API.

    Si vous souhaitez vous connecter aux données du projet à partir d’OData à l’aide de l’authentification par clé API, activez OData pour la clé API. Pour plus d’informations, voir Prise en charge d’OData pour la génération de rapports étendue.

  3. Cliquez sur Créer et notez l’ID de client et le Secret de clé API générés.

    Effectuez un enregistrement sécurisé de l’ID de client et du Secret de clé API et fournissez-les à l’utilisateur associé. Une fois générés, l’ID de client et le secret de clé API ne peuvent plus être récupérés. En cas de perte, vous devez révoquer la clé et la régénérer.

Note : 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.

Pour supprimer une clé API :

Sélectionnez la clé dans la liste et cliquez 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 notification lorsque vous supprimez vos propres clés API.

Pour révoquer une clé API

Révoquez une clé API lorsque vous souhaitez empêcher temporairement le propriétaire de cette API de l’utiliser pour accéder au système.

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 notification lorsque vous révoquez vos propres clés API.

Pour régénérer une clé API révoquée :

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é. Cliquez sur le bouton Copier pour noter le nouveau secret de clé API.

Retour en haut

Créer et gérer vos propres clés API

Si vous y êtes autorisé, vous pouvez afficher, créer ou modifier vos propres clés API sans l’autorisation d’un administrateur.

Conditions préalables :

La possibilité pour vous, en tant qu’utilisateur de base, de créer et de gérer vos propres clés API dépend de la configuration du paramètre APIKEY_SELF_SERVICE_LEVEL. Pour plus d’informations, voir APIKEY_SELF_SERVICE_LEVEL.

Pour créer et gérer vos propres clés API :

  1. Dans le coin supérieur droit de l’Administration du site, cliquez sur l’icône de l’utilisateur connecté  > Mes paramètres.

  2. Cliquez sur l’onglet Ma clé API.

  3. Affichez les détails de votre clé API ou créez une clé API pour votre compte. Voir Créer et gérer des clés API pour n’importe quel utilisateur.

Retour en haut

Filtrer les clés API

Vous pouvez filtrer les clés API par attributs d’utilisateur, tels que le nom, le statut et le propriétaire de la clé API.

Pour filtrer les clés API :

  1. Ouvrez l’onglet Administration du site > Utilisateurs > Gestion des clés API .

  2. Cliquez sur Filtre.

  3. Spécifiez les attributs suivants selon lesquels les clés API doivent être filtrées, puis cliquez sur Filtre.

    • Nom de clé API. Affiche les clés API dont le nom est tel que spécifié.

    • ID de client. Affiche la clé API dont l’ID de client est tel que spécifié.

    • Statut. Affiche les clés API par statut spécifique : active, inactive ou révoquée.

    • Propriétaire. Affiche les clés API dont le propriétaire est tel que spécifié.

    • Créée par. Affiche les clés API créées par l’utilisateur que vous avez spécifié.

    • Date d’expiration. Affiche les clés API qui expirent à la date spécifiée.

    • N’expire jamais. Affiche les clés API qui n’expirent jamais.

Retour en haut

Paramètres de site liés aux clés API

Le tableau suivant répertorie les paramètres du site liés aux clés API. En tant qu’administrateur de site, vous pouvez les utiliser pour contrôler les comportements des clés API au niveau du site.

Paramètre Description
OTA_ACCESS_APIKEY_ONLY

Ce paramètre permet de contrôler si les applications tierces peuvent utiliser le nom d’utilisateur et le mot de passe pour s’authentifier à l’aide de l’API OTA.
RESTAPI_ACCESS_APIKEY_ONLY Ce paramètre permet de contrôler si les applications peuvent être authentifiées à l’aide d’un nom d’utilisateur et d’un mot de passe à l’aide de l’API REST.
RESTAPI_WHITELIST_APIKEY Ce paramètre permet de spécifier les types de clients d’outils ou d’applications tiers qui peuvent se connecter avec un nom d’utilisateur et un mot de passe à l’aide de l’API REST.
RESTAPI_DEFAULTLIST_APIKEY Ce paramètre permet de spécifier les types de clients d’outils internes qui peuvent se connecter avec un nom d’utilisateur et un mot de passe à l’aide de l’API REST.
APIKEY_MAX_NUM_PER_USER Ce paramètre permet de définir le nombre maximal de clés API actives que chaque utilisateur est autorisé à créer. La valeur par défaut est de 10.
APIKEY_EXPIRE_DAYS

Ce paramètre permet de spécifier le nombre de jours après lesquels toutes les clés API expireront globalement.

La valeur par défaut est de -1, ce qui signifie que les clés API n’expirent jamais. Si le délai d’expiration d’une clé API est spécifié séparément, ce paramètre est remplacé pour la clé API. Pour plus d’informations, voir Date d’expiration.
APIKEY_SELF_SERVICE_LEVEL

Ce paramètre permet de contrôler ce que tous les utilisateurs peuvent faire avec leurs clés API dans la page Administration du site > Mes paramètres > Ma clé API.

  • admin_only. Vous ne pouvez pas créer ni gérer vos clés API. Seul un administrateur de site ou de client peut gérer des clés API pour vous à partir de Administration du site > Utilisateurs > Gestion des clés API.

  • user_read_only. Vous ne pouvez pas créer ni modifier vos clés API, mais vous pouvez en afficher les détails.

  • user_full_control. Vous bénéficiez d’un contrôle total sur vos clés API, notamment sur les opérations de création, affichage, révocation, suppression et régénération de vos clés API.

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

Retour en haut

Dépannage des clés API

Le tableau suivant répertorie les problèmes que vous pouvez rencontrer lors de l’utilisation de clés API.

Problème Solution
Impossible de se connecter à une application externe à l’aide d’une clé API existante après la mise à niveau Contactez l’administrateur de votre site pour vous assurer que la phrase secrète des données confidentielles et la phrase secrète de sécurité des communications sont les mêmes que les phrases secrètes utilisées pour la version précédente. Des phrases secrètes différentes entre les versions invalident les phrases secrètes de toutes les clés API existantes.

Retour en haut