Pular para o conteúdo
Produtos

API de usuários

Usuários são as contas que podem entrar na interface web e usar a API. Saiba mais sobre as funções em Usuários e Funções.

{
"enable": true,
"role": "observer"
}
  • enable: Permite que o usuário entre. Um usuário com false não consegue obter um token.
  • role: admin ou observer. Saiba mais em Funções.
Terminal window
POST /api/user

Disponível para admin. O corpo tem o id (login), o password e os campos do usuário.

Terminal window
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
'http://alta.example.com:8100/api/user' \
-d '{"id": "monitoring", "password": "PASSWORD", "enable": true, "role": "observer"}'

Retorna 204, 400 se o id ou o password estiver vazio, ou 409 se o usuário já existir.

Terminal window
GET /api/user?id=<user_id>

Retorna o objeto do usuário, ou 404. As funções admin e observer podem ler qualquer usuário. Os demais usuários podem ler apenas a si mesmos. A resposta nunca contém a senha.

Terminal window
PUT /api/user?id=<user_id>

Disponível para admin. Envie o objeto completo. Um administrador não pode alterar a própria função ou o próprio status: a requisição retorna 422. Peça a outro administrador que faça isso.

Terminal window
DELETE /api/user?id=<user_id>

Disponível para admin. Um administrador não pode excluir a si mesmo: a requisição retorna 422.

Terminal window
POST /api/user/reset-password?id=<user_id>

Um administrador pode alterar a senha de qualquer usuário. Qualquer outro usuário pode alterar apenas a própria senha.

Terminal window
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
'http://alta.example.com:8100/api/user/reset-password?id=monitoring' \
-d '{"password": "NEW-PASSWORD"}'

Retorna 204, ou 404 se o usuário não existir. Se ninguém conseguir entrar como administrador, leia Alterar a senha da interface web do Alta.