Benutzergruppenendpunkte
Benutzergruppen-Endpunkte und Parameter
Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen .
Weitere Informationen zu benutzerdefinierten Gruppen finden Sie auf der Hilfeseite Benutzer- und Gruppenverwaltung .
Neue Benutzergruppe erstellen
Um einen neuen Benutzergruppendatensatz zu erstellen, verwenden Sie den Endpunkt
POST {baseURL}/v3/usergroups
.
Parameter
Um eine neue Benutzergruppe zu erstellen, geben Sie den Parameter „contract“ an:
contract (Text): erforderlich. Geben Sie die Parameter für eine Benutzergruppe an:
name (Zeichenfolge): Erforderlich. Geben Sie den Namen einer Benutzergruppe ein.
role (Zeichenfolge): erforderlich. Geben Sie eine Rolle für diese 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 einen oder mehrere Benutzer zu einer Benutzergruppe hinzuzufügen, verwenden Sie den Endpunkt
POST {baseURL}/v3/usergroups/{id}/users
.
Parameter
Um Benutzer zu einer Benutzergruppe hinzuzufügen, geben Sie die folgenden Parameter an:
id (Zeichenfolge): erforderlich. Geben Sie die ID der Benutzergruppe ein, der Sie Benutzer hinzufügen möchten.
userIds (Text): erforderlich. Geben Sie die Benutzer-IDs ein, die Sie zu dieser Benutzergruppe hinzufügen möchten.
Anforderungsbeispiel: cURL
Muss noch hinzugefügt werden.
Alle benutzerdefinierten Benutzergruppen abrufen
Um nach Benutzern zu suchen, verwenden Sie den Endpunkt
GET {baseURL}/v3/usergroups
. Verwenden Sie verschiedene Parameter als Filter für die Suche nach Benutzern.
Anmerkung
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'
Nach einer bestimmten Benutzergruppe suchen
Um Informationen über eine bestimmte Benutzergruppe abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/usergroups/{id}
.
Anmerkung
Funktioniert nur für benutzerdefinierte Benutzergruppen. Active Directory-Gruppen können von diesem Endpunkt nicht abgerufen werden.
Parameter
id (Zeichenfolge): erforderlich. Geben Sie eine 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/{id}
.
Parameter
id (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 Benutzergruppe zu entfernen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
.
Anmerkung
Wenn der Benutzer nicht Teil der Gruppe 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'
Benutzergruppe löschen
Um eine bestimmte Benutzergruppe aus dem System zu löschen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/usergroups/{id}
.
Anmerkung
Die Fehlermeldung „400 Bad Request“ wird zurückgegeben, wenn die Benutzergruppe nicht leer ist und der Abfrageparameter „forceDelete“ auf „false“ gesetzt ist.
Parameter
id (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 möchten.
userGroupId , wenn Sie Benutzergruppenberechtigungen einer Sammlung aktualisieren möchten.
userGroupId , wenn Sie eine Benutzergruppe aus einer Sammlung entfernen möchten.
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 von 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 So verwenden Sie Postman .