この記事では、Microsoft Defender for IoT オンプレミス管理コンソールでサポートされる認証およびパスワード管理 REST API の一覧を示します。
set_password (パスワードの変更)
この API を使用して、ユーザーが自分のパスワードを変更できるようにします。 すべての Defender for IoT ユーザー ロールは、API を操作できます。
この API を使用するために Defender for IoT アクセス トークンは必要ありません。
URI: /external/authentication/set_password
投稿
型: JSON
例の:
request:
{
"username": "test",
"password": "Test12345\!",
"new_password": "Test54321\!"
}
要求パラメーター
|
名の |
型の |
必須/省略可能な |
| ユーザー名 を する |
糸 |
必須 |
| パスワード の |
糸 |
必須 |
|
new_password |
糸 |
必須 |
型: 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 を使用して、システム管理者が指定されたユーザーのパスワードを変更できるようにします。 Defender for IoT 管理者ユーザー ロールは、API を操作できます。
この API を使用するために Defender for IoT アクセス トークンは必要ありません。
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
操作の状態の詳細を含むメッセージ文字列:
| メッセージ |
形容 |
|
成功 – メッセージ |
パスワードが置き換えられました |
|
エラー – エラー |
ユーザー認証エラー |
|
エラー – エラー |
ユーザーが存在しない |
|
エラー – エラー |
パスワードがセキュリティ ポリシーと一致しない |
|
エラー – エラー |
ユーザーにパスワードを変更するアクセス許可がありません |
応答の例
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 for IoT アクセス トークンは必要ありません。
URI: /external/authentication/validation
投稿
型: JSON
クエリ パラメーター
|
名の |
型の |
必須/省略可能な |
| ユーザー名 を する |
糸 |
必須 |
| パスワード の |
糸 |
必須 |
要求の例
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
次の手順
詳細については、Defender for IoT API リファレンスの概要を参照してください。