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

API OAuth Token Konfiguration

Thema

In diesem Artikel wird erläutert, wie Sie OAuth 2.0 zur Authentifizierung von Anfragen an die öffentliche NinjaOne-API verwenden.

Umgebung

NinjaOne Public API

Beschreibung

Die NinjaOne Public API verwendet OAuth 2.0 zur Authentifizierung von Anfragen. OAuth 2.0 ermöglicht Anwendungen den Zugriff auf NinjaOne-Ressourcen (wie z. B. Überwachungsinformationen), die über die Anwendungsprogrammierschnittstelle (API) bereitgestellt werden.

Nur Systemadministratoren dürfen OAuth-Token für die öffentliche NinjaOne-API konfigurieren. Um das OAuth-Protokoll für die Authentifizierung Ihrer App bei NinjaOne nutzen zu können, benötigen Sie zunächst eine OAuth-App-Berechtigung von NinjaOne. Die OAuth-App richtet für Sie eine Autorisierungsgewährung ein. OAuth 2.0 unterstützt verschiedene Gewährungstypen. Die öffentliche NinjaOne-API unterstützt jedoch nur die Gewährungstypen „Autorisierungscode“ und „Implicit “.

Wenn Sie Fragen zur API-Konfiguration, zur Dokumentation oder zu OAuth-Tokens haben, können Sie sich unter [email protected] an unser API-Team wenden.

OAuth-Client-Anwendung generieren

Führen Sie die folgenden Schritte aus, um eine OAuth-Client-App-ID in NinjaOne zu generieren.

  1. Navigieren Sie zu den API-Einstellungen unter „Administration “ → „Apps “ → „API“.
  2. Öffnen Sie die Registerkarte „Client-App-IDs “ und klicken Sie auf „+ Client-App hinzufügen“.
API_add client app.png
Abbildung 1: Neue Client-App-Konfiguration in NinjaOne hinzufügen
  1. Wählen Sie eine Option aus dem Dropdown-Menü „Anwendungsplattform“ aus, um weitere Datenfelder zu generieren.
Je nach Ihrer Auswahl in diesem Schritt sind bestimmte Berechtigungstypen möglicherweise nicht verfügbar.
  1. Verwenden Sie die folgende Tabelle als Hilfe beim Ausfüllen der entsprechenden Felder.
FeldBeschreibung
NameGeben Sie den Titel ein, der auf dem Einwilligungsbildschirm als Name der Client-Anwendung angezeigt wird.
Dieser Name wird in NinjaOne unter „Administration → Apps → API → OAuth-Token“ angezeigt.
Weiterleitungs-URLsGeben Sie eine oder mehrere Adressen ein, an die NinjaOne OAuth-Antworten sendet. Diese Option ist bei Verwendung der Option „Native Application Platform“ nicht konfigurierbar.
Bereiche

Diese Optionen ermöglichen den Zugriff auf alle öffentlichen API-Ressourcen eines bestimmten Typs.

  • Überwachung: Gewährt Lesezugriff auf Überwachungsdaten und die Organisationsstruktur.
  • Verwaltung: 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 weiterer Aktionen.
  • Steuerung: Aktiviert den Fernzugriff über die API.
Zulässige Berechtigungstypen

NinjaOne verwendet OAuth 2.0-Berechtigungstypen für die Client-Anwendung, die im Namen eines Benutzers handelt.

  • Autorisierungscode: Der Autorisierungscode ist ein temporärer Code, den der Client gegen ein Zugriffstoken eintauscht. NinjaOne ruft den Code vom Autorisierungsserver ab, wo der Benutzer einsehen kann, welche Informationen der Client anfordert, und die Anfrage genehmigen oder ablehnen kann.
  • Client-Anmeldedaten: Dieser Ablauf umgeht den Code-Austausch und stellt eine Alternative zum Autorisierungscode dar. Stattdessen wird das Zugriffstoken sofort im Query-String-Fragment an den Client zurückgegeben.
  1. Klicken Sie nach Abschluss der Konfiguration auf „Speichern“.

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

delete client app.png
Abbildung 2: Bearbeiten oder Löschen einer Client-App-Konfiguration in NinjaOne

Weitere Ressourcen

Weitere Informationen zur Verwendung der API mit NinjaOne finden Sie in der NinjaOne-Dokumentation: Öffentliche API.

FAQ

Nächste Schritte