Perfil do Usuário
Este endpoint permite que o usuário autenticado gerencie suas próprias informações de perfil.
Objeto Perfil
| Atributo | Tipo | Descrição |
|---|---|---|
username | string | O nome de usuário. |
handle | string | O identificador único do usuário (usado para compartilhamento). |
avatar_url | string | A URL para a imagem de avatar do usuário. |
role | string | O papel global do usuário no sistema. |
organization_id | string | O ID da organização atualmente ativa para o usuário. |
active_accounting_period_id | string | O ID do período contábil atualmente ativo. |
Obter Perfil
Retorna o perfil do usuário atualmente autenticado.
GET/api/profile
Resposta
Retorna o objeto de Perfil do usuário.
Códigos de Status HTTP
200 OK: Perfil do usuário retornado com sucesso.401 Unauthorized: Autenticação necessária ou credenciais inválidas.500 Internal Server Error: Erro interno do servidor ao obter o perfil.
Atualizar Perfil
Atualiza as informações do perfil do usuário.
PUT/api/profile
Corpo da Requisição
Você pode enviar qualquer um dos campos do objeto Perfil para atualização.
json
{
"username": "Novo Nome de Usuário",
"active_accounting_period_id": "p1q2r3s4-t5u6-7890-1234-567890abcdef"
}Resposta
Retorna o objeto de Perfil atualizado.
Códigos de Status HTTP
200 OK: Perfil atualizado com sucesso.400 Bad Request: Dados da requisição inválidos.401 Unauthorized: Autenticação necessária ou credenciais inválidas.500 Internal Server Error: Erro interno do servidor ao atualizar o perfil.
Deletar Conta de Usuário
Exclui permanentemente a conta do usuário e todos os seus dados associados do sistema, incluindo o registro de autenticação. Esta é uma ação destrutiva e irreversível.
DELETE/api/profile
Resposta
200 OK com uma mensagem de sucesso.
json
{
"message": "Usuário excluído com sucesso."
}Códigos de Status HTTP
200 OK: Usuário excluído com sucesso.401 Unauthorized: Autenticação necessária ou credenciais inválidas.500 Internal Server Error: Erro interno do servidor ao deletar a conta do usuário.