Survol du processus d’authentification du client API
Voici la vue de bout en bout de la façon d’authentifier votre client API auprès du dispositif Défense contre les menaces.

Avant de commencer
Chaque jeton représente une session de connexion HTTPS, qui compte pour les sessions API et les sessions gestionnaire d'appareil. Il peut y avoir un maximum de cinq sessions HTTPS actives. Si vous dépassez cette limite, la session la plus ancienne, la connexion au gestionnaire d'appareil ou le jeton API, expirera pour permettre la nouvelle session. Par conséquent, il est important que vous n’obteniez que les jetons dont vous avez besoin et que vous réutilisiez chaque jeton jusqu’à son expiration, pour ensuite les renouveler. L’obtention d’un nouveau jeton pour chaque appel d’API entraînera une perte de session importante et pourrait bloquer l’accès des utilisateurs au gestionnaire d'appareil. Ces limites ne s’appliquent pas aux sessions SSH.
Procédure
Étape 1 |
Authentifiez l’utilisateur du client API en utilisant la méthode dont vous avez besoin. Votre client est tenu d’authentifier les utilisateurs et de s’assurer qu’ils sont autorisés à accéder au dispositif Défense contre les menaces. Si vous souhaitez fournir des capacités différentielles en fonction des droits d’autorisation, vous devez intégrer cette fonction à votre client. Par exemple, si vous souhaitez autoriser l’accès en lecture seule, vous devez configurer le serveur d’authentification, les comptes d’utilisateurs et autres éléments requis. Ensuite, lorsqu’un utilisateur avec des droits en lecture seule se connecte à votre client, vous devez vous assurer d’émettre uniquement des appels GET. Dans la version v1 de l’API, ce type d’accès à une variable ne peut pas être contrôlé par le dispositif Défense contre les menaces lui-même. À partir de la version v2 de l’API, si vous utilisez des utilisateurs externes et que vous ne filtrez pas les appels en fonction de l’autorisation des utilisateurs, vous obtiendrez des erreurs en cas de non-concordance entre l’autorisation d’un utilisateur et les appels que vous tentez. Pour la version v1, lorsque vous communiquez avec le dispositif, vous devez utiliser le compte d’utilisateur admin sur le dispositif Défense contre les menaces. Le compte admin dispose d’une autorisation complète de lecture/écriture pour tous les objets configurables par l’utilisateur. |
Étape 2 |
Demandez un jeton d’accès attribué par mot de passe en fonction du nom d’utilisateur et du mot de passe à l’aide du compte admin. Consultez Demander un jeton d’accès attribué par mot de passe. |
Étape 3 |
Vous pouvez également demander un jeton d’accès personnalisé pour votre client. Avec un jeton personnalisé, vous pouvez demander explicitement une période de validité et attribuer un nom de sujet au jeton. Consultez Demander un jeton d’accès personnalisé. |
Étape 4 |
Utilisez le jeton d’accès sur les appels d’API dans l’en-tête Authorization: Bearer (Autorisation : porteur). |
Étape 5 |
Avant que le jeton d’accès expire, actualisez le jeton. Consultez Renouveler un jeton d’accès. |
Étape 6 |
Lorsque vous avez terminé, révoquez le jeton s’il n’a pas encore expiré. Consultez Révoquer un jeton d’accès. |