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

Configuration du jeton OAuth d’API

Contenu

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

Environnement

API NinjaOne 

Description

Si vous avez des questions sur 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. 

À propos

Pour commencer à utiliser le protocole OAuth pour l'authentification de votre application avec NinjaOne, vous devez d'abord disposer d'un identifiant OAuth du système NinjaOne. L'application OAuth mettra en place une autorisation pour vous. OAuth 2.0 prend en charge différents types de subventions. Toutefois, l'API publique de NinjaOne prend en charge les éléments suivants code d'autorisation et implicite implicites.

Retrouvez vos paramètres API sous AdministrationAppsAPI

Générer une application client OAuth

  1. Dans la page API de NinjaOne, ouvrez l'onglet Client app IDs et cliquez sur Add client app.

API_add client app.png
Image 1 : Ajouter une nouvelle configuration d'application client dans NinjaOne

  1. Sélectionnez une option dans la liste déroulante Plate-forme d'application pour générer davantage de champs de données.
Certains types de subventions 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 sera affiché comme nom de l'application client dans l'écran de consentement.
Ce nom sera affiché dans la section AdministrationAppsAPIOAuth Tokens dans NinjaOne.
Redirection d'URLEntrez une ou plusieurs URL où NinjaOne enverra les réponses OAuth.
Ceci n'est pas configurable lorsque l'on utilise la plateforme d'applications natives. Il s'agit d'utiliser un hôte local. 
PérimètresCela permet d'accéder à toutes les ressources API publiques d'un certain type : Suivi, gestion et contrôle. Activez la case à cocher à côté du type pour l'activer. 
  • 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 aux organisations, notamment de créer de nouvelles organisations, d'ajouter de nouveaux appareils, d'exécuter des scripts, etc. 
  • Contrôle Autorise l’accès à distance via API.
  • Jeton d'actualisation Pour des raisons de sécurité, les jetons d'accès peuvent être valables pour une courte durée. Lorsqu'ils expirent, les applications clientes peuvent utiliser un jeton de rafraîchissement pour "rafraîchir" le jeton d'accès. En d'autres termes, un jeton de rafraîchissement est un artefact qui permet à une application cliente d'obtenir de nouveaux jetons d'accès sans avoir à demander à l'utilisateur de se connecter à nouveau.
    • Sélectionnez cette option sous Types de subventions autorisés
Types d'autorisation permisLes types de subventions OAuth 2.0 sont utilisés pour l'application cliente agissant au nom d'un utilisateur. Pour minimiser les risques de sécurité, limitez les types de subventions autorisées au code d'autorisation, au jeton de rafraîchissement et à l'autorisation implicite. 
  • Code d’autorisation Le code d'autorisation est un code temporaire que le client échangera contre un jeton d'accès. Le code est obtenu pour le serveur d'autorisation, où l'utilisateur peut voir les informations demandées par le client et approuver ou refuser la demande. 
  • Informations d’identification client Ce flux contourne l'étape de l'échange de codes et constitue une alternative au code d'autorisation. Au lieu de cela, le jeton d'accès est immédiatement renvoyé au client dans le fragment de la chaîne de requête. 

Une fois la configuration terminée, cliquez sur Save en haut de la page. Vous verrez votre identifiant client, que vous pouvez copier et utiliser lorsque l'application interagit avec NinjaOne. 

Pour modifier ou supprimer un identifiant d'application client, déplacez votre curseur sur la ligne et sélectionnez l'option appropriée sur le côté droit de la page. 

supprimer l'application client.png
Image 3 : Modifier ou supprimer la configuration d'une application client dans NinjaOne

Ressources supplémentaires :

Opérations dans l'API publique de NinjaOne

FAQ

Pour aller plus loin