API-methoden voor groepsbeheer
- Onderwerpen:
- API
Rust API methoden om groepen te beheren, zoals het maken, bijwerken, weergeven of verwijderen van groepen.
Een groep maken
A POST methode om een nieuwe gebruikersgroep te maken.
Verzoek
POST /api/v1/groups/
Voorbeeld van aanvraaginstantie
{
"name" : <string>,
"description" : <string_may_be_null>,
}
Antwoord
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Een groep bijwerken
A PUT methode om een gebruikersgroep bij te werken.
Verzoek
PUT /api/v1/groups/<groupId>
Voorbeeld van aanvraaginstantie
{
"name" : <string>,
"description" : <string_may_be_null>,
}
Antwoord
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Groepen weergeven
A GET om gebruikersgroepen weer te geven.
Verzoek
GET /api/v1/groups/
Antwoord
[
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}, ...
]
Een groep verwijderen
A DELETE methode om een gebruikersgroep te verwijderen en alle leden uit die groep te verwijderen.
Verzoek
DELETE /api/v1/groups/<groupId>
Retourneert 204 No Content indien succesvol. In geval van conflictopmerkingen 409 Conflict.
Groepen in bulk verwijderen
A DELETE methode om veelvoudige groepen in massa te schrappen en alle leden uit die groep te verwijderen.
Verzoek
DELETE /api/v1/groups/bulk-delete
Retourneert 204 No Content indien succesvol. In geval van conflictopmerkingen 409 Conflict.
Alle machtigingen voor een groep weergeven
A GET methode om de machtigingsobjecten op een groep weer te geven.
Verzoek
GET /api/v1/groups/{groupId}/permissions
Antwoord
[{
"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"]
}
]
Retourneert 400 Bad Request als de groep ontoegankelijk is.
Machtigingen instellen voor een groep
A PUT methode om groepsmachtigingen bij te werken. Deze methode beschrijft de oude toestemmingen met de nieuwe toestemmingen.
Verzoek
PUT /api/v1/groups/{groupId}/permissions/
Antwoord
[
{ "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"]
}
]
De voorbeeldreactie vertegenwoordigt de bijgewerkte lijst met machtigingsobjecten.
Retourneert 200 OK indien succesvol. Retourneert 400 als een bepaalde machtiging ongeldig is. Kan ook terugkeren 403 als het object niet toegankelijk is voor de aangemelde gebruiker.