Show Menu
TEMAS×

Métodos de API de administración de usuarios

Métodos de descanso API para administrar usuarios, incluida la creación, actualización, listado, eliminación y devolución de objetos de usuario.

Create a User

Un POST método para crear un nuevo usuario.

Solicitud

POST /api/v1/users/

Cuerpo de solicitud de muestra

{ 
  "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 asociado. Esta propiedad también le permite saber si un usuario es administrador asociado.
Devuelve 409 Conflict si el nombre de usuario ya está en uso.

Actualizar un usuario

Un PUT método para actualizar un usuario.

Solicitud

PUT /api/v1/users/ <userId>

Cuerpo de solicitud de muestra

{ 
  "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 está en uso.

Actualizar usuario con inicio de sesión

Un PUT método para actualizar el usuario que ha iniciado sesión.
Mientras que la mayoría de API los métodos solo los pueden llamar los administradores de socios, este método lo hacen los usuarios que no son administradores.

Solicitud

PUT /self/update

Cuerpo de solicitud de muestra

{  
  "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 está en uso.

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

Un PUT método para actualizar el usuario que ha iniciado sesión.
Mientras que la mayoría de API los métodos solo los pueden llamar los administradores de socios, este método lo hacen los usuarios que no son administradores.

Solicitud

POST /users/self/update-password

Cuerpo de solicitud de muestra

{ "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 inicio de sesión

Un PUT método para restablecer el usuario que ha iniciado sesión. Audience Management envía al usuario una contraseña generada por el sistema.
Mientras que la mayoría de API los métodos solo los pueden llamar los administradores de socios, este método lo hacen los usuarios que no son administradores.

Solicitud

POST /self/reset-password
Devuelve 200 OK si se realiza correctamente.

Devolver objeto de usuario para un ID de usuario

Un Get método 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 con sesión iniciada

Un Get método para devolver el objeto de usuario del usuario que ha iniciado sesión.
Mientras que la mayoría de API los métodos solo los pueden llamar los administradores de socios, este método lo hacen los usuarios que no son 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>, ...] 
 
}

Mostrar usuarios

Un GET método 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>, ...] 
 
}

Delete a User

Un DELETE método para eliminar un usuario.

Solicitud

DELETE /api/v1/users/ <user_id>
Devuelve 204 No Content si se realiza correctamente. En caso de conflicto retorna 409 Conflict .

Eliminar usuarios de forma masiva

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

Solicitud

POST /api/v1/users/bulk-delete

Cuerpo de solicitud de muestra

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