すべてのカタログ項目の取得
get
/iam/governance/selfservice/api/v1/catalog
カタログで公開されたすべてのカタログ項目のリストを返します。カタログ項目は、エンティティ・タイプのアプリケーション・インスタンス、権限およびロールにできます。適切なフィルタ・パラメータを使用して、カタログ項目の特定のタイプをフィルタできます。
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- q(optional): string
レコードを取得する検索フィルタ。SCIMフィルタを受け入れます。フィルタ値に空白は使用できません。フィルタ値に空白を渡す場合、"::"に置き換えます。フィルタでサポートされている検索属性は、ENTITY_TYPE/ENTITY_NAME/ENTITY_DISPLAY_NAME/USER_DEFINED_TAGSです。カタログでは、一度に"ENTITY_NAME/ENTITY_DISPLAY_NAME/USER_DEFINED_FIELDS"から検索フィルタを1つのみ受け入れて、検索フィルタは暗黙的に"BEGINS_WITH"として適用されます。例: USER_DEFINED_TAGS sw User。フィルタでは、"offset"、"limit"、"orderBy"もサポートしています。例: offset=3&limit=5&orderBy=CATALOG_ID:descending。ENTITY_TYPEフィルタは、残りの3つのフィルタのいずれかと組み合せることができます。指定可能な値は、ApplicationInstance/Role/Entitlementです。ENTITY_TYPEを指定しない場合、すべてのカタログ項目が返されます。カタログからリクエスト可能なエンティティのみが返されます。たとえば、表示名がAで始まるすべての権限を取得するには、フィルタは"/catalog?q=ENTITY_TYPE eq Entitlements AND ENTITY_DISPLAY_NAME sw A"となります
レスポンス
サポートされているメディア・タイプ
- 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//catalog?q=ENTITY_TYPE eq Entitlement and ENTITY_NAME sw 24&offset=3&limit=5&orderBy=CATALOG_ID:descendingGET Response Body
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog?offset=1&limit=10"
},
{
"rel": "first",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog?offset=1&limit=10"
},
{
"rel": "next",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog?offset=11&limit=10"
}
],
"count": 10,
"hasMore": true,
"totalResult": -1,
"catalogs": [
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/1"
}
],
"id": 1,
"entityType": "Role",
"entityName": "Employee",
"entityDisplayName": "Employee Role"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/2"
}
],
"id": 2,
"entityType": "ApplicationInstance",
"entityName": "SharedFileServer",
"entityDisplayName": "Shared File Server"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/22"
}
],
"id": 22,
"entityType": "ApplicationInstance",
"entityName": "DBAT",
"entityDisplayName": "DBAT"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/24"
}
],
"id": 24,
"entityType": "Role",
"entityName": "TestRole6",
"entityDisplayName": "TestRole6"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/25"
}
],
"id": 25,
"entityType": "Role",
"entityName": "TestRole1",
"entityDisplayName": "TestRole-h"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/26"
}
],
"id": 26,
"entityType": "Role",
"entityName": "TestRole2",
"entityDisplayName": "TestRole2"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/27"
}
],
"id": 27,
"entityType": "Role",
"entityName": "TestRole3",
"entityDisplayName": "TestRole3"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/28"
}
],
"id": 28,
"entityType": "Role",
"entityName": "TestRole4",
"entityDisplayName": "TestRole4"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/29"
}
],
"id": 29,
"entityType": "Role",
"entityName": "TestRole5",
"entityDisplayName": "TestRole5"
},
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/115"
}
],
"id": 115,
"entityType": "ApplicationInstance",
"entityName": "EmployeeBadge016",
"entityDisplayName": "Employee Badge Disp_016"
}
]
}