Vous êtes déjà client NinjaOne ? Connectez-vous pour consulter d'autres guides et les dernières nouvelles.

Configuration du jeton OAuth d’API

Rubrique

Cet article explique comment utiliser OAuth 2.0 pour l'authentification des demandes adressées à l'API publique NinjaOne.

Environnement

API publique NinjaOne

Description

L'API publique NinjaOne utilise OAuth 2.0 pour l'authentification des requêtes. OAuth 2.0 permet aux applications d'accéder aux ressources NinjaOne (telles que les informations de surveillance) disponibles via l'interface de programmation d'application (API).

Seuls les administrateurs système sont habilités à configurer les jetons OAuth pour l’API publique NinjaOne. Pour commencer à utiliser le protocole OAuth pour l’authentification de votre application auprès de NinjaOne, vous devez d’abord disposer d’un identifiant d’application OAuth fourni par NinjaOne. L’application OAuth configurera alors un mode d’autorisation pour vous. OAuth 2.0 prend en charge différents types d’autorisation. Cependant, l’API publique NinjaOne ne prend en charge que les modes « Code d’autorisation » et « Autorisation implicite ».

Si vous avez des questions concernant la configuration de l’API, la documentation ou les jetons OAuth, vous pouvez contacter notre équipe API à l’adresse [email protected].

Générer une application cliente OAuth

Pour générer un ID appli cliente OAuth dans NinjaOne, procédez comme suit.

  1. Accédez aux paramètres de l’API dans Administration → Applications → API.
  2. Ouvrez l’onglet « ID appli cliente » et cliquez sur « + Ajouter une application cliente ».
API_add client app.png
Figure 1: Ajouter une nouvelle configuration d’application client dans NinjaOne
  1. Sélectionnez une option dans le menu déroulant « Plateforme de l’application » pour générer davantage de champs de données.
Certains types d’autorisation peuvent ne pas être disponibles en fonction de votre sélection à cette étape.
  1. Utilisez le tableau suivant pour vous aider à remplir les champs applicables.
Champ Description
Nom Saisissez le titre qui s'affichera comme nom de l'application cliente dans l'écran de consentement.
Ce nom s'affichera dans Administration → Applications → API → Jetons OAuth dans NinjaOne.
URL de redirection Saisissez une ou plusieurs adresses vers lesquelles NinjaOne enverra les réponses OAuth. Ce paramètre n'est pas configurable lorsque vous utilisez l'option « Plateforme de l’application native ».
Périmètres

Ces options permettent d’accéder à toutes les ressources API publiques d’un certain type.

  • Surveillance: accorde un accès en lecture seule aux données de surveillance et à la structure de l’organisation.
  • Gestion: permet de modifier les informations relatives aux appareils et à l’organisation, notamment de créer des nouvelles organisations, d’ajouter de nouveaux appareils, d’exécuter des scripts, etc.
  • Contrôle: active l'accès à distance via l'API.
Types d’autorisation permis

NinjaOne utilise les types d’autorisation OAuth 2.0 pour l’application cliente agissant au nom d’un utilisateur.

  • Code d’autorisation: le code d’autorisation est un code temporaire que le client échangera contre un jeton d’accès. NinjaOne obtient ce code auprès du serveur d’autorisation, où l’utilisateur peut consulter les informations demandées par le client et approuver ou refuser la demande.
  • Identifiants du client: ce flux contourne l’étape d’échange de code et constitue une alternative au code d’autorisation. À la place, le jeton d’accès est immédiatement renvoyé au client dans le fragment de chaîne de requête.
  1. Après avoir complété la configuration, cliquez sur « Enregistrer ».

Pour modifier ou supprimer l’ID d’une application cliente, déplacez le curseur de votre souris sur la ligne correspondante et sélectionnez l’option appropriée.

delete client app.png
Figure 2: Modifier ou supprimer la configuration d’une application client dans NinjaOne

Ressources complémentaires

Consultez la NinjaOne Documentation : API publique pour en savoir plus sur l’utilisation de l’API avec NinjaOne.

FAQ

Pour aller plus loin