API-Methoden für die Gruppenverwaltung
- Themen:
- API
API Methoden zum Verwalten von Gruppen, einschließlich Erstellen, Aktualisieren, Auflisten und Löschen von Gruppen.
Eine Gruppe erstellen
Eine POST Methode zum Erstellen einer neuen Benutzergruppe.
Anfrage
POST /api/v1/groups/
Beispiel-Anfrageinhalt
{
"name" : <string>,
"description" : <string_may_be_null>,
}
Antwort
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Aktualisieren einer Gruppe
Eine PUT Methode zum Aktualisieren einer Benutzergruppe.
Anfrage
PUT /api/v1/groups/<groupId>
Beispiel-Anfrageinhalt
{
"name" : <string>,
"description" : <string_may_be_null>,
}
Antwort
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Gruppen auflisten
Eine GET Methode zum Auflisten von Benutzergruppen.
Anfrage
GET /api/v1/groups/
Antwort
[
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}, ...
]
Eine Gruppe löschen
Eine DELETE Methode zum Löschen einer Benutzergruppe und zum Entfernen aller Mitglieder aus dieser Gruppe.
Anfrage
DELETE /api/v1/groups/<groupId>
Gibt bei Erfolg 204 No Content zurück. Im Konfliktfall gibt 409 Conflict zurück.
Gruppen stapelweise löschen
Eine DELETE Methode zum Massenlöschen mehrerer Gruppen und zum Entfernen aller Mitglieder aus dieser Gruppe.
Anfrage
DELETE /api/v1/groups/bulk-delete
Gibt bei Erfolg 204 No Content zurück. Im Konfliktfall gibt 409 Conflict zurück.
Auflisten aller Berechtigungen für eine Gruppe
Eine GET Methode zum Auflisten der Berechtigungsobjekte für eine Gruppe.
Anfrage
GET /api/v1/groups/{groupId}/permissions
Antwort
[{
"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 die Gruppe nicht zugänglich ist.
Festlegen von Berechtigungen für eine Gruppe
Eine PUT Methode zum Aktualisieren von Gruppenberechtigungen. Diese Methode überschreibt die alten Berechtigungen mit den neuen Berechtigungen.
Anfrage
PUT /api/v1/groups/{groupId}/permissions/
Antwort
[
{ "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 bei Erfolg 200 OK zurück. 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.