Oracle Access Governance REST APIs

Get list of identities for an Ownership or Identity collection access review based on ConditionType param

get

/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/identities

Returns list of identities for an Ownership or Identity collection access review.

Request

Path Parameters

accessReviewId(required): string

Unique access review identifier.

Query Parameters

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. The default value will be entityName.

Default Value: entityName

Allowed Values: [ "entityName", "assignmentName", "managerName", "recommendation", "daysRemaining", "campaignName", "appNames" ]
sortOrder: string

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

Allowed Values: [ "ASC", "DESC" ]
type(required): string

The type of member identity.

Allowed Values: [ "EXCLUDED", "INCLUDED", "NON_REVIEWABLE" ]

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 access review included identities.

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

Type: object

List of identities.

Show Source

items(required): array items

List of identities.

{
    "type":"object",
    "description":"List of identities.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of identities.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdentitySummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of identities.

Show Source

Array of: object IdentitySummary

Identity Summary.

{
    "description":"List of identities.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/IdentitySummary"
    }
}

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.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information."
        },
        "userLogin":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "email":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "manager":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "organization":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "isRuleBased":{
            "type":"boolean",
            "description":"(optional parameter) Is this identity ruled based."
        },
        "jobCode":{
            "type":"string",
            "description":"The jobCode of the identity."
        },
        "location":{
            "type":"string",
            "description":"The location of the identitiy."
        },
        "employeeType":{
            "type":"string",
            "description":"The employeeType of the identitiy."
        },
        "agOrganizations":{
            "type":"array",
            "description":"The AGOrganizations of which the identity is part of.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Identity Summary."
}

Nested Schema : agOrganizations

Type: array

The AGOrganizations of which the identity is part of.

Show Source

Array of: string

{
    "type":"array",
    "description":"The AGOrganizations of which the identity is part of.",
    "items":{
        "type":"string"
    }
}

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 identity list for an Ownership review or an Identity Collection access control review task. You must include type query parameter.

cURL Example - Included Owners in Ownership Review task

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/access-reviews/accessReviews/${accessReviewId}/identities?type=INCLUDED

Example of the Response Body

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

{
    "items": [
        {
            "id": "globalId.8d51efbf-ab68-4f09-xxxx-7bcc0f9de5be.18.a84836xxxxx02afd63a7fb",
            "name": "Amel Maclead",
            "email": "amelclead@example.com",
            "manager": John Smith,
            "org": null,
            "employeeType": null,
            "jobCode": null,
            "location": null,
            "userName": null,
            "ownerType": "PRIMARY",
            "agOrganizations": [
            ]
        }
    ]
}