ロール・メンバーの取得
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
リクエストの処理にかかった時間(ミリ秒)を取得します。
401レスポンス
未認可
404レスポンス
リクエスト・エンティティが見つからない
500レスポンス
内部サーバー・エラー
例
この例では、指定されたロールの直接のメンバーの取得を示します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。
cURLの例
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/roles/27/members?membershipType=DIRECT
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/roles/27/members"
}
],
"count": 1,
"totalResult": 1,
"users": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/XELSYSADM"
}
],
"id": "1",
"name": "System",
"userLogin": "XELSYSADM",
"displayName": "System Administrator",
"email": "donotreply@mydomain.com"
}
]
}