Créer des jetons d’API

Créez des jetons pour authentifier vos API.

Les jetons d’API contiennent des informations d’authentification et sont liés à des utilisateurs spécifiques ou à une organisation entière. Les jetons d’API envoient des informations d’identification sur l’utilisateur ou l’organisation au serveur d’API pour indiquer si l’utilisateur a accès ou non à l’API, afin de garantir la sécurité.

Comme de nombreux autres fournisseurs d’API, Juniper Mist propose de générer des jetons d’API pour l’authentification (dans l’en-tête HTTP). Lorsqu’il s’agit de jetons, Juniper Mist utilise les termes jeton et clé de manière interchangeable.

En Juniper Mist, il existe deux types de jetons d’API :

Jeton d’organisation

Les jetons d’organisation sont utiles lorsque vous créez une application qui automatise le travail pour votre organisation. Plusieurs utilisateurs doivent accéder à l’application et utilisent donc le même jeton d’organisation pour s’authentifier.
- Le jeton persiste sous l’organisation Mist.
- Le jeton n’est lié à aucun utilisateur spécifique, ce qui signifie que l’accès ne dépend pas de l’accès d’un utilisateur à l’organisation.
- Prend en charge les jetons N org, qui peuvent avoir différents privilèges.
- Le jeton ne peut être utilisé que pour cette organisation spécifique.
- La limitation du débit est effectuée par le jeton individuel. Par exemple, si OrgToken1 consomme 5000 appels d’API et atteint la limite de débit, OrgToken2 n’est pas affecté.

Jeton d’utilisateur

Les jetons d’utilisateur sont utiles lorsque vous devez vous authentifier pour vous-même, comme lors de l’exécution d’un script, par exemple.
- Le jeton d’API assume les mêmes privilèges que les privilèges de compte attribués à l’utilisateur affecté.
- Le jeton est lié à l’utilisateur spécifique, ce qui signifie que l’accès est directement corrélé à l’accès de l’utilisateur à l’organisation.
- Le jeton peut être utilisé pour n’importe quel fournisseur de services gérés (MSP) ou organisation auquel l’utilisateur a accès.
- Prend en charge N jetons, qui ont tous le même privilège que le compte d’utilisateur.
- La limitation du débit est effectuée par le compte lié à l’utilisateur. Par exemple, si UserToken1 consomme 5000 appels d’API et atteint la limite de débit, UserToken2 ET la connexion du compte à l’interface graphique sont affectés.

Vous pouvez créer des jetons d’API via le portail Mist ou l’explorateur d’API REST.

Créer un jeton d’organisation dans le portail Mist

Dans le menu de gauche du portail Juniper Mist, sélectionnez Organisation > Administrateur > Paramètres.
Faites défiler vers le bas jusqu’à la section Jeton d’API et cliquez sur Créer un jeton.
Sélectionnez un niveau d’accès pour définir les autorisations du jeton.
Cliquez sur Générer.
Cliquez sur le bouton Copier à côté du champ Clé et rangez-le quelque part pour le conserver.

Note:
La seule fois où vous verrez la clé entière et non tronquée, c’est lors de la création. Vous ne pourrez plus jamais voir la clé complète. Si vous égarez la clé, vous devrez en créer une nouvelle.
Cliquez sur Terminé en bas de la fenêtre.
Cliquez sur Enregistrer dans le coin supérieur droit de la page.

Créer un jeton d’utilisateur dans le portail Mist

Vous pouvez générer un jeton d’utilisateur API à partir de la page Mon compte du portail Mist.

Pour générer un jeton d’utilisateur d’API :

Dans l’angle supérieur droit du portail Juniper Mist, cliquez sur l’icône Compte Juniper Mist, puis sur Mon compte.
Dans la section Jeton d’API, cliquez sur Créer un jeton. Si vous avez activé l’authentification unique pour votre organisation, vous ne pourrez pas créer de jetons d’utilisateur API.
Entrez un nom pour le jeton et cliquez sur Générer. La clé générée est le jeton d’API de l’utilisateur.
Cliquez sur le bouton Copier en regard du champ Clé.

Assurez-vous de ranger la clé quelque part pour la garder en lieu sûr, car vous ne pourrez plus la voir entièrement. Si vous égarez la clé, vous devrez en créer une nouvelle.
Cliquez sur Terminé.

Note:
Si vous devez supprimer un jeton d’utilisateur, cliquez sur le jeton dans la section Jeton d’API de la page Mon profil , puis cliquez sur Supprimer dans la page Modifier le jeton.

Créer un jeton d’utilisateur ou d’organisation à l’aide de l’explorateur d’API REST

Connectez-vous au portail Juniper Mist.

Note:
Vous devez être connecté au portail pour utiliser l’explorateur d’API REST.
Ouvrez une nouvelle fenêtre de navigateur et collez votre URL : {api-host}/api/v1/self/apitokens.

Note:
À la place de {api-host}, vous devez utiliser le point de terminaison d’API de votre région globale. Reportez-vous à la section Points de terminaison d’API et régions globales.

L’explorateur d’API REST est la page d’API pour le contrôle des jetons. Ici, vous pouvez créer, lire, mettre à jour et supprimer des jetons et des informations sur les jetons. Cette page affiche d’abord les jetons que vous avez déjà créés.

Cette page vous permet également, ainsi qu’à d’autres utilisateurs, d’effectuer un appel d’API directement à partir du navigateur. Avec le type de média : applications/json déjà sélectionné par défaut, une requête GET sera effectuée pour vous montrer une liste de vos jetons. Une clé tronquée s’affichera pour tous les jetons précédemment créés.

Cliquez sur POST.

La réponse sera similaire à cet exemple :

Copiez la clé (jeton) et conservez-la pour la conserver.

Note:
L’API Juniper Mist n’affichera plus jamais le jeton réel (clé) dans son intégralité, où que ce soit, après la création de la clé. Une fois que vous avez quitté cette page et que vous y êtes revenu, la clé apparaîtra, mais dans une version tronquée. Vous devez traiter cette clé comme un mot de passe et la stocker dans un endroit sûr. Si vous perdez cette clé, vous devrez en créer une nouvelle.

Note:
Si vous envisagez de partager des scripts Python avec d’autres personnes, veillez à ne pas stocker votre jeton d’API dans le script lui-même et à utiliser un fichier d’environnement (.mist_env) à sa place. Les fichiers d’environnement stockent les informations sensibles dans le script pour vous, de sorte que vous n’avez pas à partager vos informations sensibles directement dans votre script. Pour plus d’informations, reportez-vous à https://github.com/tmunzer/mist_library?tab=readme-ov-file#environment-file.