Benutzergruppenendpunkte
Benutzergruppen-Endpunkte und Parameter
Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen .
Weitere Informationen über benutzerdefinierte Gruppen finden Sie auf der Hilfeseite Benutzer- und Gruppenverwaltung .
Neue Benachrichtigungsgruppe erstellen
Um einen neuen Workflow hochzuladen, verwenden Sie den Endpunkt
POST {baseURL}/v3/workflows
.
Parameter
Um eine neue Benutzergruppe zu erstellen, geben Sie den Vertragsparameter an:
updateWorkflowContract (Haupttext): Erforderlich. Geben Sie die Parameter für eine Benutzergruppe an:
name (Zeichenfolge): Erforderlich. Geben Sie einen Namen für die Benachrichtigungsgruppe 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'
Einen Benutzer aus einer Benutzergruppe entfernen
Um einer Benutzergruppe einen oder mehrere Benutzer hinzuzufügen, verwenden Sie den
{baseURL}{id}
Endpunkt POST /v3/usergroups/ /users.
Parameter
Um Benutzer zu einer Benutzergruppe hinzuzufügen, geben Sie die folgenden Parameter an:
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID der Benutzergruppe ein, der Sie Benutzer hinzufügen möchten.
Benutzer-IDs (Body): Erforderlich. Geben Sie die Benutzer-IDs ein, die Sie dieser Benutzergruppe hinzufügen möchten.
Anforderungsbeispiel: cURL
werden hinzugefügt
Eine benutzerdefinierte Benutzergruppe abrufen
Um nach Benutzern zu suchen, verwenden Sie den
{baseURL}
Endpunkt GET /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/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Suchen Sie nach einer bestimmten Benutzergruppe
TUm Informationen über einen spezifischen Workflow abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/workflows/{id}
.
Anmerkung
Funktioniert nur für benutzerdefinierte Benutzergruppen. Active Directory-Gruppen können von diesem Endpunkt nicht abgerufen werden.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzergruppen-ID ein, um Informationen zu dieser Benutzergruppe abzurufen.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Benutzergruppe aktualisieren
Um den Namen und die Rolle einer vorhandenen Benutzergruppe zu aktualisieren, verwenden Sie
PUT {baseURL}/v3/usergroups/{id}
Endpoint.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzergruppen-ID ein, um diese Benutzergruppe zu aktualisieren.
Vertrag (Körper): Erforderlich. Zum Aktualisieren einer Benutzergruppe ist der Vertragsparameter erforderlich. Geben Sie Folgendes an:
name (Zeichenfolge): Erforderlich. Geben Sie einen Namen für die Benachrichtigungsgruppe 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 Befehl
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
Endpunkt.
Anmerkung
Wenn der Benutzer nicht Teil der Gruppe ist, wird eine OK-Antwort zurückgegeben.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID der Benutzergruppe ein, aus der Sie den Benutzer entfernen möchten.
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die Benutzer-ID ein, die Sie aus der Benutzergruppe entfernen möchten.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Löschen Sie eine Benutzergruppe
Um eine bestimmte Benutzergruppe aus dem System zu löschen, verwenden Sie den Befehl
DELETE {baseURL}/v3/usergroups/{id}
Endpoint.
Anmerkung
Die Fehlermeldung „400 fehlerhafte Anforderung“ wird zurückgegeben, wenn die Benutzergruppe nicht leer ist und der Abfrageparameter forceDelete FALSE ist.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die Benutzergruppen-ID ein, die Sie löschen möchten.
hasPrivateDataExemption (boolescher Wert): Optional. Wenn dieser Wert auf True gesetzt ist, wird die Benutzergruppe auch dann gelöscht, wenn diese Benutzergruppe Benutzer enthält.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Objektbeziehungen
Wenn Sie einen Workflow hochladen, können Sie erstellte Objekte wie folgt verwenden:
Objekt erstellt: " workflowId " (z. B. "id": "7917969784f84bd0942f66996ecb8f3")
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 Zugangsdaten für eine Benutzergruppe freigeben möchten .
UserGroupId , wenn Sie eine Benutzergruppe aus den Zugangsdaten 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
LÖSCHEN SIE /v3/usergroups/{userGroupId}/users/{userId}
Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden .