Get an Identity Collection
get
/access-governance/access-controls/20250331/identityCollections/{identityCollectionId}
Gets a Identity Collections by identifier
Request
Path Parameters
-
identityCollectionId(required): string
Unique Identity Collection identifier
Query Parameters
-
insights: boolean
Boolean query param to pass if extra data is required or notDefault Value:
false
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
Retrieves the Identity Collection with the given id
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 : IdentityCollectionResponse
Type:
object
Identity Collection model.
Show Source
-
createdBy:
object IdInfo
Generic identifying information object.
-
customAttributes:
object customAttributes
Metadata associated with the policy rule.
-
description:
string
Description of the Identity Collection.
-
displayName:
string
displayName of the Identity Collection.
-
excludedIdentities:
array excludedIdentities
List of the excluded identities.
-
externalId:
string
externalId of the Identity Collection.
-
finalIdentities:
array finalIdentities
List of the final Identities.
-
id(required):
string
Unique identifier that is immutable on creation.
-
identityGroupType:
string
Minimum Length:
1
Maximum Length:255
Type of the Identity Collection. -
includedIdentities:
array includedIdentities
List of the included identities.
-
isManagedAtOrchestratedSystem:
boolean
Boolean value checking if IC is shared with Orchestrated Systems.
-
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.
-
orchestratedSystemId:
string
Orchestrated System Id associated with the Identity Collection.
-
orchestratedSystemMetadataAttributes:
array orchestratedSystemMetadataAttributes
List of Orchestrated System configuration.
-
owners:
array owners
List of owner entities.
-
ownershipCollectionId:
string
Ownership collection associate with the Identity Collection.
-
parsedIdentityRule:
object ParsedIdentityRuleResponse
Parsed membership rule object.
-
parsedMembers:
array parsedMembers
List of the parsed Identities.
-
status:
string
Allowed Values:
[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]
Status of the Identity Group. -
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
-
updatedBy:
object IdInfo
Generic identifying information object.
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.
Nested Schema : excludedIdentities
Type:
array
List of the excluded identities.
Show Source
-
Array of:
object IdentitySummary
Identity Summary.
Nested Schema : finalIdentities
Type:
array
List of the final Identities.
Show Source
-
Array of:
object IdentitySummary
Identity Summary.
Nested Schema : includedIdentities
Type:
array
List of the included identities.
Show Source
-
Array of:
object IdentitySummary
Identity Summary.
Nested Schema : orchestratedSystemMetadataAttributes
Type:
array
List of Orchestrated System configuration.
Show Source
-
Array of:
object OrchestratedSystemMetadataAttributes
Orchestrated System Metadata Attributes model.
Nested Schema : owners
Type:
array
List of owner entities.
Show Source
-
Array of:
object OwnerSummary
Owner entity object
Nested Schema : ParsedIdentityRuleResponse
Type:
object
Parsed membership rule object.
Show Source
-
attributeConditions:
array attributeConditions
Attribute condition
-
bindingOperator:
string
Binding operator
-
parsedOn:
string
Parsed On timestamp as string.
Nested Schema : parsedMembers
Type:
array
List of the parsed Identities.
Show Source
-
Array of:
object IdentitySummary
Identity Summary.
Nested Schema : IdentitySummary
Type:
object
Identity Summary.
Show Source
-
agOrganizations:
array agOrganizations
The AGOrganizations of which the identity is part of.
-
email:
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
employeeType:
string
The employeeType of the identitiy.
-
id(required):
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
isRuleBased:
boolean
(optional parameter) Is this identity ruled based.
-
jobCode:
string
The jobCode of the identity.
-
location:
string
The location of the identitiy.
-
manager:
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
name:
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
-
organization:
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
userLogin:
string
The Unique Oracle ID (OCID) that is immutable on creation.
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
-
attributes:
object OrchestratedSystemAttributes
The information about Orchestrated System attributes metadata
-
id(required):
string
id of target.
-
label:
string
label of target.
Nested Schema : OrchestratedSystemAttributes
Type:
object
The information about Orchestrated System attributes metadata
Show Source
-
items(required):
array items
collection of account & permission attributes
Nested Schema : items
Type:
array
collection of account & permission attributes
Show Source
-
Array of:
object OrchestratedSystemAttribute
Account & permission attributes
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
Nested Schema : accountAttributes
Type:
array
List of Orchestrated System account attributes
Show Source
-
Array of:
object OrchestratedSystemAttributeData
Orchestrated System Attributes
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.
Nested Schema : permissionAttributes
Type:
array
List of Orchestrated System permission attributes
Show Source
-
Array of:
object OrchestratedSystemAttributeData
Orchestrated System Attributes
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
Nested Schema : children
Type:
array
nested attributes
Show Source
-
Array of:
object NestedAttributes
Nested set of Orchestrated System attributes
Nested Schema : NestedAttributes
Type:
object
Nested set of Orchestrated System attributes
Show Source
-
items:
array items
Orchestrated System attributes
Nested Schema : items
Type:
array
Orchestrated System attributes
Show Source
-
Array of:
object OrchestratedSystemAttributeData
Orchestrated System Attributes
Nested Schema : OwnerSummary
Type:
object
Owner entity object
Show Source
-
id(required):
string
Unique identifier that is immutable on creation
-
isPrimary(required):
boolean
Is this entity the primary owner?
-
name(required):
string
Name of the owner
Nested Schema : attributeConditions
Type:
array
Attribute condition
Show Source
-
Array of:
object AttributeConditionResponse
Attribute condition.
Nested Schema : AttributeConditionResponse
Type:
object
Attribute condition.
Show Source
-
attrKey:
object IdInfo
Generic identifying information object.
-
attrType:
string
Attribute Type
-
attrValue:
string
Attribute Value
-
operator:
object IdInfo
Generic identifying information object.
-
parentId:
string
Parent Id
-
parentType:
string
Parent Type
-
values:
array values
Attribute Values for Multi Value operators
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.
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.
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.
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.
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.
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.
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": []
}