REST API-Methoden zum Verwalten von Gruppen, einschließlich Erstellen, Aktualisieren, Auflisten und Löschen von Gruppen.
Eine POST
-Methode zum Erstellen einer neuen Benutzergruppe.
POST /api/v1/groups/
{
"name" : <string>,
"description" : <string_may_be_null>,
}
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Eine PUT
-Methode zum Aktualisieren einer Benutzergruppe.
PUT /api/v1/groups/
<groupId>
{
"name" : <string>,
"description" : <string_may_be_null>,
}
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Eine GET
-Methode zur Auflistung von Benutzergruppen.
GET /api/v1/groups/
[
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}, ...
]
Eine DELETE
-Methode zum Löschen einer Benutzergruppe und zum Entfernen aller Mitglieder aus dieser Gruppe.
DELETE /api/v1/groups/
<groupId>
Gibt 204 No Content
zurück, falls erfolgreich. Im Falle eines Konflikts wird 409 Conflict
zurückgegeben.
Eine DELETE
-Methode zum Löschen mehrerer Gruppen in großen Mengen und zum Entfernen aller Mitglieder aus dieser Gruppe.
DELETE /api/v1/groups/bulk-delete
Gibt 204 No Content
zurück, falls erfolgreich. Im Falle eines Konflikts wird 409 Conflict
zurückgegeben.
Eine GET
-Methode zum Auflisten der Berechtigungsobjekte einer Gruppe.
GET /api/v1/groups/{groupId}/permissions
[{
"objectId" : 34,
"objectType": "SEGMENT",
"permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
},
{
"objectId" : "234",
"objectType": "TRAIT",
"permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
},
{
"objectId" : 277,
"objectType": "SEGMENT",
"permissions": ["READ", "WRITE", "MAP_TO_MODELS"]
}
]
Gibt 400 Bad Request
zurück, wenn auf die Gruppe nicht zugegriffen werden kann.
Eine PUT
-Methode zum Aktualisieren von Gruppenberechtigungen. Diese Methode überschreibt die alten Berechtigungen mit den neuen Berechtigungen.
PUT /api/v1/groups/{groupId}/permissions/
[
{ "objectType" : "SEGMENT",
"objectId" : 563,
"permissions" : [ "READ", "WRITE"]
},
{ "objectType" : "SEGMENT",
"objectId" : 2363,
"permissions" : [ "CREATE", "WRITE"]
},
{ "objectType" : "TRAIT",
"objectId" : 83498,
"permissions" : [ "READ", "MAP_TO_SEGMENTS"]
},
{ "objectType" : "DESTINATION",
"objectId" : 304,
"permissions" : [ "READ", "WRITE", "CREATE"]
}
]
Die Beispielantwort stellt die aktualisierte Liste der Berechtigungsobjekte dar.
Gibt 200 OK
zurück, falls erfolgreich. Gibt 400
zurück, wenn eine gegebene Berechtigung ungültig ist. Kann auch 403
zurückgeben, wenn der angemeldete Benutzer nicht auf das Objekt zugreifen kann.