Oracle Access Governance REST APIs

機械翻訳について

アイデンティティ・コレクションのリストの取得

get

/access-governance/access-controls/20250331/identityCollections

アイデンティティ・コレクションのリストを返します。

リクエスト

問合せパラメータ

identityId: string

権限がアタッチされているリソースのID。
isManagedAtTargetOrchestratedSystem: boolean

trueの場合、orchestratedSystemで管理されるICが返されます

デフォルト値: false
keywordContains: string

フィルタするキーワード。指定できるキーワードは1つのみです。デフォルトは空の文字列です。
limit: integer

最小値: 1

最大値: 1000

返されるアイテムの最大数。

デフォルト値: 10
page: string

最小長: 1

結果の取得を開始する位置を表すトークン。これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。
sortBy: string

ソートの基準となるフィールド。指定できるソート順は1つのみです。 timeCreatedのデフォルトの順序は降順です。 displayNameのデフォルトの順序は昇順です。

デフォルト値: timeCreated

許容値: [ "timeCreated", "displayName" ]
sortOrder: string

使用するソート順(ASCまたはDESC)。

許容値: [ "ASC", "DESC" ]
status: string

指定されたステータスのエンティティの検索に使用するフィルタ。

デフォルト値: ALL

許容値: [ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ]
userId: string

最小長: 1

最大長: 255

操作を実行しているユーザーの識別子

ヘッダー・パラメータ

opc-request-id: string

トレース用のクライアント・リクエストID。リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

権限グループ・オブジェクトのページ。

ヘッダー

opc-next-page: string

アイテム・リストのページ区切り。リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : IdentityCollection

型: object

IdentityCollectionには、アイデンティティ・コレクションに関する要約情報が含まれています。

ソースを表示

items(必須): array items

アイデンティティ・コレクションに関する要約情報を含むリスト。

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List containing summarized information about Identity Collections.",
            "items":{
                "$ref":"#/definitions/IdentityCollectionSummary"
            }
        }
    },
    "description":"IdentityCollection contains summarized information about Identity Collections."
}

ネストされたスキーマ: items

型: array

アイデンティティ・コレクションに関する要約情報を含むリスト。

ソースを表示

Array of: object IdentityCollectionSummary

アイデンティティ・コレクション・モデルのサマリー。

{
    "type":"array",
    "description":"List containing summarized information about Identity Collections.",
    "items":{
        "$ref":"#/definitions/IdentityCollectionSummary"
    }
}

ネストされたスキーマ : IdentityCollectionSummary

型: object

アイデンティティ・コレクション・モデルのサマリー。

ソースを表示

createdBy: object IdInfo

汎用識別情報オブジェクト。
customAttributes: object customAttributes

アクセス・バンドルに関連付けられたメタデータ。
description: string

アイデンティティ・コレクションの説明。
displayName: string

アイデンティティ・コレクションの表示名。
id(必須): string

作成時に変更できない一意の識別子
identityGroupType: string

アイデンティティ・コレクションのタイプ。
isManagedAtOrchestratedSystem: boolean

ICがOrchestrated Systemと共有されているかどうかをチェックするブール値。
isOwner: boolean

ログイン・ユーザーがこのリソースの所有者であるかどうかをチェックするブール値。
membershipRule: string

アイデンティティ・コレクションのメンバーシップ・ルール(例: "all { department EQ AG Department、addresses.country EQ India }")。
name: string

アイデンティティ・コレクションの名前。
orchestratedSystemMetadataAttributes: array orchestratedSystemMetadataAttributes

オーケストレート済システム構成のリスト。isManagedAtOrchestratedSystemがtrueの場合にのみ必要です。
primaryOwner: object PrimaryOwner

プライマリ所有者の詳細。
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」書式設定日時文字列

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Identity Collection."
        },
        "name":{
            "type":"string",
            "description":"Name of the Identity Collection."
        },
        "description":{
            "type":"string",
            "description":"Description of the Identity Collection."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Identity Collection was created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Identity Collection was last updated. An RFC3339 formatted datetime string"
        },
        "identityGroupType":{
            "type":"string",
            "description":"Type of the Identity Collection."
        },
        "createdBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "membershipRule":{
            "type":"string",
            "description":"Membership Rule for the Identity Collection, for ex. \"all { department EQ AG Department , addresses.country EQ India }\"."
        },
        "status":{
            "type":"string",
            "description":"Status of the Identity Collection.",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityStatus",
            "x-default-description":"ACTIVE"
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Identity Collection.",
            "items":{
                "type":"string"
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the access bundle.",
            "properties":{
            }
        },
        "isManagedAtOrchestratedSystem":{
            "type":"boolean",
            "description":"Boolean value checking if IC is shared with Orchestrated System."
        },
        "orchestratedSystemMetadataAttributes":{
            "type":"array",
            "description":"List of Orchestrated System configuration, required only when isManagedAtOrchestratedSystem is true.",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemMetadataAttributes"
            }
        },
        "primaryOwner":{
            "$ref":"#/definitions/PrimaryOwner"
        },
        "isOwner":{
            "type":"boolean",
            "description":"Boolean value checking if logged-in user is owner of this resource or not."
        }
    },
    "description":"Summarized Identity Collection model."
}

ネストされたスキーマ : IdInfo

型: object

汎用識別情報オブジェクト。

ソースを表示

displayName: string

エンティティの表示名。
id: string

エンティティのID。
name: string

エンティティの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic identifying information object."
}

ネストされたスキーマ : customAttributes

型: object

アクセス・バンドルに関連付けられたメタデータ。

ソースを表示

{
    "type":"object",
    "description":"Metadata associated with the access bundle.",
    "properties":{
    }
}

ネストされたスキーマ : orchestratedSystemMetadataAttributes

型: array

オーケストレート済システム構成のリスト。isManagedAtOrchestratedSystemがtrueの場合にのみ必要です。

ソースを表示

Array of: object OrchestratedSystemMetadataAttributes

オーケストレート済システム・メタデータ属性モデル。

{
    "type":"array",
    "description":"List of Orchestrated System configuration, required only when isManagedAtOrchestratedSystem is true.",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemMetadataAttributes"
    }
}

ネストされたスキーマ : PrimaryOwner

型: object

プライマリ所有者の詳細。

ソースを表示

displayName: string

プライマリ所有者の表示名。
value: string

プライマリ所有者のID。

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Id of the primary Owner."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the primary Owner."
        }
    },
    "description":"Details of a primary Owner."
}

ネストされたスキーマ: tags

型: array

アイデンティティ・コレクションに添付されたタグのリスト。

ソースを表示

Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Identity Collection.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : OrchestratedSystemMetadataAttributes

型: object

オーケストレート済システム・メタデータ属性モデル。

ソースを表示

attributes: object OrchestratedSystemAttributes

オーケストレーション・システム属性メタデータに関する情報
id(必須): string

ターゲットのID。
label: string

ターゲットのラベル。

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id of target."
        },
        "label":{
            "type":"string",
            "description":"label of target."
        },
        "attributes":{
            "$ref":"#/definitions/OrchestratedSystemAttributes"
        }
    },
    "description":"Orchestrated System Metadata Attributes model."
}

ネストされたスキーマ : OrchestratedSystemAttributes

型: object

オーケストレーション・システム属性メタデータに関する情報

ソースを表示

items(必須): array items

アカウントと権限属性のコレクション

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"collection of account & permission attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttribute"
            }
        }
    },
    "description":"The information about Orchestrated System attributes metadata"
}

ネストされたスキーマ: items

型: array

アカウントと権限属性のコレクション

ソースを表示

Array of: object OrchestratedSystemAttribute

アカウントおよび権限の属性

{
    "type":"array",
    "description":"collection of account & permission attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttribute"
    }
}

ネストされたスキーマ : OrchestratedSystemAttribute

型: object

アカウントおよび権限の属性

ソースを表示

accountAttributes: array accountAttributes

オーケストレーション・システム・アカウント属性のリスト
orchestratedSystem: object Info

汎用情報オブジェクト。
permissionAttributes: array permissionAttributes

オーケストレーション・システム権限属性のリスト

{
    "type":"object",
    "properties":{
        "orchestratedSystem":{
            "$ref":"#/definitions/Info"
        },
        "accountAttributes":{
            "type":"array",
            "description":"List of Orchestrated System account attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeData"
            }
        },
        "permissionAttributes":{
            "type":"array",
            "description":"List of Orchestrated System permission attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeData"
            }
        }
    },
    "description":"Account & permission attributes"
}

ネストされたスキーマ : accountAttributes

型: array

オーケストレーション・システム・アカウント属性のリスト

ソースを表示

Array of: object OrchestratedSystemAttributeData

オーケストレーション・システム属性

{
    "type":"array",
    "description":"List of Orchestrated System account attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeData"
    }
}

ネストされたスキーマ : 情報

型: object

汎用情報オブジェクト。

ソースを表示

displayName: string

エンティティの表示名。
id: string

エンティティのID。
name: string

エンティティの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the entity."
        },
        "name":{
            "type":"string",
            "description":"name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic information object."
}

ネストされたスキーマ : permissionAttributes

型: array

オーケストレーション・システム権限属性のリスト

ソースを表示

Array of: object OrchestratedSystemAttributeData

オーケストレーション・システム属性

{
    "type":"array",
    "description":"List of Orchestrated System permission attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeData"
    }
}

ネストされたスキーマ : OrchestratedSystemAttributeData

型: object

オーケストレーション・システム属性

ソースを表示

children: array children

ネストされた属性
defaultValues: array defaultValues

属性値
discriminator: string

このフィールドは、属性フィールドがパスワードであることを示します
lookupType: string

属性のLookupID
name: string

属性名
permissionType: string

パーミッション・タイプ
title: string

属性の表示名。
type: string

属性のタイプ

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Attribute name"
        },
        "type":{
            "type":"string",
            "description":"Type of attribute"
        },
        "title":{
            "type":"string",
            "description":"Display Name for the attribute."
        },
        "children":{
            "type":"array",
            "description":"nested attributes",
            "items":{
                "$ref":"#/definitions/NestedAttributes"
            }
        },
        "lookupType":{
            "type":"string",
            "description":"LookupID for the attribute"
        },
        "defaultValues":{
            "type":"array",
            "description":"Attribute Value",
            "items":{
                "type":"string"
            }
        },
        "permissionType":{
            "type":"string",
            "description":"Permission Type"
        },
        "discriminator":{
            "type":"string",
            "description":"this field signify attribute field is password"
        }
    },
    "description":"Orchestrated System Attributes"
}

ネストされたスキーマ: children

型: array

ネストされた属性

ソースを表示

Array of: object NestedAttributes

オーケストレーション・システム属性のネストされたセット

{
    "type":"array",
    "description":"nested attributes",
    "items":{
        "$ref":"#/definitions/NestedAttributes"
    }
}

ネストされたスキーマ : defaultValues

型: array

属性値

ソースを表示

Array of: string

{
    "type":"array",
    "description":"Attribute Value",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : NestedAttributes

型: object

オーケストレーション・システム属性のネストされたセット

ソースを表示

items: array items

オーケストレーションされたシステム属性

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Orchestrated System attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeData"
            }
        }
    },
    "description":"Nested set of Orchestrated System attributes"
}

ネストされたスキーマ: items

型: array

オーケストレーションされたシステム属性

ソースを表示

Array of: object OrchestratedSystemAttributeData

オーケストレーション・システム属性

{
    "type":"array",
    "description":"Orchestrated System attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeData"
    }
}

400レスポンス

不正なリクエスト

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401レスポンス

未認可

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404レスポンス

見つかりません

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429レスポンス

リクエストが多すぎます

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500レスポンス

内部サーバー・エラー

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

デフォルト・レスポンス

不明なエラー

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

code(必須): string

プログラム解析用のエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

トップに戻る

例

次の例は、GETリクエストを発行してアイデンティティ・コレクションのリストを取得する方法を示しています。 Oracle Access Governance内に取り込まれたすべてのアイデンティティ・コレクション(OCI IAMグループを含む)が取得されます。

cURL例 - 問合せパラメータなし

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<host>/access-governance/access-controls/${version}/identityCollections'

レスポンス本文の例

次の例は、使用可能なすべてのアイデンティティ・コレクションのリストを含む、JSON形式のレスポンス本文の内容を示しています:

{
  "items": [
    {
      "id": "073cxxxx-e34c-4fca-a265-be54xxxxxx",
      "displayName": "Finance Team Group",
      "name": "Finance_Team_Default",
      "description": null,
      "timeCreated": "2025-01-09T13:01:04.779Z",
      "timeUpdated": "2025-06-12T13:59:11.846Z",
      "identityGroupType": "OCI_GROUP",
      "createdBy": {
        "id": "AG_System",
        "name": "AG System",
        "displayName": "AG System User"
      },
      "membershipRule": "",
      "status": "ACTIVE",
      "tags": null,
      "customAttributes": {
        "compartmentFQN": "FinanceDept",
        "ocid": "ocid1.group.oc1..aaaaaxxxxxxsemfralbqwnrxxxxxjcdi3e3nwuqumu67jkxp3ihjuoplkynf6q",
        "domainOCID": "ocid1.domain.oc1..aaaaaxxxxxxliko3pohhmxxxxxbbc6exukbcvqgsgdxn36e6pcunmzktgka",
        "cloudAccountName": "FinanceDept",
        "domainId": "resource.OCI.1245xxxx-b600-48eb-a9b1-xxxxxxx",
        "compartmentId": "resource.OCI.1245xxxx-b600-48eb-a9b1-xxxxxxx",
        "compartmentOCID": "ocid1.tenancy.oc1..aaaaaxxxxxxromjm2vmdz4o4xxxxxx",
        "idcsId": "95cxxxxxf27a54126b1bxxxxxxc52f89",
        "compartmentName": "FinanceDept",
        "domainName": "Default",
        "isReviewable": true
      },
      "isManagedAtOrchestratedSystem": false,
      "orchestratedSystemMetadataAttributes": [],
      "primaryOwner": {
        "value": "john.doe@example.com",
        "displayName": "John Doe"
      },
      "isOwner": null
    },
    {
      "id": "78d0xxxx-6127-4361-aaad-xxxxxxc1a5",
      "displayName": "HR Team Group",
      "name": "HR_Team_Alpha",
      "description": null,
      "timeCreated": "2024-07-04T05:32:56.775Z",
      "timeUpdated": "2025-06-12T13:59:11.284Z",
      "identityGroupType": "OCI_GROUP",
      "createdBy": {
        "id": "AG_System",
        "name": "AG System",
        "displayName": "AG System User"
      },
      "membershipRule": "",
      "status": "ACTIVE",
      "tags": null,
      "customAttributes": {
        "compartmentFQN": "HRDept",
        "ocid": "ocid1.group.oc1..aaaaaxxxxxx6yqql4ernxxxxxogvbrgad465gwlguuong2jrzr3j6gpq",
        "domainOCID": "ocid1.domain.oc1..aaaaaxxxxxxqnxpkpo44xxxxxpf3axtwoeav42jt7npr6xixb45moa",
        "cloudAccountName": "HRDept",
        "domainId": "resource.OCI.f101xxxx-7c18-42de-a146-xxxxxx",
        "compartmentId": "resource.OCI.f101xxxx-7c18-42de-a146-xxxxxx",
        "compartmentOCID": "ocid1.tenancy.oc1..aaaaaxxxxxxjsn6newxxxxxwnf4y24h7d5ny27h6f3q",
        "idcsId": "e47xxxxxcaa383411483axxxxxxfe4a",
        "compartmentName": "HRDept",
        "domainName": "Alpha",
        "isReviewable": true
      },
      "isManagedAtOrchestratedSystem": false,
      "orchestratedSystemMetadataAttributes": [],
      "primaryOwner": {
        "value": "emma.smith@example.com",
        "displayName": "Emma Smith"
      },
      "isOwner": null
    }
  ]
}

先頭に戻る