Métodos da API de gerenciamento de usuários

Restaure métodos API para gerenciar usuários, incluindo criação, atualização, listagem, exclusão e retorno de objetos de usuário.

Criar um usuário

Um método POST 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 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.

Atualizar um usuário

Um método PUT 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 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 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 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 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 a senha do 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 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>, ...] 
 
}

Objeto de Retorno 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>, ...] 
 
}

Usuários da lista

Um método GET para lista de usuários.

Solicitação

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.

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 de solicitação de amostra

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

Nesta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now