Thema
Dieser Artikel enthält Anweisungen zur Verwendung von API-Endpunkten zum Erstellen, Aktualisieren und Löschen Ihrer NinjaOne-Endbenutzer und -Techniker.
Umgebung
Öffentliche API von NinjaOne
Beschreibung
- Wichtige Hinweise
- Endbenutzer und Techniker über die API erstellen
- Endbenutzer und Techniker über API bearbeiten
- Endbenutzer und Techniker über API löschen
- Zusätzliche Ressourcen
Wichtige Hinweise
- Über die API erstellte Techniker erhalten standardmäßig eine Registrierungs-E-Mail.
- Über die API erstellte Endbenutzer erhalten standardmäßig keine Registrierungs-E-Mail
- Sie können das Endbenutzer-Dashboard unter " Weitere Filter" nach "E-Mail-Einladung" filtern, um den Status "Ausstehend", "Abgelaufen" und "Registriert" anzuzeigen. Mit der Aktion "Einladung erneut senden" können Sie die Registrierungs-E-Mail an einen oder mehrere Benutzer senden.
- Sie können die Namen von Endbenutzern, die über System for Cross-domain Identity Management (SCIM) hinzugefügt wurden, nicht löschen oder ändern, aber Sie können Rollen und Organisationen hinzufügen oder entfernen (sofern die Organisation nicht über SCIM verwaltet wird).
- Wenn Sie bei der Erstellung des Endbenutzers keine Organisation angeben, gewährt NinjaOne dem Benutzer Zugriff auf alle Organisationen.
- Techniker oder Systemadministratoren können nicht über die API gelöscht werden.
- Eine Liste der Endpunkte finden Sie in der Dokumentation zur öffentlichen API unter " Hilfe-Ressourcen " (oben rechts auf der NinjaOne-Plattform).
Endbenutzer und Techniker über die API erstellen
Bei der Erstellung neuer Benutzer müssen Sie die folgenden Daten angeben:
- Benutzertyp (Endbenutzer, Techniker oder Kontakt)
- Vorname
- Nachname
- E-Mail-Adresse
Optional können Sie folgende Daten angeben:
- Telefon
- Funktion (nur für Endbenutzer)
- Organisation (nur für Endbenutzer und Kontakte)
Endbenutzer und Techniker über API bearbeiten
Sie können die folgenden Felder über die API ändern:
- Vorname (ändern)
- Nachname (ändern)
- Rollen (nur für Endbenutzer entfernen oder hinzufügen)
- Organisation (nur für Endbenutzer ändern)
Wenn Sie die Organisation in
" " ändern, wird der Benutzer keiner Organisation zugeordnet.Endbenutzer und Techniker über API löschen
Um einen Endbenutzer oder Techniker zu löschen, geben Sie die ID an.
Beispiel: Endbenutzer erstellen
Das folgende Beispiel zeigt die Anfrage und Antwort für den Endpunkt (POST) /api/v2/user/end-users.
Anfrage
{
"firstName": "Pete",
"lastName": "Birk",
"email": "[email protected]",
"phone": "+15121234567",
"organizationId": 5,
"fullPortalAccess": true
}Antwort
{
"id": 43,
"uid": "exxxaad6-xxe6-4fxx-b67b-bexxxc51c77x",
"firstName": "User",
"lastName": "Name",
"email": "[email protected]",
"phone": "+15121234567",
"enabled": true,
"mustChangePw": false,
"mfaConfigured": true,
"userType": "END_USER",
"invitationStatus": "REGISTERED",
"organizationId": 5,
"assignedDeviceIds": null
"deviceIds": null,
"fullPortalAccess": true
"authType": "SSO",
"scimUser": false
}