Saltearse al contenido
Productos

API de usuarios

Los usuarios son las cuentas que pueden iniciar sesión en la interfaz web y usar la API. Más información sobre los roles en Usuarios y Roles.

{
"enable": true,
"role": "observer"
}
  • enable: permite al usuario iniciar sesión. Un usuario con false no puede obtener un token.
  • role: admin u observer. Más información en Roles.
Ventana de terminal
POST /api/user

Disponible para admin. El cuerpo contiene el id (inicio de sesión), la password y los campos del usuario.

Ventana de terminal
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"}'

Devuelve 204, 400 si el id o la password están vacíos, o 409 si el usuario ya existe.

Ventana de terminal
GET /api/user?id=<user_id>

Devuelve el objeto de usuario, o 404. Los roles admin y observer pueden leer a cualquier usuario. Los demás usuarios solo pueden leerse a sí mismos. La respuesta nunca contiene la contraseña.

Ventana de terminal
PUT /api/user?id=<user_id>

Disponible para admin. Envíe el objeto completo. Un administrador no puede cambiar su propio rol ni su estado: la solicitud devuelve 422. Pídale a otro administrador que lo haga.

Ventana de terminal
DELETE /api/user?id=<user_id>

Disponible para admin. Un administrador no puede eliminarse a sí mismo: la solicitud devuelve 422.

Ventana de terminal
POST /api/user/reset-password?id=<user_id>

Un administrador puede cambiar la contraseña de cualquier usuario. Cualquier otro usuario solo puede cambiar la suya.

Ventana de terminal
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"}'

Devuelve 204, o 404 si el usuario no existe. Si nadie puede iniciar sesión como administrador, lea Restablecer la contraseña de Alta.