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 OAuth 2.0 zur Authentifizierung von Anfragen an die öffentliche NinjaOne-API verwendet wird.

Umgebung

NinjaOne Öffentliche API

Beschreibung

Die öffentliche NinjaOne-API verwendet OAuth 2.0 zur Authentifizierung von Anfragen. OAuth 2.0 ermöglicht Anwendungen den Zugang zu NinjaOne-Ressourcen (z. B. Informationen zur Überwachung), die über die Anwendungsprogrammierschnittstelle (API) verfügbar sind.

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 die OAuth-App-Anmeldeinformationen 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 „Berechtigungscode“ und „Implicit “.

Wenn Sie Fragen zur API-Konfiguration, zur API-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 bei „Administration “ → „Anwendungen “ → „API“.
  2. Öffnen Sie die Registerkarte „Client-App-IDs “ und klicken Sie auf „+ Client-App hinzufügen“.
API_add client app.png
Abbildung 1: Hinzufügen einer neuen Client-App-Konfiguration in NinjaOne
  1. Wählen Sie eine Option aus dem Dropdown-Menü „Anwendungs-Plattform“ 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.
Feld Beschreibung
Name Geben 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-URLs Geben Sie eine oder mehrere Adressen ein, an die NinjaOne OAuth-Antworten sendet. Diese Option ist bei Verwendung der Option „Native Anwendungs-Plattform“ nicht konfigurierbar.
Scope

Diese Optionen ermöglichen den Zugang zu allen öffentlichen API-Ressourcen eines bestimmten Typs.

  • Überwachung: Gewährt Nur-Lese-Zugriff auf Überwachungsdaten und Organisationsstruktur.
  • Verwaltung: Zulässt 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.
Erlaubte Grant-Typen

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

  • Berechtigungscode: Der Berechtigungscode ist ein temporärer Code, den der Client gegen ein Zugriffstoken eintauscht. NinjaOne ruft den Code vom Autorisierungsserver ab, wo der Nutzer einsehen kann, welche Informationen der Client anfordert, und die Anfrage genehmigen oder verweigern kann.
  • Client-Anmeldeinformationen: Dieser Ablauf umgeht den Codeaustausch und ist eine Alternative zum Berechtigungscode. Stattdessen wird das Zugriffstoken sofort im Query-String-Fragment an den Client zurückgegeben.
  1. Nach Abschluss der Konfiguration klicken Sie 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

Zusätzliche Ressourcen

Um mehr über die Verwendung der API mit NinjaOne zu erfahren, lesen Sie die NinjaOne Documentation: Öffentliche API.

FAQ

Nächste Schritte