ジャンプ先

• リクエスト
• レスポンス
• 例

ユーザー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
  リクエストの処理にかかった時間(ミリ秒)を取得します。

本文()

ルート・スキーマ: UserLinkDataInstances

型: object

ソースを表示

• fields(optional): array fields
• links(optional): array links

{
    "properties":{
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

ネストされたスキーマ: fields

型: array

ソースを表示

• 配列: オブジェクト Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

ネストされたスキーマ: Fields

型: object

ソースを表示

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: LinkDataInstances

型: object

ソースを表示

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"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/23?fields=Display Name,First Name,User Login,Department Number,Middle Name"

GETレスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/users/23"
        }
    ],
    "fields": [
        {
            "name": "Display Name",
            "value": {
                "base": "Beatrix Kiddo"
            }
        },
        {
            "name": "First Name",
            "value": "Beatrix"
        },
        {
            "name": "usr_key",
            "value": 23
        },
        {
            "name": "User Login",
            "value": "BKIDDO"
        }
    ]
}

先頭に戻る