Une clé API Fleet vous permet de communiquer directement avec votre instance Fleet. Utilisez-en une pour exécuter des scripts, récupérer des données sur les appareils ou connecter Fleet à d'autres outils.

Fonctionnalité

Aperçu

Les clés API Fleet (FleetDM) authentifient les demandes envoyées directement à votre instance Fleet. Vous pouvez les créer de trois manières :

• Depuis Factorial IT, en tant que clé en lecture seule.
• Depuis le tableau de bord Fleet, en tant que jeton lié à votre compte utilisateur Fleet.
• Depuis la ligne de commande, avec le CLI Fleet ou l'API Fleet.

Les jetons API Fleet n'expirent jamais d'eux-mêmes.

Comment utiliser : créer une clé depuis Factorial IT

1. Allez dans Paramètres > Développeurs et faites défiler jusqu'à la section Clé API FleetDM.
2. Entrez un Nom de clé, par exemple l'outil qui utilisera la clé.
3. Cliquez sur Générer la clé.
4. Copiez le jeton affiché dans la fenêtre Clé API FleetDM créée. Il reste disponible par la suite dans le tableau des clés.

Les clés créées depuis Factorial IT sont en lecture seule. Elles peuvent voir chaque appareil et ses données, mais ne peuvent pas modifier les paramètres ou exécuter des actions sur les appareils. Elles conviennent aux intégrations externes qui ont seulement besoin de lire votre instance Fleet.

Pour révoquer une clé, ouvrez le menu ⋯ sur sa ligne dans le tableau Clé API FleetDM et cliquez sur Révoquer. Toute intégration l'utilisant cesse de fonctionner immédiatement.

Gardez le jeton secret. Quiconque le possède peut lire votre inventaire d'appareils.

Créer une clé depuis le tableau de bord Fleet

1. Ouvrez votre tableau de bord Fleet depuis la console via Paramètres > MDM > Ouvrir Fleet.
2. Cliquez sur votre avatar dans le coin supérieur droit et sélectionnez Mon compte.
3. Faites défiler jusqu'à Jeton API.
4. Cliquez sur Obtenir le jeton API.
5. Copiez le jeton. Il appartient à votre compte utilisateur Fleet.

Ce jeton a les mêmes autorisations que votre compte utilisateur Fleet. Gardez-le secret.

Créer une clé depuis la ligne de commande

Avec le CLI Fleet :

fleetctl login --email your-email@example.com --url https://<your-fleet-instance>
fleetctl get api-token

Ou directement via l'API Fleet :

curl -X POST https://<your-fleet-instance>/api/v1/fleet/users/<user-id>/api_token \
  -H "Authorization: Bearer YOUR_EXISTING_TOKEN" \
  -H "Content-Type: application/json"

Utiliser la clé

Envoyez le jeton dans l'en-tête Authorization :

curl https://<your-fleet-instance>/api/v1/fleet/hosts \
  -H "Authorization: Bearer YOUR_FLEET_API_TOKEN"

Régénérer ou révoquer un jeton

• Clé créée depuis Factorial IT : allez dans Paramètres > Développeurs > Clé API FleetDM, ouvrez le menu ⋯ sur sa ligne et cliquez sur Révoquer.
• Jeton lié à votre compte utilisateur Fleet : dans Fleet, allez dans Mon compte et cliquez sur Régénérer le jeton API. L'ancien jeton cesse de fonctionner immédiatement.

Dépannage et FAQ

Dépannage

• Une intégration a cessé de fonctionner. Sa clé a peut-être été révoquée, ou le jeton utilisateur régénéré. Créez une nouvelle clé et mettez à jour l'intégration.
• Une demande de changement de paramètres ou d'exécution d'une action échoue. Les clés créées depuis Factorial IT sont en lecture seule. Utilisez un jeton lié à un compte utilisateur Fleet avec les bonnes autorisations.
• Vous avez perdu le jeton. Pour une clé créée depuis Factorial IT, retrouvez-la dans le tableau des clés. Pour un jeton utilisateur, régénérez-le dans Mon compte dans Fleet.

FAQ

1. Les jetons API Fleet expirent-ils ?
   Non. Ils restent valides jusqu'à ce que vous les révoquiez ou les régénériez.
    
2. Que peut faire une clé créée depuis Factorial IT ?
   Lire chaque appareil et ses données. Elle ne peut pas changer les paramètres ni exécuter des actions sur les appareils.
    
3. Quelles autorisations a un jeton du tableau de bord Fleet ?
   Les mêmes que votre compte utilisateur Fleet.
    
4. Que se passe-t-il lorsque je révoque une clé ?
   Toute intégration l'utilisant cesse de fonctionner immédiatement.