ポリシーIDに基づいたポリシーの更新
put
/iam/governance/selfservice/api/v1/policies/{policyid}
ペイロードに渡される属性を持つポリシーを更新します。"action"問合せパラメータを使用してポリシーを検証するシナリオでは、検証が失敗した場合に、レスポンスは"errorMessage"を取得します。検証は、パスワードおよびユーザー名のポリシー・タイプにサポートされています。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- policyid: string
更新されるポリシーのポリシーID。
問合せパラメータ
- action(optional): string
ポリシーIDに対するアクション。現在のリリースでは、"validate"アクションをサポートしています。たとえば/policies/{policyid}?action=validate。問合せパラメータは、パスワードおよびユーザー名のポリシーのみにサポートされています。URIがaction問合せで呼び出された場合、ペイロード内のコンテンツは検証の確認用に使用されます。たとえば、パスワード・ポリシーの場合、リクエスト・ペイロードには検証されるパスワードが含まれています。他のすべての属性は、指定されていても無視されます。リクエスト・ペイロードに指定された属性は、どれも問合せパラメータ"action"で更新されません。
- policyType: string
返されるポリシーIDのポリシーのタイプ。ポリシーIDがポリシー・タイプに一致しない場合、更新は実行されません。
更新されるポリシーの属性。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ヘッダー
- ResponseTime: string
リクエストの処理にかかった時間(ミリ秒)を取得します。
401レスポンス
未認可
404レスポンス
リクエスト・エンティティが見つからない
500レスポンス
内部サーバー・エラー
デフォルト・レスポンス
予期しないエラー
例
この例では、パスワードがポリシーを満たしていることを確認する機能を示します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。
cURLの例
curl -H "Content-Type: application/json" -H "X-Requested-By: <anyvalue>" -X PUT -u username:password -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/policies/1? policyType=passwordPolicy&action=validate
PUTリクエスト本文の例
次の例に、JSON形式のリクエスト本文のコンテンツを示します。
{
"requestId": "1001",
"attributes" : [
{
"name" : "password",
"value" : "PASSWORD"
}
]
}
PUTレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policies/1?
policyType=passwordPolicy"
}
],
"requestId": "1001",
"status": "Valid Password"
}