Benutzerverwaltung

Verfügbare Funktionen

Plattformverwaltungs-APIs stellen die folgenden Plattformfunktionen bereit:

Verwaltungsszenarien	Authentifizierungsmethoden
Benutzerverwaltung – Erstellen, Aktualisieren oder Löschen von Benutzern oder Gruppen und Verwalten von Organisationseinstellungen	Externe Anwendungen

Basis-URL

Alle Plattformverwaltungs-API-Aufrufe erfolgen mithilfe von HTTP-Methoden an die Basis-URL.

Es wird empfohlen, die Daten, die Sie über API-Aufrufe senden, mit dem https-Protokoll zu verschlüsseln.

Hinweis:

Bei Automation Cloud- und Automation Suite-Bereitstellungen enthalten alle Identity Server-URLs das Segment /identity_.
Bei eigenständigen Bereitstellungen enthalten alle Identity Server-URLs das Segment /identity.

Ressourcenliste

Plattformverwaltungs-APIs geben Ihrer Anwendung die Steuerung über die folgenden Ressourcen:

Benutzerverwaltung

Audit

GET {BaseURL}/identity/api/AuditQuery/{organizationId} – Ruft die Überwachungsprotokolle für die angegebene Organisations-ID ab.
GET {BaseURL}/identity/api/AuditQuery/{organizationId}/download – Lädt die Prüfungsprotokolle für die angegebene Organisations-ID herunter.

„Gruppieren“ (Group)

GET {BaseURL}/identity/api/Group/{partitionGlobalId} – Ruft alle lokalen und integrierten Gruppen von der angegebenen Partitions-ID ab (entweder Organisation oder Mandant).
GET {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} – Ruft die angegebene lokale oder integrierte Gruppe in der angegebenen Partitions-ID ab.
POST {BaseURL}/identity/api/Group – Erstellt eine neue lokale Gruppe.
PUT {BaseURL}/identity/api/Group/{groupId} – Aktualisiert die Informationen einer lokalen Gruppe.
DELETE {BaseURL}/identity/api/Group/{partitionGlobalId} – Löscht alle lokalen Gruppen aus der angegebenen Partitions-ID (entweder Organisation oder Mandant).
DELETE {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} – Löscht die angegebene lokale Gruppe.

MessageTemplate

GET {BaseURL}/identity/api/MessageTemplate – Ruft eine Nachrichtenvorlage mit dem bereitgestellten Filter ab.
GET {BaseURL}/identity/api/MessageTemplate/{templateId} – Ruft die angegebene Nachrichtenvorlage ab.
PUT {BaseURL}/identity/api/MessageTemplate/{templateId} – Aktualisiert die angegebene Nachrichtenvorlage.

Robot-Konto

GET {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} – Ruft alle Roboterkonten in der angegebenen Partitions-ID ab (entweder Organisation oder Mandant).
GET {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} – Ruft das angegebene Roboterkonto in der angegebenen Partitions-ID ab.
POST {BaseURL}/identity/api/RobotAccount – Erstellt ein neues Roboterkonto.
PUT {BaseURL}/identity/api/RobotAccount/{robotAccountId} – Aktualisiert die angegebenen Roboterkontoinformationen.
DELETE {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} – Löscht das angegebene Roboterkonto.
DELETE {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} – Löscht alle Roboterkonten in der angegebenen Partitions-ID.

Einstellung

GET {BaseURL}/identity/api/Setting – Ruft eine Anwendungseinstellung basierend auf einer Liste von Schlüsseln für einen bestimmten Mandanten ab.
PUT {BaseURL}/identity/api/Setting – Aktualisiert oder erstellt neue Einstellungen in einem bestimmten Mandanten.

Benutzer

GET {BaseURL}/identity/api/User/{userId} – Ruft Informationen über den angegebenen Benutzer ab.
POST {BaseURL}/identity/api/User – Erstellt einen neuen Benutzer. Dieser Endpunkt ist idempotent: Beim Versuch, einen Benutzer zu überschreiben, wird der vorhandene gelöscht.
POST {BaseURL}/identity/api/User/BulkCreate – Erstellt Benutzer in großen Mengen.
POST {BaseURL}/identity/api/User/{userId}/changepassword – Aktualisiert das Kennwort für den angegebenen Benutzer.
PUT {BaseURL}/identity/api/User/{userId} – Aktualisiert die angegebenen Benutzerinformationen.
DELETE {BaseURL}/identity/api/User – Löscht alle Benutzer.
DELETE {BaseURL}/identity/api/User/{userId} – Löscht den angegebenen Benutzer.

UserLoginAttempt

GET {BaseURL}/identity/api/User/{userId}/loginAttempts – Ruft die Anmeldeversuche des angegebenen Benutzers ab.

Bereiche pro API-Ressource

Scopes definieren den Zugriff Ihrer Anwendung auf die Ressourcen der Plattformverwaltung.

Um beispielsweise ein Authentifizierungstoken für Ihre Anwendung zu generieren, übergeben Sie mehrere Scopes. Wenn Ihre Anwendung einen API-Aufruf für den Zugriff auf eine Ressource durchführt, wird das Token anhand der Ressourcen-Scopes validiert. Wenn die Ressource in den Scopes enthalten ist, die Sie bei der Tokenanforderung übergeben haben, ist der Aufruf erfolgreich und es wird weiter auf Benutzerberechtigungen pro Endpunkt geprüft (Leseberechtigungen für GET-Anforderungen und Schreibberechtigungen für POST-, PUT- oder DELETE-Anforderungen). Andernfalls weist der Server den Aufruf zurück.

Berechtigungen pro Endpunkt

Berechtigungen gewähren Ihren Anwendungsbenutzern den Zugriff auf eine bestimmte Funktion innerhalb einer Ressource. Jede Berechtigung ist mit einem Scope verknüpft. Nachdem Ihre Anwendung erfolgreich auf die Ressource zugegriffen hat, überprüft der Server, ob der authentifizierte Benutzer über die richtige Berechtigung für die entsprechende Methode des Endpunkts verfügt.

Beispielsweise können Sie einige Benutzer daran hindern, Benutzergruppen zu löschen oder zu aktualisieren, sie können sie aber trotzdem anzeigen.

Im Allgemeinen erfordern GET-Methoden Leseberechtigungen, während POST-, PUT- und DELETE-Methoden Schreibberechtigungen erfordern.

Liste mit Scopes und Berechtigungen

Benutzerverwaltung

Die folgende Tabelle fasst die erforderlichen Scopes und Berechtigungen zum Ausführen einer bestimmten Aktion zusammen:

Ressource	Scopes	Berechtigungen
Prüfungsabfrage	PM.Audit	PM.Audit.Read (für GET-Anforderungen)
„Gruppieren“ (Group)	PM.Group	PM.Group.Read (für GET-Anforderungen) PM.Group.Write (für POST-, PUT- und DELETE-Anforderungen)
MessageTemplate	PM.MessageTemplate	PM.MessageTemplate.Read (für GET-Anforderungen) PM.MessageTemplate.Write (for PUT requests)
Robot-Konto	PM.RobotAccount	PM.RobotAccount.Read (für GET-Anforderungen) PM.RobotAccount.Write (für POST-, PUT- und DELETE-Anforderungen)
Einstellung	PM.Setting	PM.Setting.Read (für GET-Anforderungen) PM.Setting.Write (für PUT-Anforderungen)
Benutzer	PM.User	PM.User.Read (für GET-Anforderungen) PM.User.Write (für POST-, PUT- oder DELETE-Anforderungen)
UserLoginAttempt	PM.UserLoginAttempt	PM.UserLoginAttempt.Read (für GET-Anforderungen)