ロールの取得
get
/iam/governance/selfservice/api/v1/roles/{roleid}
特定のロールIDのロール詳細を返します。レスポンス・ペイロードは、fields問合せパラメータを指定して制御できます。fieldsパラメータを指定しない場合、ロールのすべての属性が返されます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- roleid: string
返されるロールのロールID。
問合せパラメータ
- fields(optional): string
属性名のカンマ区切りリストはfields問合せパラメータに渡されます。たとえば、ロールの表示名、一意の名前および説明のみを取得するには、URIは"/role?fields=Role Unique Name,Role Display Name,Role Description"となります。レスポンスには、ロールの一意識別子であるロール・キーおよびロールIDが含まれています。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
401レスポンス
未認可
404レスポンス
リクエスト・エンティティが見つからない
500レスポンス
内部サーバー・エラー
例
この例では、単一のロール定義を取得する機能を示します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。
cURLの例
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/roles/7
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"id": "7",
"name": "Role1",
"displayname": "Role1",
"attributes": {
"Role Display Name": {
"base": "Role1"
},
"Role Unique Name": "Role1",
"Owner Login": {
"Links": {
"rel": "self",
"href": "http://pseudo.com/iam/goverance/selfservice/api/v1/roles/SYSTEM_ADMINISTRATOR"
},
"value": "XELSYSADM"
},
"ugp_createby": 1,
"Role Owner Key": 1,
"Role Description": null,
"Role Name": "Role1",
"ugp_create": 1456753163000,
"ugp_update": 1456754274000,
"Owner Email": "donotreply@mydomain.com",
"Role Namespace": "Default",
"Owner Display Name": "System Administrator",
"Role Key": "7",
"LDAP GUID": null,
"ugp_updateby": 1,
"Request Id": "2001",
"Role Category Key": 1,
"Owner Last Name": "Administrator",
"User Membership Rule": null,
"ugp_data_level": null,
"Role Email": null,
"LDAP DN": null,
"Owner First Name": "System",
"Role Category Name": "Default"
},
"linkDatalst": [
]
}