Métodos da API de gerenciamento de grupos

Rest API métodos para gerenciar grupos, incluindo criação, atualização, listagem e exclusão de grupos.

Criar um grupo

A POST para criar um novo grupo de usuários.

Solicitação

POST /api/v1/groups/

Exemplo de corpo da solicitação

 {
    "name" : <string>,
    "description" : <string_may_be_null>,
 }

Resposta

  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }

Atualizar um grupo

A PUT para atualizar um grupo de usuários.

Solicitação

PUT /api/v1/groups/<groupId>

Exemplo de corpo da solicitação

 {
    "name" : <string>,
    "description" : <string_may_be_null>,
 }

Resposta

  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }

Listar Grupos

A GET para listar grupos de usuários.

Solicitação

GET /api/v1/groups/

Resposta

[
  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }, ...
]

Excluir um grupo

A DELETE método para excluir um grupo de usuários e remover todos os membros desse grupo.

Solicitação

DELETE /api/v1/groups/<groupId>

Devoluções 204 No Content se for bem-sucedido. Em caso de retornos de conflito 409 Conflict.

Excluir grupos em massa

A DELETE método para excluir vários grupos em massa e remover todos os membros desse grupo.

Solicitação

DELETE /api/v1/groups/bulk-delete

Devoluções 204 No Content se for bem-sucedido. Em caso de retornos de conflito 409 Conflict.

Listar todas as permissões de um grupo

A GET para listar os objetos de permissão em um grupo.

Solicitação

GET /api/v1/groups/{groupId}/permissions

Resposta

[{
 "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"]
 }
]

Devoluções 400 Bad Request se o grupo estiver inacessível.

Definir permissões para um grupo

A PUT para atualizar permissões de grupo. Esse método substitui as permissões antigas pelas novas permissões.

Solicitação

PUT /api/v1/groups/{groupId}/permissions/

Resposta

[
  { "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"]
  }
]

O exemplo de resposta representa a lista atualizada de objetos de permissão.

Devoluções 200 OK se for bem-sucedido. Devoluções 400 se qualquer permissão fornecida for inválida. Também pode retornar 403 se o objeto não estiver acessível ao usuário conectado.