Gérer les clés d'accès à l'API publique de SDMC

SDMC dispose d'une API publique permettant d'interroger votre serveur SDMC via vos propres outils d'orchestration, pour en extraire par exemple les logs d'administration.

Pour autoriser ces requêtes, vous devez fournir des clés aux outils tiers.

L'administrateur doit disposer du droit Gérer les clés API. Pour plus d'informations, reportez-vous à la section Gérer les administrateurs dans SDMC.

Le menu Clés API de la console SDMC permet de consulter les clés API générées pour un compte d'entreprise, d'en créer et également de les révoquer en les supprimant. Une fois générée dans SDMC, vous ne pouvez plus consulter la valeur des clés. Assurez-vous de les conserver dans un emplacement sécurisé.

Par défaut, les clés API expirent au bout d'un an.

ATTENTION
Une clé API donne directement des droits d’administration sur le serveur SDMC. Pour éviter toute faille de sécurité, assurez-vous que les postes depuis lesquels les requêtes sur l’API SDMC sont effectuées soient sains et dans un périmètre d'administration restreint, par exemple sur un réseau d'administration dédié.

Pour visualiser des exemples d'utilisation de l'API avec des clés, consultez https://github.com/stormshield/sds-sample-api.

Pour des informations plus générales sur l'API SDMC et son utilisation, consultez la documentation de l'API.

  1. Sélectionnez le menu de gauche Clés API.
    Ce menu n'est visible que si vous disposez du droit d'administration Gérer les clés API.
  2. Cliquez sur Ajouter en haut à droite.
  3. Entrez un nom pour la clé en caractères alpha-numériques. Le nom ne peut pas dépasser 200 caractères.
  4. Cliquez sur Ajouter.
    La zone Clé API indique la chaîne de caractères correspondant à la clé.
  5. Cliquez sur Copier et collez cette chaîne dans un emplacement sécurisé. Cette étape est indispensable si vous voulez utiliser la clé, car pour des raisons de sécurité, elle ne sera ensuite plus affichée.
  6. Cliquez sur Fermer pour revenir à la fenêtre des clés API.
    La clé générée s'affiche dans la liste. Elle est valable pendant un an et sa date d'expiration est affichée. La fenêtre affiche toutes les clés générées pour votre compte d'entreprise.
  1. Sélectionnez le menu de gauche Clés API.
  2. Cliquez sur à droite de la clé que vous souhaitez révoquer.
  3. Cliquez sur Supprimer définitivement.

Les requêtes possibles via l'API de SDMC sont documentées sur cette page. Vous pouvez notamment utiliser ces requêtes pour extraire les logs d'administration du serveur.