Справочник по API проверки подлинности и управления паролями для датчиков мониторинга OT

В этой статье перечислены API проверки подлинности и управления паролями, поддерживаемые датчиками OT Defender для Интернета вещей.

set_password (изменение пароля)

Используйте этот API, чтобы разрешить пользователям менять свои пароли.

Для использования этого API вам не нужен маркер доступа Defender для Интернета вещей.

URI: /external/authentication/set_password

POST

Запрос

Тип: JSON

Пример:

request:

{
    "username": "test",
    "password": "Test12345\!",
    "new_password": "Test54321\!"
}

Параметры запроса

имя;	Тип	Обязательный или необязательный
username	Строка	Обязательно
password	Строка	Обязательно
new_password	Строка	Обязательно

Ответ

Тип: JSON

Строка сообщения с информацией о состоянии операции:

Сообщение	Описание
Success — msg	Пароль заменен
Сбой — ошибка	Сбой проверки подлинности пользователя
Сбой — ошибка	Пароль не соответствует политике безопасности

Пример:

response:

{
    "error": {
        "userDisplayErrorMessage": "User authentication failure"
    }
}

Команда cURL

Тип: POST

API:

curl -k -X POST -d '{"username": "<USER_NAME>","password": "<CURRENT_PASSWORD>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json'  https://<IP_ADDRESS>/api/external/authentication/set_password

Пример:

curl -k -X POST -d '{"username": "myUser","password": "1234@abcd","new_password": "abcd@1234"}' -H 'Content-Type: application/json'  https://127.0.0.1/api/external/authentication/set_password

set_password_by_admin (обновление пароля пользователя администратором)

Этот API позволяет системным администраторам изменять пароли для указанных пользователей. С этим API могут работать администраторы Defender для Интернета вещей.

Для использования этого API вам не нужен маркер доступа Defender для Интернета вещей.

URI: /external/authentication/set_password_by_admin

POST

Запрос

Тип: JSON

Пример запроса

request:

{
    "admin_username": "admin",
    "admin_password: "Test0987"
    "username": "test",
    "new_password": "Test54321\!"
}

Параметры запроса

имя;	Тип	Обязательный или необязательный
admin_username	Строка	Обязательно
admin_password	Строка	Обязательно
username	Строка	Обязательно
new_password	Строка	Обязательно

Ответ

Тип: JSON

Строка сообщения с информацией о состоянии операции:

Сообщение	Описание
Success — msg	Пароль заменен
Сбой — ошибка	Сбой проверки подлинности пользователя
Сбой — ошибка	Пользователь не существует
Сбой — ошибка	Пароль не соответствует политике безопасности
Сбой — ошибка	У пользователя нет разрешений на изменение пароля

Пример ответа

response:

{
    "error": {
        "userDisplayErrorMessage": "The user 'test_user' doesn't exist",
        "internalSystemErrorMessage": "The user 'test_user' doesn't exist"
    }
}

Команда cURL

Тип: POST

API:

curl -k -X POST -d '{"admin_username":"<ADMIN_USERNAME>","admin_password":"<ADMIN_PASSWORD>","username": "<USER_NAME>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json'  https://<IP_ADDRESS>/api/external/authentication/set_password_by_admin

Пример:

curl -k -X POST -d '{"admin_user":"adminUser","admin_password": "1234@abcd","username": "myUser","new_password": "abcd@1234"}' -H 'Content-Type: application/json'  https://127.0.0.1/api/external/authentication/set_password_by_admin

проверка (проверка учетных данных пользователя)

Этот API позволяет проверить имя пользователя и пароль для Defender для Интернета вещей.

Для использования этого API вам не нужен маркер доступа Defender для Интернета вещей.

URI: /api/external/authentication/validation

POST

Запрос

Тип запроса: JSON

Параметры запроса

имя;	Тип	Обязательный/необязательный
username	Строка	Обязательно
password	Строка	Обязательно

Пример запроса:

request:
{
    "username": "test",
    "password": "Test12345\!"
}

Ответ

Тип: JSON

Строка сообщения с информацией о состоянии операции:

Сообщение	Описание
Успешно — msg	Подлинность проверена успешно
Сбой — ошибка	Сбой проверки учетных данных

Пример ответа

response:
{
    "msg": "Authentication succeeded."
}

Команда cURL

Тип: POST

API:

curl -k -X POST -H "Authorization: <AUTH_TOKEN>" -H "Content-Type: application/json" -d '{"username": <USER NAME>, "password": <PASSWORD>}' https://<IP_ADDRESS>/api/external/authentication/validation

Пример:

curl -k -X POST -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" -H "Content-Type: application/json" -d '{"username": "test", "password": "test"}' https://127.0.0.1/api/external/authentication/validation

Дальнейшие действия

Дополнительные сведения см. в справочнике по API Defender для Интернета вещей.