Métodos da API de gerenciamento de usuários

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

Criar um usuário

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

Solicitação

POST /api/v1/users/

Corpo da 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 método PUT para atualizar um usuário.

Solicitação

PUT /api/v1/users/<userId>

Corpo da 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 método PUT para atualizar o usuário conectado no momento.

OBSERVAÇÃO

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.

Solicitação

PUT /self/update

Corpo da 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 método PUT para atualizar o usuário conectado no momento.

OBSERVAÇÃO

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.

Solicitação

POST /users/self/update-password

Corpo da 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 uma das senhas.

Redefinir senha de usuário conectado

Um método PUT para redefinir o usuário conectado no momento. Audience Management envia ao usuário uma senha gerada pelo sistema.

OBSERVAÇÃO

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.

Solicitação

POST /self/reset-password

Retorna 200 OK se bem-sucedido.

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

Um método Get para retornar o objeto do 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 método Get para retornar o objeto do usuário para o usuário conectado no momento.

OBSERVAÇÃO

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.

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 método GET para listar usuários.

Solicitação

GET /api/v1/users/

Você pode especificar várias IDs de grupo nos parâmetros de consulta:

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

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

Excluir um usuário

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

Solicitação

DELETE /api/v1/users/<user_id>

Retorna 204 No Content se bem-sucedido. Em caso de conflito, retorna 409 Conflict.

Excluir usuários em massa

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

Solicitação

POST /api/v1/users/bulk-delete

Corpo da solicitação de amostra

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

Nesta página