Restaure métodos API para gerenciar usuários, incluindo criação, atualização, listagem, exclusão e retorno de objetos de usuário.
Um método POST
para criar um novo usuário.
POST /api/v1/users/
{
"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
}
{
"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">
}
Se isAdmin
estiver definido como true, o usuário será criado como um administrador parceiro. Essa propriedade também permite saber se um usuário é um administrador parceiro.
Retorna 409 Conflict
se o nome de usuário já estiver sendo usado.
Um método PUT
para atualizar um usuário.
PUT /api/v1/users/
<userId>
{
"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>, ...]
}
{
"pid" : <integer>,
"userId": <integer>,
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"groups" : [<group_1_id>, ...]
}
Retorna 409 Conflict
se o nome de usuário já estiver sendo usado.
Um método PUT
para atualizar o usuário conectado no momento.
Embora a maioria dos métodos API só possa ser chamada por administradores de parceiros, esse método pode ser chamado por usuários não administradores.
PUT /self/update
{
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>
}
{
"userId": <integer>,,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>
}
Retorna 409 Conflict
se o nome de usuário já estiver sendo usado.
Um método PUT
para atualizar o usuário conectado no momento.
Embora a maioria dos métodos API só possa ser chamada por administradores de parceiros, esse método pode ser chamado por usuários não administradores.
POST /users/self/update-password
{ "oldPassword" : "old password", "newPassword" : "new password" }
Retorna 200 OK
se bem-sucedido. Retorna 400 Bad Request
se algo estiver errado com qualquer uma das senhas.
Um método PUT
para redefinir o usuário conectado no momento. Audience Management envia ao usuário uma senha gerada pelo sistema.
Embora a maioria dos métodos API só possa ser chamada por administradores de parceiros, esse método pode ser chamado por usuários não administradores.
POST /self/reset-password
Retorna 200 OK
se bem-sucedido.
Um método Get
para retornar o objeto de usuário para uma ID de usuário.
GET /api/v1/users/
<userId>
{
"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>, ...]
}
Um método Get
para retornar o objeto do usuário para o usuário conectado no momento.
Embora a maioria dos métodos API só possa ser chamada por administradores de parceiros, esse método pode ser chamado por usuários não administradores.
GET /api/v1/users/self
{
"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>, ...]
}
Um método GET
para lista de usuários.
GET /api/v1/users/
É possível especificar várias IDs de grupo nos parâmetros do query:
GET /api/v1/users/?groupId=343&groupdId=12
Esse query retorna uma lista de todos os usuários nos grupos especificados.
{
"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>, ...]
}
Um método DELETE
para excluir um usuário.
DELETE /api/v1/users/
<user_id>
Retorna 204 No Content
se bem-sucedido. Em caso de conflito, retorna 409 Conflict
.
Um método POST
para excluir vários usuários em massa.
POST /api/v1/users/bulk-delete
{[<user_id_1>, <user_id_2>, ...]}