Usuário

/v1/users/{username}

Use este ponto de extremidade para recuperar, excluir ou atualizar uma conta de usuário.

Leitura

Receba informações sobre a conta de um usuário específico.

Exemplo

Para recuperar uma conta de usuário, use uma solicitação GET no ponto de extremidade /users/{username}:

GET /v1/users/username
Authorization: Bearer your-auth-token

Quando a ação for bem-sucedida, você receberá o código de status HTTP 200 OK e uma carga semelhante a esta:

{
   "users": [{
     "ROLES": "ROLE_ADMIN | ROLE_USER",
     "username": "username"
   }]
}

Atualização

Um usuário com a função ROLE_ADMIN pode atualizar a senha associada às contas de usuário com as funções ROLE_ADMIN e ROLE_USER. Usuários individuais também podem atualizar a senha da própria conta. A atualização da senha da conta de usuário não invalida os tokens de acesso associados ao usuário. No momento, apenas o usuário admin tem a função ROLE_ADMIN. Os demais usuários têm a função ROLE_USER.

Exemplo

Para atualizar a senha de uma conta, forneça o token Bearer junto com o nome de usuário e a nova senha.

PUT /v1/users/username
Authorization: Bearer your-auth-token
   
{
  "password": "new-password"
}

Se a ação for bem-sucedida, a senha associada ao nome de usuário será atualizada. Você receberá o código de status HTTP 200 OK, além de uma carga semelhante a esta:

{
   "users": [{
      "username": "username"
   }]
}

Exclusão

Se uma conta estiver comprometida ou se houver outros motivos para a sua exclusão, o admin deverá excluí-la. Depois de ser excluída com sucesso, todos os tokens associados a ela serão removidos do sistema.

Exemplo

Use a chamada de API a seguir para excluir uma conta de usuário, em que username é o nome da conta que você quer excluir. O token Bearer pertence à conta admin.

DELETE /v1/users/username
Authorization: Bearer your-auth-token

Se a ação for bem-sucedida, a conta de usuário será excluída. A resposta inclui o código de status HTTP 200 OK e esta carga:

{
   "users": [{
      "username": "username"
   }]
}

Códigos de erro