ユーザーIDに基づいたユーザーの検索
get
/iam/governance/selfservice/api/v1/users/{uuid}
ターゲット・ユーザーIDのユーザー属性を返します。ユーザー定義フィールド(UDF)を含むユーザーのすべての属性は、レスポンス・ペイロードの一部として返されます。レスポンス・ペイロードは、"fields"問合せパラメータで必要な属性を指定することにより管理できます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- uuid: string
ターゲット・ユーザーID
問合せパラメータ
- fields(optional): string
結果に返される属性。カンマ区切り属性を受け入れます。属性のサンプル値は、"First Name、Middle Name、Last Name、Organization、Email、User Login、Employee Number、Department Number"などです。"Supervisor First Name"、"Organization Name"などの参照オブジェクトの属性は指定できません。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ヘッダー
- ResponseTime: string
リクエストの処理にかかった時間(ミリ秒)を取得します。
401レスポンス
未認可
404レスポンス
リクエスト・エンティティが見つからない
500レスポンス
内部サーバー・エラー
例
ここでは、指定されたユーザーを取得します。返されるフィールドは、Display Name、First Name、User Login、Department NumberおよびMiddle Nameでフィルタされます。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。
cURLの例
curl -H "Content-Type: application/json" -X GET -u username:password "https://pseudo.com/iam/governance/selfservice/api/v1/users/User1?fields=Display Name,First Name,User Login,Department Number,Middle Name"
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{ "fields": { "Display Name": { "base": "User1_FN User1_LN" }, "Middle Name": null, "usr_key": 1005, "Department Number": null, "User Login": "USER1", "First Name": "User1_FN" }, "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/User1" } ] }