Authentification

Les API DigiCert CertCentral utilisent des clés d’API pour l’authentification et l’autorisation. L’authentification auprès du service devrait être relativement simple si vous avez déjà travaillé avec l’authentification basée sur l’en-tête.

Authentification basée sur l’en-tête

Chaque demande transmise au service doit inclure une clé d’API. Cela s’effectue à l’aide de l’en-tête HTTP personnalisé X‑DC‑DEVKEY. Voici une simple demande d’API envoyée au point de terminaison List users de l’API Services à l’aide de la commande cURL.

Veillez à bien remplacer {{api_key}} par votre clé d’API effective.

bash
curl -X GET \
  'https://www.digicert.com/services/v2/user' \
  -H 'Content-Type: application/xml' \
  -H 'X-DC-DEVKEY: {{api_key}}'

Générer une clé d’API

Une fois la clé générée, elle ne s’affiche qu’une seule fois. Il n’existe aucun moyen pour récupérer une clé d’API. S’il vous arrive de perdre une clé, vous devrez révoquer la clé perdue et en générer une autre.

Les clé d’API sont générées et gérées depuis votre compte CertCentral. Pour générer une nouvelle clé, connectez-vous à votre compte CertCentral.

  1. Dans votre compte CertCentral, depuis le menu latéral, cliquez sur Automation > API Keys (Automation > Clé d’API).

  2. Sur la page Clés d’API, cliquez sur Ajouter une clé d’API.

  3. Dans la fenêtre Add API Key (Ajouter une clé d’API), saisissez une Description pour la nouvelle clé.

    Par exemple, saisissez le nom de l’application ou de l’utilisateur auquel vous souhaitez assigner la clé.

  4. Dans la liste déroulante User (Utilisateur), sélectionnez l’utilisateur auquel vous souhaitez assigner la clé.

N’oubliez pas que lorsque vous assignez une clé d’API à un utilisateur, vous assignez également les autorisations de cet utilisateur à la clé. En d’autres termes, la clé sera autorisée à effectuer toutes les actions que l’utilisateur peut exécuter.

  1. (facultatif) Pour restreindre les autorisations des clés d’API à un ensemble d’actions défini, dans le menu déroulant API key restrictions (optional) (Restrictions des clés d’API, facultatif), sélectionnez l’une des options suivantes :

  2. Cliquez sur Add API Key (Ajouter une clé d’API).

  3. Dans la fenêtre « New API Key » (Nouvelle clé d’API), cliquez sur la clé générée pour la copier.

  4. Enregistrez la clé dans un emplacement sécurisé. (N’oubliez pas que la clé ne s’affiche qu’une seule fois.)

  5. Une fois la clé enregistrée, cliquez sur I understand I will not see this again (Je comprends que je ne verrai plus cet élément).

Et ensuite ?

Vous êtes à présent prêt à utiliser les API DigiCert CertCentral. Votre nouvelle clé d’API est ajoutée à la liste de clés sur votre page « Account Access » (Accéder au compte). Retournez à cette page pour suivre (les clés actives et révoquées) ou révoquer des clés d’API.

Modifier une clé d’API

Au besoin, vous pouvez modifier une clé d’API pour mettre à jour la description ou les autorisations.

  1. Dans votre compte CertCentral, depuis le menu latéral, cliquez sur Automation > API Keys (Automation > Clé d’API).

  2. Sur la page Clés d’API, cliquez sur le lien Nom de la clé d’API.

  3. Dans la fenêtre « API Key » (Clé d’API), modifiez la Description ou mettez à jour les permissions de la clé d’API.

  4. Pour supprimer les restrictions de clé d’API, dans le champ API key restrictions (optional) (Restrictions de clé d’API, facultatif), cliquez sur le X situé à la fin de l’entrée. Ce champ affiche désormais None (Aucune).

  5. Pour mettre à jour les autorisations des clés d’API, dans la liste déroulante API key restrictions (optional) (Restrictions des clés d’API, facultatif), sélectionnez l’une des options suivantes :

N’oubliez pas que lorsque vous appliquez des restrictions d’autorisation à une clé d’API active, vous invalidez toute intégration utilisant cette clé si des autorisations étendues sont requises. Pour réparer ces intégrations invalidées, vous devrez modifier la clé et supprimer les restrictions.

  1. Cliquez sur Add API Key (Ajouter une clé d’API).

Informations connexes