Metodi API per la gestione dei gruppi group-management-api-methods
Rest API metodi per gestire i gruppi, tra cui creazione, aggiornamento, elenco ed eliminazione di gruppi.
Creare un gruppo create-group
A POST
per creare un nuovo gruppo di utenti.
Richiesta
POST /api/v1/groups/
Corpo della richiesta di esempio
{
"name" : <string>,
"description" : <string_may_be_null>,
}
Risposta
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Aggiornare un gruppo update-group
A PUT
per aggiornare un gruppo di utenti.
Richiesta
PUT /api/v1/groups/
<groupId>
Corpo della richiesta di esempio
{
"name" : <string>,
"description" : <string_may_be_null>,
}
Risposta
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Gruppi di elenchi list-groups
A GET
per elencare i gruppi di utenti.
Richiesta
GET /api/v1/groups/
Risposta
[
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}, ...
]
Eliminare un gruppo delete-groups
A DELETE
per eliminare un gruppo utenti e rimuovere tutti i membri da tale gruppo.
Richiesta
DELETE /api/v1/groups/
<groupId>
Restituisce 204 No Content
in caso di esito positivo. In caso di restituzione in conflitto 409 Conflict
.
Elimina gruppi in blocco delete-groups-bulk
A DELETE
metodo per eliminare più gruppi in blocco e rimuovere tutti i membri da tale gruppo.
Richiesta
DELETE /api/v1/groups/bulk-delete
Restituisce 204 No Content
in caso di esito positivo. In caso di restituzione in conflitto 409 Conflict
.
Elenca tutte le autorizzazioni per un gruppo list-permissions-group
A GET
per elencare gli oggetti autorizzazione in un gruppo.
Richiesta
GET /api/v1/groups/{groupId}/permissions
Risposta
[{
"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"]
}
]
Restituisce 400 Bad Request
se il gruppo non è accessibile.
Impostare le autorizzazioni per un gruppo set-permissions-group
A PUT
metodo per aggiornare le autorizzazioni del gruppo. Questo metodo sovrascrive le vecchie autorizzazioni con le nuove autorizzazioni.
Richiesta
PUT /api/v1/groups/{groupId}/permissions/
Risposta
[
{ "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"]
}
]
La risposta di esempio rappresenta l’elenco aggiornato degli oggetti autorizzazione.
Restituisce 200 OK
in caso di esito positivo. Restituisce 400
se una determinata autorizzazione non è valida. Può anche restituire 403
se l'oggetto non è accessibile dall'utente connesso.