Show Menu
TÓPICOS×

Métodos da API de gerenciamento de usuários

Restaure API métodos para gerenciar usuários, incluindo criar, atualizar, listar, excluir e retornar objetos do usuário.

Create a User

Um POST método para criar um novo usuário.

Solicitação

POST /api/v1/users/

Corpo de solicitação de amostra

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

Resposta

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

Atualizar um usuário

Um PUT método para atualizar um usuário.

Solicitação

PUT /api/v1/users/ <userId>

Corpo de solicitação de amostra

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

Resposta

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

Atualizar usuário conectado

Um PUT método para atualizar o usuário conectado no momento.
Enquanto a maioria dos API métodos só é chamável por administradores de parceiros, esse método é chamável por usuários não administradores.

Solicitação

PUT /self/update

Corpo de solicitação de amostra

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

Resposta

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

Atualizar senha de usuário conectado

Um PUT método para atualizar o usuário conectado no momento.
Enquanto a maioria dos API métodos só é chamável por administradores de parceiros, esse método é chamável por usuários não administradores.

Solicitação

POST /users/self/update-password

Corpo de solicitação de amostra

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

Redefinir senha de usuário conectado

Um PUT método para redefinir o usuário conectado no momento. Audience Management envia ao usuário uma senha gerada pelo sistema.
Enquanto a maioria dos API métodos só é chamável por administradores de parceiros, esse método é chamável por usuários não administradores.

Solicitação

POST /self/reset-password
Retorna 200 OK se bem-sucedido.

Retornar objeto de usuário para uma ID de usuário

Um Get método para retornar o objeto de usuário para uma ID de usuário.

Solicitação

GET /api/v1/users/ <userId>

Resposta

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

Retornar objeto de usuário para usuário conectado

Um Get método para retornar o objeto de usuário para o usuário conectado no momento.
Enquanto a maioria dos API métodos só é chamável por administradores de parceiros, esse método é chamável por usuários não administradores.

Solicitação

GET /api/v1/users/self

Resposta

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

Listar usuários

Um GET método para listar usuários.

Solicitação

GET /api/v1/users/
É possível especificar várias IDs de grupo nos parâmetros de consulta:
GET /api/v1/users/?groupId=343&groupdId=12
Essa consulta retorna uma lista de todos os usuários nos grupos especificados.

Resposta

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

Um DELETE método para excluir um usuário.

Solicitação

DELETE /api/v1/users/ <user_id>
Retorna 204 No Content se bem-sucedido. Em caso de retornos em conflito 409 Conflict .

Excluir usuários em massa

Um POST método para excluir vários usuários em massa.

Solicitação

POST /api/v1/users/bulk-delete

Corpo de solicitação de amostra

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