Métodos da API de gerenciamento de grupos

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

Criar um grupo

Um método POST para criar um novo grupo de usuários.

Solicitação

POST /api/v1/groups/

Corpo de solicitação de amostra

 {
    "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

Um método PUT para atualizar um grupo de usuários.

Solicitação

PUT /api/v1/groups/<groupId>

Corpo de solicitação de amostra

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

Grupos de listas

Um método GET para lista de 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

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

Solicitação

DELETE /api/v1/groups/<groupId>

Retorna 204 No Content se bem-sucedido. Em caso de conflito, retorna 409 Conflict.

Excluir grupos em massa

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

Solicitação

DELETE /api/v1/groups/bulk-delete

Retorna 204 No Content se bem-sucedido. Em caso de conflito, retorna 409 Conflict.

Lista de todas as permissões para um grupo

Um método GET para lista 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"]
 }
]

Retorna 400 Bad Request se o grupo estiver inacessível.

Definir permissões para um grupo

Um método PUT para atualizar permissões de grupo. Este 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"]
  }
]

A resposta de amostra representa a lista atualizada de objetos de permissão.

Retorna 200 OK se bem-sucedido. Retorna 400 se qualquer permissão fornecida for inválida. Também pode retornar 403 se o objeto não for acessível pelo usuário conectado.

Nesta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now