オンプレミス管理コンソールの認証とパスワード管理の API リファレンス
[アーティクル] 06/01/2023
2 人の共同作成者
フィードバック
この記事の内容
この記事では、Microsoft Defender for IoT オンプレミス管理コンソールでサポートされている認証とパスワード管理の REST API について説明します。
set_password (パスワードの変更)
ユーザーが自分のパスワードを変更できるようにするには、この API を使用します。 すべての Defender for IoT ユーザー ロールは、API で使用できます。
この API を使用するために Defender for IoT のアクセス トークンは必要ありません。
URI : /external/authentication/set_password
POST
型 : JSON
例 :
request:
{
"username": "test",
"password": "Test12345\!",
"new_password": "Test54321\!"
}
要求パラメーター
名前
Type
必須/省略可能
username
String
必須
password
String
必須
new_password
String
必須
型 : JSON
Message
説明
成功 – msg
Password has been replaced (パスワードが置き換えられました)
失敗 – error
User authentication failure (ユーザー認証エラー)
失敗 – error
Password does not match security policy (パスワードがセキュリティ ポリシーと一致しません)
応答の例
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
POST
型 : JSON
要求の例
request:
{
"admin_username": "admin",
"admin_password: "Test0987"
"username": "test",
"new_password": "Test54321\!"
}
要求パラメーター
名前
Type
必須/省略可能
admin_username
String
必須
admin_password
String
必須
username
String
必須
new_password
String
必須
型 : JSON
動作状態の詳細を含むメッセージ文字列:
Message
説明
成功 – msg
Password has been replaced (パスワードが置き換えられました)
失敗 – error
User authentication failure (ユーザー認証エラー)
失敗 – error
User does not exist (ユーザーが存在しません)
失敗 – error
Password doesn't match security policy (パスワードがセキュリティ ポリシーと一致しません)
失敗 – error
User does not have the permissions to change password (ユーザーにパスワードを変更する権限がありません)
応答の例
response:
{
"error": {
"userDisplayErrorMessage": "The user 'test_user' doesn't exist",
"internalSystemErrorMessage": "The user 'yoavfe' doesn't exist"
}
}
デバイス フィールド
名前
Type
必須/省略可能
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
validation (ユーザー資格情報の認証)
ユーザーの資格情報を検証するには、この API を使用します。
この API を使用するために Defender for IoT のアクセス トークンは必要ありません。
URI : /external/authentication/validation
POST
型 : JSON
クエリ パラメーター
名前
Type
必須/省略可能
username
String
必須
password
String
必須
要求の例
request:
{
"username": "test",
"password": "Test12345\!"
}
型 : JSON
動作状態の詳細を含むメッセージ文字列:
Message
説明
成功 – msg
認証しました
失敗 – error
資格情報の検証に失敗しました
応答の例
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 リファレンスの概要 に関するページを参照してください。