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

Configuration du jeton OAuth d’API

Sujet

L'API publique NinjaOne utilise OAuth 2.0 pour authentifier les requêtes. OAuth 2.0 permet aux applications d'accéder aux ressources NinjaOne (telles que les informations de surveillance) mises à disposition via l'API.

Environnement

API NinjaOne

Description

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].

Seuls les administrateurs système peuvent configurer les jetons OAuth pour l'API 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 provenant du système NinjaOne. L'application OAuth configurera une autorisation pour vous. OAuth 2.0 prend en charge différents types d'autorisation. Cependant, l'API publique NinjaOne prend en charge les types d'autorisation par code et par autorisation implicite.

Générer une application cliente OAuth

Pour générer un identifiant d'application client OAuth dans NinjaOne, procédez comme suit.

  1. Accédez aux paramètres de l'API dans AdministrationApplicationsAPI.
  2. Ouvrez l'onglet ID d'application client et cliquez sur+Ajouter une application client.
API_add client app.png
Figure 1: Ajouter une nouvelle configuration d'application cliente dans NinjaOne
  1. Sélectionnez une option dans le menu déroulant Plateforme d'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.
ChampDescription
NomSaisissez le titre qui s'affichera comme nom de l'application cliente dans l'écran de consentement.
Ce nom s'affichera dans AdministrationAppsAPIOAuth Tokens dans NinjaOne.
URL de redirectionSaisissez une ou plusieurs adresses auxquelles NinjaOne enverra les réponses OAuth. Ce paramètre n'est pas configurable lorsque vous utilisez l'option Plateforme d'application native.
Portées

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 de 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 autorisés

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 le code auprès du serveur d'autorisation, où l'utilisateur peut voir quelles informations le client demande 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. Une fois la configuration terminée, cliquez sur Enregistrer.

Pour modifier ou supprimer un ID d'application client, placez le curseur de votre souris sur la ligne et sélectionnez l'option appropriée.

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

Ressources supplémentaires

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

FAQ

Pour aller plus loin