你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn 。
OT 监视传感器的身份验证和密码管理 API 参考
本文内容
本文列出了 Defender for IoT OT 传感器支持的身份验证和密码管理 API。
set_password（更改密码）
使用此 API 可让用户更改其自己的密码。
使用此 API 无需 Defender for IoT 访问令牌。
URI ：/external/authentication/set_password
POST
类型：JSON
示例 ：
request:
{
"username": "test",
"password": "Test12345\!",
"new_password": "Test54321\!"
}
请求参数
名称 类型 必需/可选
username String
必须
password String
必须
new_password String
必须
类型：JSON
包含操作状态详细信息的消息字符串：
消息
说明
成功 - 消息
密码已替换
失败 - 错误
用户身份验证失败
失败 - 错误
密码与安全策略不匹配
示例 ：
response:
{
"error": {
"userDisplayErrorMessage": "User authentication failure"
}
}
类型：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 可让系统管理员更改指定用户的密码。 Defender for IoT 管理员用户角色可使用 API。
使用此 API 无需 Defender for IoT 访问令牌。
URI ：/external/authentication/set_password_by_admin
POST
类型：JSON
请求示例
request:
{
"admin_username": "admin",
"admin_password: "Test0987"
"username": "test",
"new_password": "Test54321\!"
}
请求参数
名称 类型 必需/可选
admin_username String
必须
admin_password String
必须
username String
必须
new_password String
必须
类型：JSON
包含操作状态详细信息的消息字符串：
消息
说明
成功 - 消息
密码已替换
失败 - 错误
用户身份验证失败
失败 - 错误
用户不存在
失败 - 错误
密码与安全策略不匹配
失败 - 错误
用户没有更改密码的权限
响应示例
response:
{
"error": {
"userDisplayErrorMessage": "The user 'test_user' doesn't exist",
"internalSystemErrorMessage": "The user 'test_user' doesn't exist"
}
}
类型：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 for IoT 用户名和密码。
使用此 API 无需 Defender for IoT 访问令牌。
URI ：/api/external/authentication/validation
POST
请求类型：JSON
查询参数
名称 类型 必需/可选
username String
必须
password String
必须
请求示例：
request:
{
"username": "test",
"password": "Test12345\!"
}
类型：JSON
包含操作状态详细信息的消息字符串：
消息
说明
成功 - 消息
身份验证成功
失败 - 错误
凭据验证失败
响应示例
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>/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
后续步骤
有关详细信息，请参阅 Defender for IoT API 参考概述 。