內部部署管理主控台的驗證和密碼管理 API 參考
本文內容
本文列出針對適用於 IoT 內部部署管理主控台的 Microsoft Defender 支援的驗證和密碼管理 REST API。
set_password (變更密碼)
使用此 API 讓使用者變更自己的密碼。 所有適用於 IoT 的 Defender 使用者角色都可以使用 API。
您不需要適用於 IoT 的 Defender 存取權杖，即可使用此 API。
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 -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 可讓系統管理員變更指定使用者的密碼。 適用於 IoT 的 Defender 管理使用者角色可以使用 API。
您不需要適用於 IoT 的 Defender 存取權杖，即可使用此 API。
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 'yoavfe' doesn't exist"
}
}
裝置欄位
名稱
類型
必要/選用
admin_username
String
必要
admin_password
String
必要
username
String
必要
new_password
String
必要
類型 ：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 來驗證使用者認證。
您不需要適用於 IoT 的 Defender 存取權杖，即可使用此 API。
URI ：/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>/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
下一步
如需詳細資訊，請參閱適用於 IoT 的 Defender API 參考概觀 。