Métodos de API de administración de usuario user-management-api-methods
Rest API Métodos para administrar usuarios, incluidos crear, actualizar, enumerar, eliminar y devolver objetos de usuario.
Crear un usuario create-user
A POST
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">
}
If isAdmin
se establece en true, el usuario se crea como administrador del socio. Esta propiedad también le permite saber si un usuario es un administrador de socio.
Devuelve 409 Conflict
si el nombre de usuario ya está en uso.
Actualizar un usuario update-user
A PUT
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 que ha iniciado sesión update-logged-in-user
A PUT
para actualizar el usuario que ha iniciado sesión actualmente.
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 contraseña de usuario que ha iniciado sesión update-logged-in-user-pw
A PUT
para actualizar el usuario que ha iniciado sesión actualmente.
Solicitud
POST /users/self/update-password
Cuerpo de solicitud de muestra
{ "oldPassword" : "old password", "newPassword" : "new password" }
Devuelve 200 OK
si tiene éxito. Devuelve 400 Bad Request
si algo va mal con alguna de las contraseñas.
Restablecer contraseña de usuario que ha iniciado sesión reset-logged-in-user-pw
A PUT
para restablecer el usuario que ha iniciado sesión. Audience Management envía al usuario una contraseña generada por el sistema.
Solicitud
POST /self/reset-password
Devuelve 200 OK
si tiene éxito.
Devolver el objeto de usuario de un identificador de usuario return-user-object-for-id
A Get
para devolver el objeto de usuario de un identificador 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>, ...]
}
Objeto de usuario devuelto para el usuario que ha iniciado sesión return-user-object-for-logged-in-user
A Get
para devolver el objeto user para el usuario que ha iniciado sesión actualmente.
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>, ...]
}
Enumerar usuarios list-users
A 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>, ...]
}
Eliminar un usuario delete-users
A DELETE
para eliminar un usuario.
Solicitud
DELETE /api/v1/users/
<user_id>
Devuelve 204 No Content
si tiene éxito. En caso de conflicto, devuelve 409 Conflict
.
Eliminar usuarios de forma masiva delete-users-bulk
A POST
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>, ...]}