1. Oracle Access Governance REST APIs
  2. Tasks
  3. IdentityCollections

Creates a new Identity Collection

post

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

Request

Header Parameters
  • The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Body ()
Details for the new Identity Collection.
Root Schema : CreateIdentityCollectionDetails
Type: object
Model required for creating a new Identity Collection.
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the identity collection.
Show Source
Nested Schema : excludedIdentities
Type: array
List of excluded 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 : tags
Type: array
List of tags attached to the Identity Collection.
Show Source
Nested Schema : IdInfo
Type: object
Generic identifying information object.
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
Back to Top

Response

Supported Media Types

200 Response

The Identity group was successfully created.
Headers
  • For optimistic concurrency control. See `if-match`.
  • 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

409 Response

Conflict
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 create an Identity Collection in Oracle Access Governance. Replace placeholder values with actual values before running the sample command. If no identities are included in an identity collection, then a new identity collection is created with the Failed status.

Note:

Generate Access Token using grant_type = password or Authorization code.

Before creating an identity collection, run List Identities - [GET] {BasePath}/identities for fetching the required data.

cURL Request Example - Only Named Identities

curl -i -X POST \
   -H "Authorization:Bearer <your-access-token>" \
   -H "Content-Type:application/json" \
   -d \
'{
  "name": "HR Operations Test Team",
  "description": "Human Resources Operations Department",
  "includedIdentities": [
    {
      "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.6axxxxxx",
      "name": "john.doe@example.com",
      "displayName": "John Doe"
    },
    {
      "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.17xxxxxx",
      "name": "emma.smith@example.com",
      "displayName": "Emma Smith"
    }
  ],
  "membershipRule": "",
  "excludedIdentities": [],
  "owners": [
    {
      "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.daxxxxxx",
      "name": "Sophia Johnson",
      "isPrimary": true
    }
  ],
  "tags": [
    "HR Operations"
  ],
  "displayName": "HR Operations Team",
  "isManagedAtOrchestratedSystem": false
}' \
 '<${service-instance-url}/access-governance/access-controls/${version}/identityCollections>'

Example Request Payload - Only Named Identities

{
  "name": "HR Operations Test Team",
  "description": "Human Resources Operations Department",
  "includedIdentities": [
    {
      "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.6axxxxxx",
      "name": "john.doe@example.com",
      "displayName": "John Doe"
    },
    {
      "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.17xxxxxx",
      "name": "emma.smith@example.com",
      "displayName": "Emma Smith"
    }
  ],
  "membershipRule": "",
  "excludedIdentities": [],
  "owners": [
    {
      "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.daxxxxxx",
      "name": "Sophia Johnson",
      "isPrimary": true
    }
  ],
  "tags": [
    "HR Operations"
  ],
  "displayName": "HR Operations Team",
  "isManagedAtOrchestratedSystem": false
}

Example of the Response Code

It may take a few seconds to create an identity collection. Do not try to abort the request.

You'll receive 200 OK response along with the following response body:

{
    "id": "58e7xxxx-46b9-4f8b-81ee-ed30xxxxxx",
    "name": "HR Operations Team",
    "description": "Human Resources Operations Department",
    "status": "ACTIVE",
    "orchestratedSystemId": null,
    "membershipRule": "",
    "parsedMembers": [],
    "parsedIdentityRule": null,
    "includedIdentities": [
        {
            "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.6axxxxxx",
            "name": "john.doe@example.com",
            "userLogin": "john.doe@example.com",
            "email": "john.doe@example.com",
            "manager": null,
            "organization": null,
            "isRuleBased": false,
            "jobCode": null,
            "location": null,
            "employeeType": null,
            "agOrganizations": null
        },
        {
            "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.17xxxxxx",
            "name": "emma.smith@example.com",
            "userLogin": "emma.smith@example.com",
            "email": "emma.smith@example.com",
            "manager": null,
            "organization": null,
            "isRuleBased": false,
            "jobCode": null,
            "location": null,
            "employeeType": null,
            "agOrganizations": null
        }
    ],
    "excludedIdentities": [],
    "ownershipCollectionId": "ff0bxxxx-78a2-4741-88c3-277xxxxx3d4b",
    "owners": [
        {
            "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.daxxxxxx",
            "name": "Sophia Johnson",
            "isPrimary": true
        }
    ],
    "createdBy": {
        "id": "clientId.AG-xxxxxx-cm-jun-28-xxxxx_APPID.AG-xxxxxx-cm-jun-28-xxxxx",
        "name": "clientId.AG-xxxxxx-cm-jun-28-xxxxx_APPID.AG-xxxxxx-cm-jun-28-xxxxx",
        "displayName": "System Generated"
    },
    "updatedBy": {
        "id": "clientId.AG-xxxxxx-cm-jun-28-xxxxx_APPID.AG-xxxxxx-cm-jun-28-xxxxx",
        "name": "clientId.AG-xxxxxx-cm-jun-28-xxxxx_APPID.AG-xxxxxx-cm-jun-28-xxxxx",
        "displayName": "System Generated"
    },
    "timeCreated": "2025-06-12T16:05:33.569Z",
    "timeUpdated": "2025-06-12T16:05:33.569Z",
    "identityGroupType": "HUMAN",
    "finalIdentities": null,
    "tags": ["HR Operations"],
    "customAttributes": null,
    "externalId": null,
    "displayName": "HR Operations Team",
    "isManagedAtOrchestratedSystem": false,
    "orchestratedSystemMetadataAttributes": []
}

Example Request Payload - Using Membership Rules

{
  "name": "Networking Group",
  "description": "Networking Team for Infrastructure",
  "includedIdentities": [],
  "membershipRule": "all { department EQ 0865 , agOrganizations.displayName EQ Network Administrators }",
  "excludedIdentities": [],
  "owners": [
    {
      "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxx3765xxxx.daxxxxxx",
      "name": "Ama Maclead",
      "isPrimary": true
    }
  ],
  "tags": [
    "Networking Infrastructure"
  ],
  "displayName": "Networking Team",
  "isManagedAtOrchestratedSystem": false
}

Example of the Response Code

It may take a few seconds to create a role. Do not try to abort the request.

You'll receive 200 OK response along with the following response body:

{
    "id": "1d8fxxxx-acee-45b1-a6ca-18b9xxxxx",
    "name": "Networking Team",
    "description": "Networking Team for Infrastructure",
    "status": "IN_PROGRESS",
    "orchestratedSystemId": null,
    "membershipRule": "all { department EQ 0865 , agOrganizations.displayName EQ Network Administrators }",
    "parsedMembers": null,
    "parsedIdentityRule": {
        "bindingOperator": "ALL",
        "parsedOn": "2549970323079902",
        "attributeConditions": [
            {
                "attrKey": {
                    "id": "department",
                    "name": "Department",
                    "displayName": "Department"
                },
                "operator": {
                    "id": "EQ",
                    "name": "EQ",
                    "displayName": "Equals"
                },
                "attrValue": "0865",
                "attrType": "string",
                "parentType": null,
                "parentId": null,
                "values": null
            },
            {
                "attrKey": {
                    "id": "agOrganizations.displayName",
                    "name": "Organization",
                    "displayName": "Organization"
                },
                "operator": {
                    "id": "EQ",
                    "name": "EQ",
                    "displayName": "Equals"
                },
                "attrValue": "Network Administrators",
                "attrType": "string",
                "parentType": null,
                "parentId": "agOrganizations",
                "values": null
            }
        ]
    },
    "includedIdentities": [],
    "excludedIdentities": [],
    "ownershipCollectionId": "6687xxxx-6db7-4dc4-bb6f-5ceaxxxxx",
    "owners": [
        {
            "id": "globalId.OCI.f101xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.daxxxxxx",
            "name": "Sophia Johnson",
            "isPrimary": true
        }
    ],
    "createdBy": {
        "id": "clientId.AG-xxxxxx-cm-jun-28-xxxxx_APPID.AG-xxxxxx-cm-jun-28-xxxxx",
        "name": "clientId.AG-xxxxxx-cm-jun-28-xxxxx_APPID.AG-xxxxxx-cm-jun-28-xxxxx",
        "displayName": "System Generated"
    },
    "updatedBy": {
        "id": "clientId.AG-xxxxxx-cm-jun-28-xxxxx_APPID.AG-xxxxxx-cm-jun-28-xxxxx",
        "name": "clientId.AG-xxxxxx-cm-jun-28-xxxxx_APPID.AG-xxxxxx-cm-jun-28-xxxxx",
        "displayName": "System Generated"
    },
    "timeCreated": "2025-06-13T08:40:44.592Z",
    "timeUpdated": "2025-06-13T08:40:44.592Z",
    "identityGroupType": "HUMAN",
    "finalIdentities": null,
    "tags": [
        "Networking Infrastructure"
    ],
    "customAttributes": null,
    "externalId": null,
    "displayName": "Networking Team",
    "isManagedAtOrchestratedSystem": false,
    "orchestratedSystemMetadataAttributes": []
}
Back to Top