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.
Objeto de usuário
Seção intitulada “Objeto de usuário”{ "enable": true, "role": "observer"}- enable: Permite que o usuário entre. Um usuário com
falsenão consegue obter um token. - role:
adminouobserver. Saiba mais em Funções.
Criar um usuário
Seção intitulada “Criar um usuário”POST /api/userDisponível para admin. O corpo tem o id (login), o password e os campos do usuário.
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.
Obter um usuário
Seção intitulada “Obter um usuário”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.
Atualizar um usuário
Seção intitulada “Atualizar um usuário”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.
Excluir um usuário
Seção intitulada “Excluir um usuário”DELETE /api/user?id=<user_id>Disponível para admin. Um administrador não pode excluir a si mesmo: a requisição retorna 422.
Redefinir uma senha
Seção intitulada “Redefinir uma senha”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.
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.