API : Présentation des clés API et FAQ

Editer en ligne

Les clés API (Application Programming Interface) permettent de s'authentifier auprès des API du service Apptio sans avoir à saisir les identifiants de l'utilisateur. Une clé API contient une paire de clés comprenant une clé publique et une clé secrète. Cette combinaison de clés publiques et secrètes est utilisée pour authentifier les demandes. Chaque clé API peut comporter au maximum deux paires de clés. La création d'une nouvelle clé API entraîne la création d'une paire de clés. Vous pouvez ajouter ou supprimer des paires de clés jusqu'à un maximum de deux paires de clés. Les clés API offrent les avantages suivants :

  • Sécurité : Les clés API sont générées de manière aléatoire et comportent des chaînes de caractères plus longues. Apptio les clés de l'API sont composées de 60 caractères. L'entropie plus élevée rend la compromission difficile pour les attaquants.
  • Indépendance : dans les appels programmatiques, l'utilisation d'une clé API empêche les informations d'identification du compte principal (c'est-à-dire le compte utilisateur parent) d'être exposées à d'autres utilisateurs du système (tels que des collègues).
  • Exposition limitée : la clé secrète n'est exposée à l'utilisateur que lors de la création d'une clé API. L'utilisateur est invité à stocker la clé secrète en toute sécurité. Si la clé secrète est perdue ou compromise, une nouvelle clé peut être créée.
  • Rotation des clés : La possibilité d'avoir deux paires de clés actives permet aux utilisateurs d'effectuer une rotation des paires de clés sans interrompre l'automatisation ou l'accès programmatique. Vous pouvez configurer la politique de rotation des clés API dans les propriétés du domaine.
  • Traçabilité : Les clés API sont toujours liées à un compte utilisateur parent et offrent le même niveau de traçabilité qu'une session interactive normale.

Qui peut créer des clés API?

Les paramètres des clés API dans les propriétés du domaine déterminent si les clés API sont prises en charge dans le domaine et, le cas échéant, qui peut les créer. Si les clés API sont activées, les administrateurs peuvent créer des clés API pour eux-mêmes et pour d'autres personnes. Si l'option « Restreindre la création de clés API » est désactivée, tout utilisateur peut créer des clés API pour son propre compte.

Créer et gérer des clés API

Pour créer ou gérer des clés API pour votre propre utilisateur, cliquez sur le bouton Profil en haut de la page, sélectionnez Profil utilisateur, puis cliquez sur l'onglet Clés API. Pour créer ou gérer des clés API pour un autre utilisateur, cliquez sur Accueil dans le panneau de navigation de gauche, sélectionnez le domaine de l'utilisateur, puis recherchez l'utilisateur dans le tableau. Cliquez sur Détails, puis sur l'onglet Clés API.

Créer une clé API
  1. Dans l'onglet Clé API, cliquez sur Créer une clé API.
  2. Saisissez un nom de clé et une description.
  3. Sélectionnez une politique d'expiration, puis sélectionnez Ajouter.
  4. Notez la clé publique. Sélectionnez Afficher pour afficher la clé secrète. Vous ne pouvez voir la clé secrète que lors de la création de la clé API. Vous aurez besoin de cette clé lors de l'authentification programmatique. Conservez la clé secrète dans un endroit sûr.
  5. Sélectionnez l'une des options suivantes :
    • Terminé Revenez à la page Utilisateurs et accordez l'accès à la clé API aux environnements ultérieurement.
    • Accorder l'accès : sélectionnez dans la liste les environnements auxquels l'utilisateur a déjà accès, puis cliquez sur Suivant. Sélectionnez un ou plusieurs rôles pour la clé API. Sélectionnez Next (Suivant), puis Grant Access (Accorder l'accès).
Gérer les clés API
  1. Dans l'onglet Clés API, sélectionnez l'une des options suivantes :
    • Afficher les paires de clés : affichez ou masquez les clés publiques et les dates d'expiration (cette option n'est disponible que dans la vue Profil).
    • Accorder l'accès : sélectionnez dans la liste les environnements auxquels l'utilisateur a déjà accès, puis cliquez sur Suivant. Sélectionnez un ou plusieurs rôles pour la clé API. Sélectionnez Next (Suivant), puis Grant Access (Accorder l'accès).
    • Désactiver : Désactive une touche.
  2. Cliquez sur une clé API pour afficher le volet Détails correspondant à cette clé API :
    • Propriétés : affiche le nom, la politique de rotation et la description de la clé API. Cliquez sur Modifier pour modifier l'une de ces valeurs.
    • Paires de clés - Affiche les paires de clés associées à la clé API avec leurs dates d'expiration. Pour ajouter une paire de clés, cliquez sur le signe +. Pour supprimer une paire de clés, cochez la case au début de la ligne, puis cliquez sur Supprimer.
    • Accès - Affiche l'accès à l'environnement associé à la clé API avec des options pour modifier et révoquer l'accès.
Utiliser les clés API

Pour utiliser les clés API dans vos scripts et programmes, reportez-vous aux rubriques suivantes :

FAQ sur la clé API

Quelle est la politique d'expiration d'une clé API?

Ceci est configurable dans les propriétés du domaine.

Qui peut créer et gérer les clés API?

Ceci est configurable dans les propriétés du domaine.

Quels environnements et rôles sont disponibles pour les clés API?

Les clés API peuvent se voir accorder l'accès aux mêmes environnements et rôles que ceux dont dispose l'utilisateur parent pour tout environnement du domaine de l'utilisateur. Pour des raisons de sécurité, les clés API ne peuvent pas avoir accès aux environnements qui ne se trouvent pas dans le domaine de l'utilisateur parent.

Puis-je faire pivoter mes clés API?

Vous pouvez créer plusieurs clés API pour un seul compte utilisateur (utilisateur parent) et chaque clé API peut avoir deux paires de clés. Toutes les clés sont actives et valides, sauf si elles ont déjà expiré ou si elles ont été explicitement désactivées ou supprimées. Ces fonctionnalités vous permettent de mettre à jour des scripts et d'effectuer d'autres tâches périodiques avec une nouvelle paire de clés pour la même clé API sans interruption. Après avoir mis à jour les scripts, vous pouvez supprimer les paires de clés inutilisées et expirées.

Remarque :

Si un utilisateur parent est désactivé, toutes les clés API associées sont également désactivées.

La génération de jetons d'API peut-elle être désactivée pour chaque utilisateur?

Oui

Existe-t-il un journal d'audit de l'accès à l'API?

Oui, les clés API sont incluses dans tous les rapports d'audit.

Quels sont les paramètres utilisés pour le cryptage de la session?

https TLS 1.2 AES256