ユーザーへのパッチ適用
patch
/iam/governance/selfservice/api/v1/users
リクエスト・ペイロードで指定されたユーザー属性のリストで1つ以上のユーザーを更新します。ユーザーは、変更ユーザー・アクションの実行に必要な権限を持っている必要があります。
リクエスト
サポートされているメディア・タイプ
- application/json
更新するユーザーの属性リスト。"id"は必須フィールドです。"id"フィールドはユーザーのusr_key属性にマップされます。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ヘッダー
- ResponseTime: string
リクエストの処理にかかった時間(ミリ秒)を取得します。
401レスポンス
未認可
403レスポンス
禁止
404レスポンス
リソースが見つからない
500レスポンス
内部サーバー・エラー
例
この例では、1つのリクエストで複数のユーザーにパッチを適用する機能を示します。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。
cURLの例
curl -H "Content-Type: application/json" -H "X-Requested-By: <anyvalue>" -X PATCH -u username:password -d @patch.json https://pseudo.com/iam/governance/selfservice/api/v1/users
PATCHリクエスト本文の例
次の例に、JSON形式のリクエスト本文のコンテンツを示します。
{ "users": [ { "id": "18008", "add": [ { "name": "Last Name", "value": "updateed12345" } ], "delete": [ { "name": "First Name" } ], "update": [ { "name": "Display Name", "value": "supriya12345" } ] }, { "id": "18009", "add": [ { "name": "Last Name", "value": "updateed12345" } ], "delete": [ { "name": "First Name" } ], "update": [ { "name": "Display Name", "value": "supriya12345" } ] } ] }
PATCHレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{ "users": [ { "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/18008" } ], "id": "18008", "status": " SUCCESS", "request": { "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10073" } ], "requestId": "10073" } }, { "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/18009" } ], "id": "18009", "status": " SUCCESS", "request": { "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10074" } ], "requestId": "10074" } } ] }