Métodos da API de gerenciamento de usuários

Última atualização em 2023-05-20
  • Tópicos
  • API
    Exibir mais informações sobre este tópico

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

Criar um usuário

A POST para criar um novo usuário.

Solicitação

POST /api/v1/users/

Exemplo de corpo da solicitação

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

Devoluções 409 Conflict se o nome de usuário já estiver sendo usado.

Atualizar um usuário

A PUT para atualizar um usuário.

Solicitação

PUT /api/v1/users/<userId>

Exemplo de corpo da solicitação

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

}

Devoluções 409 Conflict se o nome de usuário já estiver sendo usado.

Atualizar Usuário Conectado

A PUT para atualizar o usuário conectado no momento.

OBSERVAÇÃO

Considerando que a maioria API Os métodos só podem ser chamados por administradores parceiros. Esse método pode ser chamado por usuários não administradores.

Solicitação

PUT /self/update

Exemplo de corpo da solicitação

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

Devoluções 409 Conflict se o nome de usuário já estiver sendo usado.

Atualizar Senha do Usuário Conectado

A PUT para atualizar o usuário conectado no momento.

OBSERVAÇÃO

Considerando que a maioria API Os métodos só podem ser chamados por administradores parceiros. Esse método pode ser chamado por usuários não administradores.

Solicitação

POST /users/self/update-password

Exemplo de corpo da solicitação

{ "oldPassword" : "old password", "newPassword" : "new password" }

Devoluções 200 OK se for bem-sucedido. Devoluções 400 Bad Request se algo estiver errado com uma senha.

Redefinir Senha do Usuário Conectado

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

OBSERVAÇÃO

Considerando que a maioria API Os métodos só podem ser chamados por administradores parceiros. Esse método pode ser chamado por usuários não administradores.

Solicitação

POST /self/reset-password

Devoluções 200 OK se for bem-sucedido.

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

A Get método 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

A Get método para retornar o objeto do usuário conectado no momento.

OBSERVAÇÃO

Considerando que a maioria API Os métodos só podem ser chamados por administradores 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

A 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

A DELETE para excluir um usuário.

Solicitação

DELETE /api/v1/users/<user_id>

Devoluções 204 No Content se for bem-sucedido. Em caso de retornos de conflito 409 Conflict.

Excluir usuários em massa

A POST para excluir vários usuários em massa.

Solicitação

POST /api/v1/users/bulk-delete

Exemplo de corpo da solicitação

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

Nesta página