Sie sind bereits NinjaOne-Kunde? Melden Sie sich an, um weitere Leitfäden und die neuesten Updates zu sehen.

API OAuth Token Konfiguration

Thema

Die öffentliche API von NinjaRMM verwendet OAuth2 zur Authentifizierung von Anfragen. OAuth 2.0 ermöglicht Anwendungen den Zugriff auf NinjaRMM-Ressourcen (z. B. Überwachungsinformationen), die über die API verfügbar sind.

Umgebung

NinjaOne API 

Beschreibung

Wenn Sie Fragen zur API-Konfiguration, zur Dokumentation oder zu OAuth Tokens haben, können Sie unser API-Team unter [email protected] kontaktieren . 
Nur Systemadministratoren können OAuth-Tokens für NinjaOne API konfigurieren. 

Über

Um das OAuth-Protokoll für die Authentifizierung Ihrer Anwendung mit NinjaOne zu verwenden, benötigen Sie zunächst ein OAuth-Anmeldedatum vom NinjaOne-System. Die OAuth-App richtet für Sie eine Autorisierungserlaubnis ein. OAuth 2.0 unterstützt verschiedene Grant-Typen. NinjaOne Public API unterstützt jedoch autorisierungscode und implizite gewährungstypen.

Ihre API-Einstellungen finden Sie unter VerwaltungAppsAPI

Erzeugen einer OAuth-Client-Anwendung

  1. Öffnen Sie auf der API-Seite in NinjaOne die Registerkarte Client-App-IDs und klicken Sie auf Client-App hinzufügen.

API_add client app.png
1. Screenshot: Hinzufügen einer neuen Client-App-Konfiguration in NinjaOne

  1. Wählen Sie eine Option aus der Dropdown-Liste Anwendungsplattform, um weitere Datenfelder zu generieren.
Abhängig von Ihrer Auswahl in diesem Schritt sind bestimmte Förderungsarten möglicherweise nicht verfügbar. 
  1. Verwenden Sie die folgende Tabelle, um die entsprechenden Felder auszufüllen. 
FeldBeschreibung
NameGeben Sie den Titel ein, der als Name der Client-Anwendung im Zustimmungsbildschirm angezeigt werden soll.
Dieser Name wird in der AdministrationAppsAPIOAuth Tokens in NinjaOne angezeigt.
URLs umleitenGeben Sie eine oder mehrere URL(s) ein, an die NinjaOne OAuth-Antworten senden soll.
Dies ist bei Verwendung der Native Application Platform nicht konfigurierbar. Dabei wird ein lokaler Host verwendet. 
ScopeDies ermöglicht den Zugriff auf alle öffentlichen API-Ressourcen eines bestimmten Typs: Überwachung, Verwaltung und Kontrolle. Aktivieren Sie das Kontrollkästchen neben dem Typ, um ihn zu aktivieren. 
  • Überwachen Gewährt Nur-Lese-Zugriff auf Überwachungsdaten und Organisationsstruktur.
  • Management Ermöglicht die Änderung von Geräte- und Organisationsinformationen, einschließlich der Erstellung neuer Organisationen, des Hinzufügens neuer Geräte, der Ausführung von Skripten und anderem. 
  • Kontrolle: Ermöglicht Fernzugriff über API.
  • Aktualisierungs-Token Aus Sicherheitsgründen können die Zugangstoken nur für eine kurze Zeit gültig sein. Sobald sie ablaufen, können Client-Anwendungen ein Refresh-Token verwenden, um das Zugriffstoken "aufzufrischen". Ein Refresh-Token ist ein Artefakt für Anmeldeinformationen, mit dem eine Client-Anwendung neue Zugangstoken erhalten kann, ohne den Benutzer aufzufordern, sich erneut anzumelden.
    • Wählen Sie diese Option unter Erlaubte Förderungsarten
Erlaubte Grant-TypenOAuth 2.0-Gewährungstypen werden für die Client-Anwendung verwendet, die im Namen eines Benutzers handelt. Um Sicherheitsrisiken zu minimieren, beschränken Sie die zulässigen Grant-Typen auf Autorisierungscode, Refresh Token und Implicit. 
  • Berechtigungscode Der Autorisierungscode ist ein temporärer Code, den der Kunde gegen ein Zugangstoken eintauscht. Der Code wird für den Autorisierungsserver eingeholt, wo der Benutzer sehen kann, welche Informationen der Client anfordert, und die Anforderung genehmigen oder ablehnen kann. 
  • Client-Anmeldeinformationen Dieser Fluss umgeht den Schritt des Codeaustauschs und ist eine Alternative zum Autorisierungscode. Stattdessen wird das Zugriffstoken sofort im Abfrage-String-Fragment an den Client zurückgegeben. 

Nachdem die Konfiguration abgeschlossen ist, klicken Sie oben auf der Seite auf  . Sie werden Ihre Client-ID sehen, die Sie kopieren und unter verwenden können, wenn die App mit NinjaOne interagiert. 

Um eine Client-App-ID zu bearbeiten oder zu löschen, bewegen Sie den Mauszeiger über die Zeile und wählen Sie die entsprechende Option rechts auf der Seite. 

client app.png löschen
3. Screenshot: Bearbeiten oder Löschen einer Client-App-Konfiguration in NinjaOne

Zusätzliche Ressourcen:

NinjaOne Öffentliche API Operationen

FAQ

Nächste Schritte