Métodos de API de administración de usuario

Rest API métodos para administrar usuarios, como crear, actualizar, listar, eliminar y devolver objetos de usuario.

Crear un usuario

Un método POST para crear un nuevo usuario.

Solicitud

POST /api/v1/users/

Cuerpo de la solicitud de ejemplo

{ 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...], 
  "isAdmin" : true | false 
}

Respuesta

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...], 
  "isAdmin" : <"true"|"false"> 
 
}

Si isAdmin se establece en true, el usuario se crea como administrador del socio. Esta propiedad también le permite saber si un usuario es administrador del socio.

Devuelve 409 Conflict si el nombre de usuario ya se ha tomado.

Actualizar un usuario

Método PUT para actualizar a un usuario.

Solicitud

PUT /api/v1/users/<userId>

Cuerpo de la solicitud de ejemplo

{ 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...] 
}

Respuesta

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "groups" : [<group_1_id>, ...] 
 
}

Devuelve 409 Conflict si el nombre de usuario ya se ha tomado.

Actualizar usuario de inicio de sesión

Un método PUT para actualizar el usuario que ha iniciado sesión.

NOTA

Mientras que la mayoría de los métodos API solo los pueden llamar los administradores asociados, este método lo pueden hacer los usuarios que no sean administradores.

Solicitud

PUT /self/update

Cuerpo de la solicitud de ejemplo

{  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null> 
}

Respuesta

{ 
  "userId": <integer>,,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string> 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null> 
}

Devuelve 409 Conflict si el nombre de usuario ya se ha tomado.

Actualizar la contraseña de usuario con sesión iniciada

Un método PUT para actualizar el usuario que ha iniciado sesión.

NOTA

Mientras que la mayoría de los métodos API solo los pueden llamar los administradores asociados, este método lo pueden hacer los usuarios que no sean administradores.

Solicitud

POST /users/self/update-password

Cuerpo de la solicitud de ejemplo

{ "oldPassword" : "old password", "newPassword" : "new password" }

Devuelve 200 OK si se realiza correctamente. Devuelve 400 Bad Request si hay algún problema con cualquiera de las contraseñas.

Restablecer la contraseña de usuario con sesión iniciada

Un método PUT para restablecer el usuario que ha iniciado sesión. Audience Management envía al usuario una contraseña generada por el sistema.

NOTA

Mientras que la mayoría de los métodos API solo los pueden llamar los administradores asociados, este método lo pueden hacer los usuarios que no sean administradores.

Solicitud

POST /self/reset-password

Devuelve 200 OK si se realiza correctamente.

Devolver objeto de usuario para un identificador de usuario

Un método Get para devolver el objeto de usuario para un ID de usuario.

Solicitud

GET /api/v1/users/<userId>

Respuesta

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<groupd_id_1>, ...] 
 
}

Devolver objeto de usuario para usuario registrado

Un método Get para devolver el objeto de usuario para el usuario que ha iniciado sesión en ese momento.

NOTA

Mientras que la mayoría de los métodos API solo los pueden llamar los administradores asociados, este método lo pueden hacer los usuarios que no sean administradores.

Solicitud

GET /api/v1/users/self

Respuesta

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<groupd_id_1>, ...] 
 
}

Lista de usuarios

Un método GET para enumerar usuarios.

Solicitud

GET /api/v1/users/

Puede especificar varios ID de grupo en los parámetros de consulta:

GET /api/v1/users/?groupId=343&groupdId=12

Esta consulta devuelve una lista de todos los usuarios de los grupos especificados.

Respuesta

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...] 
 
}

Eliminar un usuario

Método DELETE para eliminar un usuario.

Solicitud

DELETE /api/v1/users/<user_id>

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

Eliminar usuarios de forma masiva

Un método POST para eliminar varios usuarios de forma masiva.

Solicitud

POST /api/v1/users/bulk-delete

Cuerpo de la solicitud de ejemplo

{[<user_id_1>, <user_id_2>, ...]}

En esta página