ジャンプ先

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

ロール・メンバーの取得

get

/iam/governance/selfservice/api/v1/roles/{roleid}/members

特定のroleidのロール・メンバーを返します。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• roleid: string
  エンティティ・タイプ(RoleIDに指定可能な値)

問合せパラメータ

• fields(optional): string
  ペイロードにはロール・メンバー(ユーザーの情報)が含まれます。ペイロードは、必要なユーザー属性を指定することにより制限できます。たとえば、ロールのすべてのロール・メンバーのユーザー・ログインおよび表示名のみを取得するには、URIは/roles/{roleid}/members?membershipType=all&fields=User Login, DisplayNameとなります
• membershipType(optional): string
  問合せパラメータにより、メンバーシップ・タイプに基づいてロール・メンバーを取得できます。ロール・メンバーシップ・タイプは、direct/indirect/dynamic/allにできます。membershipTypeを明示的に指定しない場合、選択されるデフォルトのmembershipTypeは"ALL"です。"all"のmembershipTypeオプションでは、直接的に、間接的に(ユーザーが子ロールのメンバー)および動的に(ロール・メンバーシップ・ルールに基づいて)ロール・メンバーシップを含むすべてのロール・メンバーを返します。
• q(optional): string
  フィルタ・パラメータに基づいて返されるユーザー・リストをフィルタします。ユーザー属性は、必要なロール・メンバーのフィルタに使用できます。たとえば、従業員番号が1000より大きい直接のロール・メンバーをすべて取得するには、フィルタは/roles/{roleid}/members?membershipType=direct&q=Employee Number gt 1000となります

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

成功

ヘッダー

• ResponseTime: string
  リクエストの処理にかかった時間(ミリ秒)を取得します。

本文()

ルート・スキーマ: RoleMembersGetResponse

型: object

ソースを表示

• count(optional): integer
• hasMore(optional): boolean
• members(optional): array members
• totalResult(optional): integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "members":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RoleMember"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト RoleMember

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

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

型: object

ソースを表示

• user(optional): object RoleMembersUserInfo

{
    "properties":{
        "user":{
            "$ref":"#/definitions/RoleMembersUserInfo"
        }
    }
}

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

型: object

ソースを表示

• displayName(optional): string
• id(optional): string
• links(optional): array links
• name(optional): string
• userLogin(optional): string

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "userLogin":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: object

ソースを表示

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

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401レスポンス

未認可

404レスポンス

リクエスト・エンティティが見つからない

500レスポンス

内部サーバー・エラー

先頭に戻る

例

この例では、指定されたロールの直接のメンバーの取得を示します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl  -H "Content-Type: application/json"  -X GET  -u username:password  
https://pseudo.com/iam/governance/selfservice/api/v1/roles/8/members?membershipType=DIRECT

GETレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/roles/8/members?
membershipType=DIRECT&offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/roles/8/members?
membershipType=DIRECT&offset=1&limit=10"
        }
    ],
    "count": 2,
    "hasMore": false,
    "totalResult": -1,
    "users": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/24"
                }
            ],
            "id": "24",
            "userLogin": "BKIDDO",
            "email": "[e-mail]",
            "startDate": "2019-03-26T18:05:09Z"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/82"
                }
            ],
            "id": "82",
            "userLogin": "TEST55",
            "email": "[e-mail]",
            "startDate": "2019-03-11T22:39:16Z"
        }
    ]
}

先頭に戻る