Benutzergruppenendpunkte
Benutzergruppenendpunkte und Parameter
Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen .
Weitere Informationen über diese Server-Benutzergruppen finden Sie auf der Hilfeseite Benutzer- und Gruppenverwaltung .
Neue Benutzergruppe erstellen
Um eine neue Benutzergruppe zu erstellen, verwenden Sie den Endpunkt
POST {baseURL}/v3/usergroups
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
Um eine neue Server-Benutzergruppe zu erstellen, geben Sie den Parameter „contract“ an:
contract (Text): erforderlich. Geben Sie die Parameter für eine Server-Benutzergruppe an:
Name (Zeichenfolge): erforderlich. Geben Sie den Namen einer Server-Benutzergruppe ein.
role (Zeichenfolge): erforderlich. Geben Sie eine Rolle für diese Server-Benutzergruppe ein. Wählen Sie aus den folgenden Optionen aus: „NoAccess“, „Viewer“, „Member“, „Artisan“, „Curator“ und „Evaluated“. Die Standardrolle („Evaluated“) wird zur Laufzeit ausgewertet. Weitere Informationen zu Rollen und Berechtigungen finden Sie auf der Seite Benutzerrollen und -berechtigungen .
Anforderungsbeispiel: cURL
curl --location --request POST 'http://localhost/webapi/v3/usergroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'role=Artisan'
Benutzer zu einer Benutzergruppe hinzufügen
Um einer vorhandenen Benutzergruppe einen oder mehrere vorhandene Benutzer hinzuzufügen, verwenden Sie den Endpunkt
POST {baseURL}/v3/usergroups/{userGroupId}/users
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
Um Benutzer zu einer Server-Benutzergruppe hinzuzufügen, geben Sie die folgenden Parameter an:
userGroupId (Zeichenfolge): erforderlich. Geben Sie die ID der Benutzergruppe ein, der Sie Benutzer hinzufügen möchten.
userIds (Text): erforderlich. Geben Sie durch Kommas getrennt die Liste der Benutzer-IDs ein, die Sie dieser Benutzergruppe hinzufügen möchten.
Active Directory-Gruppe zu einer Benutzergruppe hinzufügen
Um eine Active Directory-Gruppe zu einer vorhandenen Benutzergruppe hinzuzufügen, verwenden Sie den Endpunkt
POST /v3/usergroups/{userGroupId}/activedirectorygroups
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Dieser Endpunkt kann nur für Server-Instanzen verwendet werden, die für die Windows-Authentifizierung konfiguriert sind.
Parameter
userGroupId (Zeichenfolge): erforderlich. Geben Sie die ID einer vorhandenen Benutzergruppe ein, der Sie eine Active Directory-Gruppe hinzufügen möchten.
sid (Zeichenfolge): erforderlich. Geben Sie die Sicherheits-ID (SID) der Active Directory-Gruppe ein. Dies ist eine JSON-Text-Payload. Sie müssen den Wert in Anführungszeichen eingeben, z. B. „S-Meine-SID“.
Alle Benutzergruppen abrufen
Um alle zugänglichen Benutzergruppen-Datensätze abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/usergroups
. Verwenden Sie verschiedene Parameter als Filter für die Suche nach Benutzern.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Nur benutzerdefinierte Benutzergruppen werden abgerufen. Es werden keine Active Directory-Gruppen zurückgegeben.
Parameter
Keine Parameter erforderlich.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Details für eine bestimmte Benutzergruppe abrufen
Um Details zu einer vorhandenen Benutzergruppe abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/usergroups/{userGroupId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Funktioniert nur für Server-Benutzergruppen. Active Directory-Gruppen können von diesem Endpunkt nicht abgerufen werden.
Parameter
userGroupId (Zeichenfolge): erforderlich. Geben Sie eine vorhandene Benutzergruppen-ID ein, um Informationen zu dieser Benutzergruppe abzurufen.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Benutzergruppe aktualisieren
Um den Namen und die Rolle einer vorhandenen Benutzergruppe zu aktualisieren, verwenden Sie den Endpunkt
PUT {baseURL}/v3/usergroups/{userGroupId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
userGroupId (Zeichenfolge): erforderlich. Geben Sie eine Benutzergruppen-ID ein, um diese Benutzergruppe zu aktualisieren.
contract (Text): erforderlich. Zum Aktualisieren einer Benutzergruppe ist der Parameter „contract“ erforderlich. Geben Sie Folgendes an:
name (Zeichenfolge): erforderlich. Geben Sie den Namen einer Benutzergruppe ein.
role (Zeichenfolge): erforderlich. Sie können aus folgenden Optionen wählen: „NoAccess“, „Viewer“, „Member“, „Artisan“, „Curator“ und „Evaluated“. Weitere Informationen zu Rollen und Berechtigungen finden Sie auf der Seite Benutzerrollen und -berechtigungen .
Anforderungsbeispiel: cURL
curl --location --request PUT 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Marketing' \ --data-urlencode 'role=Artisan'
Einen Benutzer aus einer Benutzergruppe entfernen
Um einen bestimmten Benutzer aus einer vorhandenen Benutzergruppe zu entfernen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Wenn der Benutzer nicht Teil der Benutzergruppe ist, wird eine OK-Antwort zurückgegeben.
Parameter
userGroupId (Zeichenfolge): erforderlich. Geben Sie die ID der Benutzergruppe ein, aus der Sie den Benutzer entfernen möchten.
userId (Zeichenfolge): erforderlich. Geben Sie die Benutzer-ID ein, die Sie aus der Benutzergruppe entfernen möchten.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Active Directory-Gruppe aus einer Benutzergruppe entfernen
Um eine Active Directory-Gruppe aus einer vorhandenen Benutzergruppe zu entfernen, verwenden Sie den Endpunkt
DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Dieser Endpunkt kann nur für Server-Instanzen verwendet werden, die für die Windows-Authentifizierung konfiguriert sind.
Parameter
userGroupId (Zeichenfolge): erforderlich. Geben Sie die ID der Benutzergruppe ein, aus der Sie die Active Directory-Gruppe entfernen möchten.
adGroupSid (Zeichenfolge): erforderlich. Geben Sie die Sicherheits-ID (SID) der Active Directory-Gruppe ein, die Sie aus der Benutzergruppe entfernen möchten.
Benutzergruppe löschen
Um eine vorhandene Benutzergruppe aus dem System zu löschen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/usergroups/{userGroupId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Die Fehlermeldung „400 Bad Request“ wird zurückgegeben, wenn die Benutzergruppe nicht leer ist und der Abfrageparameter „forceDelete“ auf „false“ gesetzt ist.
Parameter
userGroupId (Zeichenfolge): erforderlich. Geben Sie die Benutzergruppen-ID ein, die Sie löschen möchten.
forceDelete (boolescher Wert): optional. Wenn dieser Parameter auf „true“ gesetzt ist, wird die Benutzergruppe selbst dann gelöscht, wenn diese Benutzergruppe Benutzer enthält.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Objektbeziehungen
Wenn Sie eine Benutzergruppe erstellen, können Sie erstellte Objekte wie folgt verwenden:
Erstelltes Objekt: „ id “ (z. B. "id": "619158e57e607d0011ac3009")
Sie können sie wie folgt verwenden:
userGroupId , wenn Sie eine Benutzergruppe zu einer Sammlung hinzufügen .
userGroupId , wenn Sie Benutzergruppenberechtigungen einer Sammlung aktualisieren .
userGroupId , wenn Sie eine Benutzergruppe aus einer Sammlung entfernen .
userGroupId , wenn Sie Anmeldedaten für eine Benutzergruppe freigeben möchten.
userGroupId , wenn Sie eine Benutzergruppe aus Anmeldedaten entfernen möchten.
userGroupId , wenn Sie eine Benutzergruppe zu einer Datenverbindung hinzufügen möchten.
userGroupId , wenn Sie eine Benutzergruppe aus einer Datenverbindung entfernen möchten.
Beispiele für eine Postman-Anforderung
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden .