Справочник по API управления аутентификацией и паролями для локальных консолей управления

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

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

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

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

URI: /external/authentication/set_password

ПОМЕСТИТЬ

тип: JSON

пример:

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

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

имени	типа	обязательный или необязательный
имени пользователя	Струна	Обязательно
пароля	Струна	Обязательно
new_password	Струна	Обязательно

тип: JSON

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

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

response:

{

    "error": {

        "userDisplayErrorMessage": "User authentication failure"

    }

}

тип: POST

API :

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

пример:

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

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

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

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

URI: /external/authentication/set_password_by_admin

ПОМЕСТИТЬ

тип: JSON

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

request:

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

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

имени	типа	обязательный или необязательный
admin_username	Струна	Обязательно
admin_password	Струна	Обязательно
имени пользователя	Струна	Обязательно
new_password	Струна	Обязательно

тип: JSON

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

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

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

response:

{

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

}

Поля устройства

имени	типа	обязательный или необязательный
admin_username	Струна	Обязательно
admin_password	Струна	Обязательно
имени пользователя	Струна	Обязательно
new_password	Струна	Обязательно

тип: POST

API :

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

пример:

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

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

Используйте этот API для проверки учетных данных пользователя.

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

URI: /external/authentication/validation

ПОМЕСТИТЬ

тип: JSON

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

имени	типа	обязательный или необязательный
имени пользователя	Струна	Обязательно
пароля	Струна	Обязательно

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

request:

{

    "username": "test",
    "password": "Test12345\!"

}

тип: JSON

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

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

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

response:

{

    "msg": "Authentication succeeded."

}

тип: POST

API :

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

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

Дополнительные сведения см. в обзоре Api Defender для Интернета вещей.