Oracle Access Governance REST APIs

Get a list of Identity Collections

get

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

Returns a list of Identity Collections.

Request

Query Parameters

identityId: string

The ID of the resource that the permissions are attached to.
isManagedAtTargetOrchestratedSystem: boolean

If true will return ICs managed at orchestratedSystem

Default Value: false
keywordContains: string

Keyword to filter on. Only one keyword may be provided. Default is empty string.
limit: integer

Minimum Value: 1

Maximum Value: 1000

The maximum number of items to return.

Default Value: 10
page: string

Minimum Length: 1

A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
sortBy: string

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Default Value: timeCreated

Allowed Values: [ "timeCreated", "displayName" ]
sortOrder: string

The sort order to use, either 'ASC' or 'DESC'.

Allowed Values: [ "ASC", "DESC" ]
status: string

A filter to be used for finding entities with the given status.

Default Value: ALL

Allowed Values: [ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ]
userId: string

Minimum Length: 1

Maximum Length: 255

Identifier of the user who is performing the operation

Header Parameters

opc-request-id: string

The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Response

Supported Media Types

application/json

200 Response

A page of Permission Group objects.

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : IdentityCollection

Type: object

IdentityCollection contains summarized information about Identity Collections.

Show Source

items(required): array items

List containing summarized information about Identity Collections.

{
    "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."
}

Nested Schema : items

Type: array

List containing summarized information about Identity Collections.

Show Source

Array of: object IdentityCollectionSummary

Summarized Identity Collection model.

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

Nested Schema : IdentityCollectionSummary

Type: object

Summarized Identity Collection model.

Show Source

createdBy: object IdInfo

Generic identifying information object.
customAttributes: object customAttributes

Metadata associated with the access bundle.
description: string

Description of the Identity Collection.
displayName: string

Display Name of the Identity Collection.
id(required): string

Unique identifier that is immutable on creation.
identityGroupType: string

Type of the Identity Collection.
isManagedAtOrchestratedSystem: boolean

Boolean value checking if IC is shared with Orchestrated System.
isOwner: boolean

Boolean value checking if logged-in user is owner of this resource or not.
membershipRule: string

Membership Rule for the Identity Collection, for ex. "all { department EQ AG Department , addresses.country EQ India }".
name: string

Name of the Identity Collection.
orchestratedSystemMetadataAttributes: array orchestratedSystemMetadataAttributes

List of Orchestrated System configuration, required only when isManagedAtOrchestratedSystem is true.
primaryOwner: object PrimaryOwner

Details of a primary Owner.
status: string

Allowed Values: [ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]

Status of the Identity Collection.
tags: array tags

List of tags attached to the Identity Collection.
timeCreated: string(date-time)

Time when the Identity Collection was created. An RFC3339 formatted datetime string
timeUpdated: string(date-time)

Time when the Identity Collection was last updated. An RFC3339 formatted datetime string

{
    "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."
}

Nested Schema : IdInfo

Type: object

Generic identifying information object.

Show Source

displayName: string

Display Name of the entity.
id: string

Id of the entity.
name: string

Name of the entity.

{
    "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."
}

Nested Schema : customAttributes

Type: object

Metadata associated with the access bundle.

Show Source

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

Nested Schema : orchestratedSystemMetadataAttributes

Type: array

List of Orchestrated System configuration, required only when isManagedAtOrchestratedSystem is true.

Show Source

Array of: object OrchestratedSystemMetadataAttributes

Orchestrated System Metadata Attributes model.

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

Nested Schema : PrimaryOwner

Type: object

Details of a primary Owner.

Show Source

displayName: string

Display name of the primary Owner.
value: string

Id of the primary Owner.

{
    "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."
}

Nested Schema : tags

Type: array

List of tags attached to the Identity Collection.

Show Source

Array of: string

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

Nested Schema : OrchestratedSystemMetadataAttributes

Type: object

Orchestrated System Metadata Attributes model.

Show Source

attributes: object OrchestratedSystemAttributes

The information about Orchestrated System attributes metadata
id(required): string

id of target.
label: string

label of target.

{
    "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."
}

Nested Schema : OrchestratedSystemAttributes

Type: object

The information about Orchestrated System attributes metadata

Show Source

items(required): array items

collection of account & permission attributes

{
    "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"
}

Nested Schema : items

Type: array

collection of account & permission attributes

Show Source

Array of: object OrchestratedSystemAttribute

Account & permission attributes

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

Nested Schema : OrchestratedSystemAttribute

Type: object

Account & permission attributes

Show Source

accountAttributes: array accountAttributes

List of Orchestrated System account attributes
orchestratedSystem: object Info

Generic information object.
permissionAttributes: array permissionAttributes

List of Orchestrated System permission attributes

{
    "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"
}

Nested Schema : accountAttributes

Type: array

List of Orchestrated System account attributes

Show Source

Array of: object OrchestratedSystemAttributeData

Orchestrated System Attributes

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

Nested Schema : Info

Type: object

Generic information object.

Show Source

displayName: string

Display Name of the entity.
id: string

id of the entity.
name: string

name of the entity.

{
    "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."
}

Nested Schema : permissionAttributes

Type: array

List of Orchestrated System permission attributes

Show Source

Array of: object OrchestratedSystemAttributeData

Orchestrated System Attributes

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

Nested Schema : OrchestratedSystemAttributeData

Type: object

Orchestrated System Attributes

Show Source

children: array children

nested attributes
defaultValues: array defaultValues

Attribute Value
discriminator: string

this field signify attribute field is password
lookupType: string

LookupID for the attribute
name: string

Attribute name
permissionType: string

Permission Type
title: string

Display Name for the attribute.
type: string

Type of attribute

{
    "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"
}

Nested Schema : children

Type: array

nested attributes

Show Source

Array of: object NestedAttributes

Nested set of Orchestrated System attributes

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

Nested Schema : defaultValues

Type: array

Attribute Value

Show Source

Array of: string

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

Nested Schema : NestedAttributes

Type: object

Nested set of Orchestrated System attributes

Show Source

items: array items

Orchestrated System attributes

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

Nested Schema : items

Type: array

Orchestrated System attributes

Show Source

Array of: object OrchestratedSystemAttributeData

Orchestrated System Attributes

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

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error 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 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error 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 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error 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 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error 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 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error 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."
}

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error 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."
}

Examples

The following example shows how to retrieve a list of Identity Collections by submitting a GET request. All the Identity collections ingested within Oracle Access Governance will be retrieved, including OCI IAM Groups.

cURL Example - Without Query Parameters

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

Example of the Response Body

The following example shows the contents of the response body in JSON format, including a list of all available identity collections:

{
  "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
    }
  ]
}