アイデンティティ・コレクションの取得
get
/access-governance/access-controls/20250331/identityCollections/{identityCollectionId}
識別子によるアイデンティティ・コレクションの取得
リクエスト
パス・パラメータ
- identityCollectionId(required): string
一意のアイデンティティ収集識別子
問合せパラメータ
- insights: boolean
追加データが必要かどうかにかかわらず渡すブール問合せパラメータデフォルト値:
false
ヘッダー・パラメータ
- opc-request-id: string
トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
指定されたIDのアイデンティティ・コレクションを取得
ヘッダー
- opc-next-page: string
アイテム・リストのページ区切り。 リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。 この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : IdentityCollectionResponse
型:
object
アイデンティティ収集モデル。
ソースを表示
- createdBy: object IdInfo
汎用識別情報オブジェクト。
- customAttributes: object customAttributes
ポリシー・ルールに関連付けられたメタデータ。
- description: string
アイデンティティ・コレクションの説明。
- displayName: string
アイデンティティ・コレクションのdisplayName。
- excludedIdentities: array excludedIdentities
除外されたアイデンティティのリスト。
- externalId: string
アイデンティティ・コレクションのexternalId。
- finalIdentities: array finalIdentities
最後のアイデンティティのリスト。
- id(必須): string
作成時に変更できない一意の識別子
- identityGroupType: string
最小長:
1
最大長:255
アイデンティティ・コレクションのタイプ。 - includedIdentities: array includedIdentities
含まれるアイデンティティのリスト。
- isManagedAtOrchestratedSystem: boolean
ICがOrchestrated Systemsと共有されているかどうかをチェックするブール値。
- membershipRule: string
アイデンティティ・コレクションのメンバーシップ・ルール(例: "all { department EQ AG Department、addresses.country EQ India }")。
- name: string
アイデンティティ・コレクションの名前。
- orchestratedSystemId: string
アイデンティティ・コレクションに関連付けられたオーケストレート済システムID。
- orchestratedSystemMetadataAttributes: array orchestratedSystemMetadataAttributes
オーケストレート済システム構成のリスト。
- owners: array owners
所有者エンティティのリスト。
- ownershipCollectionId: string
所有権コレクションは、アイデンティティ・コレクションに関連付けられます。
- parsedIdentityRule: object ParsedIdentityRuleResponse
解析されたメンバーシップ・ルール・オブジェクト。
- parsedMembers: array parsedMembers
解析されたIDのリスト。
- status: string
許容値:
[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]
アイデンティティ・グループのステータス。 - tags: array tags
アイデンティティ・コレクションに添付されたタグのリスト。
- timeCreated: string(date-time)
アイデンティティ・コレクションが作成された時間。 「An RFC3339」書式設定日時文字列
- timeUpdated: string(date-time)
アイデンティティ・コレクションが最後に更新された時間。 「An RFC3339」書式設定日時文字列
- updatedBy: object IdInfo
汎用識別情報オブジェクト。
ネストされたスキーマ : IdInfo
型:
object
汎用識別情報オブジェクト。
ソースを表示
- displayName: string
エンティティの表示名。
- id: string
エンティティのID。
- name: string
エンティティの名前。
ネストされたスキーマ : excludedIdentities
型:
array
除外されたアイデンティティのリスト。
ソースを表示
- Array of: object IdentitySummary
アイデンティティ・サマリー。
ネストされたスキーマ : finalIdentities
型:
array
最後のアイデンティティのリスト。
ソースを表示
- Array of: object IdentitySummary
アイデンティティ・サマリー。
ネストされたスキーマ : includedIdentities
型:
array
含まれるアイデンティティのリスト。
ソースを表示
- Array of: object IdentitySummary
アイデンティティ・サマリー。
ネストされたスキーマ : orchestratedSystemMetadataAttributes
型:
array
オーケストレート済システム構成のリスト。
ソースを表示
- Array of: object OrchestratedSystemMetadataAttributes
オーケストレート済システム・メタデータ属性モデル。
ネストされたスキーマ : ParsedIdentityRuleResponse
型:
object
解析されたメンバーシップ・ルール・オブジェクト。
ソースを表示
- attributeConditions: array attributeConditions
属性条件
- bindingOperator: string
バインド演算子
- parsedOn: string
タイムスタンプで文字列として解析されます。
ネストされたスキーマ : parsedMembers
型:
array
解析されたIDのリスト。
ソースを表示
- Array of: object IdentitySummary
アイデンティティ・サマリー。
ネストされたスキーマ : IdentitySummary
型:
object
アイデンティティ・サマリー。
ソースを表示
- agOrganizations: array agOrganizations
アイデンティティが含まれるAGOrganizations。
- email: string
作成時に不変である一意のOracle ID (OCID)。
- employeeType: string
アイデンティティのemployeeType。
- id(必須): string
作成時に不変である一意のOracle ID (OCID)。
- isRuleBased: boolean
(オプション・パラメータ)このアイデンティティはルール・ベースです。
- jobCode: string
アイデンティティのjobCode。
- location: string
IDのロケーション。
- manager: string
作成時に不変である一意のOracle ID (OCID)。
- name: string
わかりやすい名前。 一意である必要はなく、変更可能です。 機密情報の入力は避けてください。
- organization: string
作成時に不変である一意のOracle ID (OCID)。
- userLogin: string
作成時に不変である一意のOracle ID (OCID)。
ネストされたスキーマ : OrchestratedSystemMetadataAttributes
型:
object
オーケストレート済システム・メタデータ属性モデル。
ソースを表示
- attributes: object OrchestratedSystemAttributes
オーケストレーション・システム属性メタデータに関する情報
- id(必須): string
ターゲットのID。
- label: string
ターゲットのラベル。
ネストされたスキーマ : OrchestratedSystemAttributes
型:
object
オーケストレーション・システム属性メタデータに関する情報
ソースを表示
- items(必須): array items
アカウントと権限属性のコレクション
ネストされたスキーマ: items
型:
array
アカウントと権限属性のコレクション
ソースを表示
- Array of: object OrchestratedSystemAttribute
アカウントおよび権限の属性
ネストされたスキーマ : OrchestratedSystemAttribute
型:
object
アカウントおよび権限の属性
ソースを表示
- accountAttributes: array accountAttributes
オーケストレーション・システム・アカウント属性のリスト
- orchestratedSystem: object Info
汎用情報オブジェクト。
- permissionAttributes: array permissionAttributes
オーケストレーション・システム権限属性のリスト
ネストされたスキーマ : accountAttributes
型:
array
オーケストレーション・システム・アカウント属性のリスト
ソースを表示
- Array of: object OrchestratedSystemAttributeData
オーケストレーション・システム属性
ネストされたスキーマ : 情報
型:
object
汎用情報オブジェクト。
ソースを表示
- displayName: string
エンティティの表示名。
- id: string
エンティティのID。
- name: string
エンティティの名前。
ネストされたスキーマ : permissionAttributes
型:
array
オーケストレーション・システム権限属性のリスト
ソースを表示
- Array of: object OrchestratedSystemAttributeData
オーケストレーション・システム属性
ネストされたスキーマ : OrchestratedSystemAttributeData
型:
object
オーケストレーション・システム属性
ソースを表示
- children: array children
ネストされた属性
- defaultValues: array defaultValues
属性値
- discriminator: string
このフィールドは、属性フィールドがパスワードであることを示します
- lookupType: string
属性のLookupID
- name: string
属性名
- permissionType: string
パーミッション・タイプ
- title: string
属性の表示名。
- type: string
属性のタイプ
ネストされたスキーマ: children
型:
array
ネストされた属性
ソースを表示
- Array of: object NestedAttributes
オーケストレーション・システム属性のネストされたセット
ネストされたスキーマ : NestedAttributes
型:
object
オーケストレーション・システム属性のネストされたセット
ソースを表示
- items: array items
オーケストレーションされたシステム属性
ネストされたスキーマ: items
型:
array
オーケストレーションされたシステム属性
ソースを表示
- Array of: object OrchestratedSystemAttributeData
オーケストレーション・システム属性
ネストされたスキーマ : OwnerSummary
型:
object
所有者エンティティ・オブジェクト
ソースを表示
- id(必須): string
作成時に変更できない一意の識別子
- isPrimary(required): boolean
このエンティティはプライマリ所有者ですか?
- name(required): string
所有者の名前
ネストされたスキーマ : AttributeConditionResponse
型:
object
属性条件
ソースを表示
- attrKey: object IdInfo
汎用識別情報オブジェクト。
- attrType: string
属性タイプ
- attrValue: string
属性値
- operator: object IdInfo
汎用識別情報オブジェクト。
- parentId: string
親ID
- parentType: string
親タイプ
- values: array values
複数値演算子の属性値
400レスポンス
不正なリクエスト
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
401レスポンス
未認可
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
404レスポンス
見つかりません
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
429レスポンス
リクエストが多すぎます
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
500レスポンス
内部サーバー・エラー
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
デフォルト・レスポンス
不明なエラー
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
例
次の例は、特定のアイデンティティ・コレクションの詳細を取得する方法を示しています。
cURLの例
curl -i -X GET \
-H "Authorization:Bearer <your access token >" \
'${service-instance-url}/access-governance/access-controls/${version}/identityCollections/${identityCollectionId}'
レスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
このJSONには、Oracle Access Governance内に作成されたアイデンティティ・コレクションのグループ詳細、メンバーシップ構成、アイデンティティ属性および所有権詳細が含まれます。
{
"id": "76fcxxxx-dd3f-481a-ac83-b688xxxxxx",
"name": "Engineering_Team_SS",
"description": "Self-Service Group for Engineering Team",
"status": "ACTIVE",
"orchestratedSystemId": null,
"membershipRule": "",
"parsedMembers": null,
"parsedIdentityRule": null,
"includedIdentities": null,
"excludedIdentities": null,
"ownershipCollectionId": null,
"owners": null,
"createdBy": {
"id": "AG_System_SelfService",
"name": "AG System",
"displayName": "AG System User"
},
"updatedBy": {
"id": "AG_System_SelfService",
"name": "AG System",
"displayName": "AG System User"
},
"timeCreated": "2025-04-02T11:13:31.813Z",
"timeUpdated": "2025-05-07T14:45:09.500Z",
"identityGroupType": "HUMAN",
"finalIdentities": [
{
"id": "globalId.8dxxxxxx-ab68-4f09-ae89-xxxxxx",
"name": "Bill Clark",
"userLogin": "bill.clark@example.com",
"email": "bill.clark@example.com",
"manager": "Emily Taylor",
"organization": "Software Engineering",
"isRuleBased": false,
"jobCode": "IC002",
"location": null,
"employeeType": "Part-Time",
"agOrganizations": null
},
{
"id": "globalId.ICF.21xxxxxx-744e-4689-b04b-xxxxxx",
"name": "John Doe",
"userLogin": "john.doe",
"email": "john.doe@example.com",
"manager": null,
"organization": "Engineering",
"isRuleBased": false,
"jobCode": "IC1741585617",
"location": "Loc_John.Doe",
"employeeType": "Employee",
"agOrganizations": null
}
],
"tags": null,
"customAttributes": {
"selfServiceManaged": true
},
"externalId": null,
"displayName": "Engineering_Team_SS",
"isManagedAtOrchestratedSystem": false,
"orchestratedSystemMetadataAttributes": []
}