Métodos de API de administración de grupo

Los API métodos de descanso para administrar grupos, incluso crear, actualizar, enumerar y eliminar grupos.

Creación de grupos

Un método POST para crear un nuevo grupo de usuarios.

Solicitud

POST /api/v1/groups/

Cuerpo de solicitud de muestra

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

Respuesta

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

Actualizar un grupo

Un método PUT para actualizar un grupo de usuarios.

Solicitud

PUT /api/v1/groups/<groupId>

Cuerpo de solicitud de muestra

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

Respuesta

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

Un método GET para la lista de grupos de usuarios.

Solicitud

GET /api/v1/groups/

Respuesta

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

Eliminar un grupo

Un método DELETE para eliminar un grupo de usuarios y eliminar todos los miembros de ese grupo.

Solicitud

DELETE /api/v1/groups/<groupId>

Devuelve 204 No Content si se realiza correctamente. En caso de conflicto, devuelve 409 Conflict.

Eliminar grupos de forma masiva

Un método DELETE para eliminar varios grupos de forma masiva y eliminar todos los miembros de ese grupo.

Solicitud

DELETE /api/v1/groups/bulk-delete

Devuelve 204 No Content si se realiza correctamente. En caso de conflicto, devuelve 409 Conflict.

Lista de todos los permisos para un grupo

Un método GET para la lista de los objetos de permiso de un grupo.

Solicitud

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

Respuesta

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

Devuelve 400 Bad Request si el grupo no es accesible.

Definir permisos para un grupo

Un método PUT para actualizar los permisos de grupo. Este método sobrescribe los permisos anteriores con los nuevos permisos.

Solicitud

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

Respuesta

[ 
  { "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 respuesta de ejemplo representa la lista actualizada de los objetos de permiso.

Devuelve 200 OK si se realiza correctamente. Devuelve 400 si algún permiso dado no es válido. También puede devolver 403 si el usuario que ha iniciado sesión no puede acceder al objeto.