Перейти к содержимому
Продукты

API пользователей

Пользователи — это учётные записи, которые могут входить в веб-интерфейс и использовать API. Подробнее о ролях в разделах Пользователи и Роли.

{
"enable": true,
"role": "observer"
}
  • enable: разрешает пользователю входить. Пользователь с false не может получить токен.
  • role: admin или observer. Подробнее в разделе Роли.
Окно терминала
POST /api/user

Доступно роли admin. Тело запроса содержит id (логин), password и поля пользователя.

Окно терминала
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"}'

Возвращает 204, 400, если id или password пусты, либо 409, если пользователь существует.

Окно терминала
GET /api/user?id=<user_id>

Возвращает объект пользователя или 404. Роли admin и observer могут читать любого пользователя. Остальные пользователи могут читать только себя. В ответе никогда нет пароля.

Окно терминала
PUT /api/user?id=<user_id>

Доступно роли admin. Передайте объект целиком. Администратор не может изменить собственную роль или статус: запрос возвращает 422. Попросите сделать это другого администратора.

Окно терминала
DELETE /api/user?id=<user_id>

Доступно роли admin. Администратор не может удалить себя: запрос возвращает 422.

Окно терминала
POST /api/user/reset-password?id=<user_id>

Администратор может сменить пароль любого пользователя. Любой другой пользователь может сменить только собственный пароль.

Окно терминала
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"}'

Возвращает 204 или 404, если пользователь не существует. Если никто не может войти как администратор, читайте Смена пароля для веб-интерфейса Alta.