Show Menu
ARGOMENTI×

Metodi API di gestione dei gruppi

Metodi API di riposo per gestire i gruppi, inclusi creazione, aggiornamento, elenco, eliminazione di gruppi.

Creare un gruppo

Un POST metodo 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

Un PUT metodo 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 elenco

Un GET metodo 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

Un DELETE metodo per eliminare un gruppo di utenti e rimuovere tutti i membri da tale gruppo.

Richiesta

DELETE /api/v1/groups/ <groupId>
Restituisce 204 No Content se ha esito positivo. In caso di ritorno a un conflitto 409 Conflict .

Elimina gruppi in blocco

Un 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 se ha esito positivo. In caso di ritorno a un conflitto 409 Conflict .

Elenca tutte le autorizzazioni per un gruppo

Un GET metodo per elencare gli oggetti autorizzazione di 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 è inaccessibile.

Impostare le autorizzazioni per un gruppo

Un PUT metodo per aggiornare le autorizzazioni del gruppo. Questo metodo sovrascrive le autorizzazioni precedenti 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 di oggetti autorizzazione.
Restituisce 200 OK se ha esito positivo. Restituisce 400 se un'autorizzazione specificata non è valida. Può anche restituire 403 se l'oggetto non è accessibile dall'utente che ha eseguito l'accesso.