ユーザーの更新
put
/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 PUT -u username:password -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/users
PUTリクエスト本文の例
次の例に、JSON形式のリクエスト本文のコンテンツを示します。
{
"users": [
{
"requestId": "123",
"id": "24",
"fields": [
{
"name": "First Name",
"value": "UpdatedFN"
}
]
},
{
"requestId": "123",
"id": "9999",
"fields": [
{
"name": "First Name",
"value": "UpdatedFN1"
}
]
}
]
}
PUTレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"users": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/users/24"
}
],
"requestId": "123",
"status": "SUCCESS",
"fields": [
{
"name": "First Name",
"value": "UpdatedFN"
}
]
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/users/9999"
}
],
"requestId": "123",
"status": "FAIL",
"reason": "IAM-2040028:User does not exists:"
}
]
}