Get an Identity Collection

get

/access-governance/access-controls/20250331/identityCollections/{identityCollectionId}

Gets a Identity Collections by identifier

Request

Path Parameters
Query Parameters
  • Boolean query param to pass if extra data is required or not
    Default Value: false
Header Parameters
  • The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Back to Top

Response

Supported Media Types

200 Response

Retrieves the Identity Collection with the given id
Headers
  • 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.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : IdentityCollectionResponse
Type: object
Identity Collection model.
Show Source
Nested Schema : IdInfo
Type: object
Generic identifying information object.
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the policy rule.
Show Source
Nested Schema : excludedIdentities
Type: array
List of the excluded identities.
Show Source
Nested Schema : finalIdentities
Type: array
List of the final Identities.
Show Source
Nested Schema : includedIdentities
Type: array
List of the included identities.
Show Source
Nested Schema : orchestratedSystemMetadataAttributes
Type: array
List of Orchestrated System configuration.
Show Source
Nested Schema : owners
Type: array
List of owner entities.
Show Source
Nested Schema : ParsedIdentityRuleResponse
Type: object
Parsed membership rule object.
Show Source
Nested Schema : parsedMembers
Type: array
List of the parsed Identities.
Show Source
Nested Schema : tags
Type: array
List of tags attached to the Identity Collection.
Show Source
Nested Schema : IdentitySummary
Type: object
Identity Summary.
Show Source
Nested Schema : agOrganizations
Type: array
The AGOrganizations of which the identity is part of.
Show Source
Nested Schema : OrchestratedSystemMetadataAttributes
Type: object
Orchestrated System Metadata Attributes model.
Show Source
Nested Schema : OrchestratedSystemAttributes
Type: object
The information about Orchestrated System attributes metadata
Show Source
Nested Schema : items
Type: array
collection of account & permission attributes
Show Source
Nested Schema : OrchestratedSystemAttribute
Type: object
Account & permission attributes
Show Source
Nested Schema : accountAttributes
Type: array
List of Orchestrated System account attributes
Show Source
Nested Schema : Info
Type: object
Generic information object.
Show Source
Nested Schema : permissionAttributes
Type: array
List of Orchestrated System permission attributes
Show Source
Nested Schema : OrchestratedSystemAttributeData
Type: object
Orchestrated System Attributes
Show Source
Nested Schema : children
Type: array
nested attributes
Show Source
Nested Schema : defaultValues
Type: array
Attribute Value
Show Source
Nested Schema : NestedAttributes
Type: object
Nested set of Orchestrated System attributes
Show Source
Nested Schema : items
Type: array
Orchestrated System attributes
Show Source
Nested Schema : OwnerSummary
Type: object
Owner entity object
Show Source
Nested Schema : attributeConditions
Type: array
Attribute condition
Show Source
Nested Schema : AttributeConditionResponse
Type: object
Attribute condition.
Show Source
Nested Schema : values
Type: array
Attribute Values for Multi Value operators
Show Source

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

Default Response

Unknown Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source
Back to Top

Examples

The following example shows how to retrieve details for a specific identity collection.

cURL Example

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

Example of the Response Body

The following example shows the contents of the response body in JSON format:

This JSON contains group details, membership composition, identity attributes, and ownership details for an Identity Collection created within 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": []
}
Back to Top