ロールIDによるロールの取得
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/10
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/roles/10"
}
],
"id": "10",
"fields": [
{
"name": "Role Name",
"value": "Fraud Supervisor"
},
{
"name": "Owner Login",
"value": "SYSTEM ADMINISTRATOR"
},
{
"name": "ugp_update",
"value": "2019-03-11T21:58:40Z"
},
{
"name": "ugp_createby",
"value": 1
},
{
"name": "Owner Last Name",
"value": "Administrator"
},
{
"name": "Role Key",
"value": "10"
},
{
"name": "Owner First Name",
"value": "System"
},
{
"name": "ugp_create",
"value": "2019-03-11T21:58:40Z"
},
{
"name": "Role Display Name",
"value": {
"base": "Fraud Supervisor"
}
},
{
"name": "ugp_updateby",
"value": 1
},
{
"name": "Owner Display Name",
"value": "System Administrator"
},
{
"name": "Role Unique Name",
"value": "Fraud Supervisor"
},
{
"name": "Role Category Key",
"value": 1
},
{
"name": "Role Owner Key",
"value": 1
},
{
"name": "Owner Email",
"value": "donotreply@pseudo.com"
},
{
"name": "Role Namespace",
"value": "Default"
},
{
"name": "Role Category Name",
"value": "Default"
},
{
"name": "Role Owner Key",
"value": 1,
"link": {
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/1"
}
}
]
}