Oracle Access Governance REST APIs

Get a list of members in an identity collection

get

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

Returns list of members for a given identity collection

Request

Path Parameters

identityCollectionId(required): string

Unique Identity Collection identifier

Query Parameters

keywordContains: array[string]

Collection Format: multi

Maximum Number of Items: 5

The list of keywords to filter on
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" ]

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

The List of members of given Identity Collection was successfully queried.

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 : AccessGovernanceTypeCollection

Type: object

A list of Access Governance Entity items.

Show Source

items(required): array items

List of Access Governance Entity items.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Access Governance Entity items.",
            "items":{
                "$ref":"#/definitions/AccessGovernanceEntity"
            }
        }
    },
    "description":"A list of Access Governance Entity items."
}

Nested Schema : items

Type: array

List of Access Governance Entity items.

Show Source

Array of: object AccessGovernanceEntity

An Access Governance Entity

{
    "type":"array",
    "description":"List of Access Governance Entity items.",
    "items":{
        "$ref":"#/definitions/AccessGovernanceEntity"
    }
}

Nested Schema : AccessGovernanceEntity

Type: object

An Access Governance Entity

Show Source

entityType(required): string

The Entity type in Access Governance
id(required): string

The Id for Access Governance Entity
isRuleBased: boolean

Is this identity ruled based
name(required): string

The name for Access Governance Type
timeCreated(required): string(date-time)

Time when entity was created by Access Governance
timeUpdated(required): string(date-time)

Time when entity was last modified by Access Governance
type(required): string

Allowed Values: [ "IDENTITY", "IDENTITY_COLLECTION", "ORGANIZATION", "ROLE", "PERMISSION", "ACCESS_BUNDLE", "POLICY", "RESOURCE", "CLOUD_RESOURCE", "ACCOUNT", "OWNERSHIP", "APPROVAL_PROCESS", "TARGET", "ACCESS_GUARDRAIL" ]

The Access Governance Entity Type
value(required): string

The json schema for Access Governance Type

{
    "type":"object",
    "required":[
        "entityType",
        "id",
        "name",
        "timeCreated",
        "timeUpdated",
        "type",
        "value"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Id for Access Governance Entity"
        },
        "type":{
            "type":"string",
            "description":"The Access Governance Entity Type",
            "enum":[
                "IDENTITY",
                "IDENTITY_COLLECTION",
                "ORGANIZATION",
                "ROLE",
                "PERMISSION",
                "ACCESS_BUNDLE",
                "POLICY",
                "RESOURCE",
                "CLOUD_RESOURCE",
                "ACCOUNT",
                "OWNERSHIP",
                "APPROVAL_PROCESS",
                "TARGET",
                "ACCESS_GUARDRAIL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityType"
        },
        "name":{
            "type":"string",
            "description":"The name for Access Governance Type"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when entity was created by Access Governance"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when entity was last modified by Access Governance"
        },
        "isRuleBased":{
            "type":"boolean",
            "description":"Is this identity ruled based"
        },
        "entityType":{
            "type":"string",
            "description":"The Entity type in Access Governance"
        },
        "value":{
            "type":"string",
            "description":"The json schema for Access Governance Type"
        }
    },
    "description":"An Access Governance Entity"
}

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

409 Response

Conflict

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 included members list in an Identity Collection.

cURL Example - Without Query Parameters

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

Example of the Response Body

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

This JSON contains members included in the identity collection, including identity details, personal attributes, job-related information, account status, and department associations.

{
  "items": [
    {
      "id": "globalId.8dxxxxxx-ab68-4f09-ae89-xxxxxx",
      "type": "IDENTITY",
      "name": "john.doe@example.com",
      "timeCreated": "2024-09-09T12:09:09.126Z",
      "timeUpdated": "2024-09-09T12:09:09.126Z",
      "isRuleBased": false,
      "entityType": "USER",
      "value": {
        "name": {
          "familyName": "Doe",
          "givenName": "John"
        },
        "userName": "john.doe@example.com",
        "displayName": "John Doe",
        "description": "Software Engineer",
        "primaryEmail": "john.doe@example.com",
        "userType": "Full-Time",
        "organization": {
          "value": "organization.8dxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
          "displayName": "Engineering"
        },
        "manager": {
          "value": "12345",
          "displayName": "Emily Taylor",
          "resourceType": "ACCOUNT"
        },
        "status": "Active",
        "jobCode": "ENG002",
        "state": "NY",
        "risk": 5,
        "location": "US",
        "emails": [
          {
            "value": "john.doe@example.com"
          }
        ],
        "phoneNumbers": [
          {
            "display": "555-000-0001",
            "primary": false,
            "type": "home"
          },
          {
            "display": "555-500-0002",
            "primary": false,
            "type": "mobile"
          }
        ],
        "customAttributes": {
          "Division": "Tech Division",
          "Age": 35,
          "BadgeNumber": "1001",
          "Company": "Example Corp",
          "HRAddress": "123 Business St",
          "AccountDisabled": false,
          "AccountLocked": false,
          "Alias": "john.doe"
        }
      }
    },
    {
      "id": "globalId.ICF.21xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
      "type": "IDENTITY",
      "name": "emma.smith@example.com",
      "timeCreated": "2025-04-01T12:46:58.146Z",
      "timeUpdated": "2025-04-01T12:46:58.146Z",
      "isRuleBased": false,
      "entityType": "USER",
      "value": {
        "name": {
          "familyName": "Smith",
          "givenName": "Emma"
        },
        "userName": "emma.smith@example.com",
        "displayName": "Emma Smith",
        "primaryEmail": "emma.smith@example.com",
        "userType": "Employee",
        "title": "Ms.",
        "employeeNumber": "ES12345",
        "organization": {
          "value": "organization.ICF.21xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
          "displayName": "Human Resources",
          "resourceType": "ORGANIZATION"
        },
        "department": "HR",
        "status": "Disabled",
        "jobCode": "HR456",
        "location": "London",
        "emails": [
          {
            "value": "emma.smith@example.com"
          }
        ],
        "addresses": [
          {
            "country": "UK",
            "postalCode": "E1 6AN",
            "region": "East London"
          }
        ],
        "customAttributes": {
          "Company": "Example Corp",
          "AccountLocked": true,
          "BadgeNumber": "2002",
          "HRAddress": "456 Corporate Blvd"
        }
      }
    }
  ]
}