Jump to

• Request
• Response
• Examples

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

  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", "identityAttributes" ]
• 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.

Back to Top

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.

Body ()

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
  The Identity summary.

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

Nested Schema : IdentitySummary

Type: object

The Identity summary.

Show Source

• agOrganizations: array agOrganizations
  The ag orgs of the Identity.
• email(required): string
  The email of the Identity.
• employeeType: string
  The employee type of the Identity.
• id(required): string
  The ID of the Identity.
• jobCode: string
  The job code of the Identity.
• location: string
  The location of the Identity.
• manager: string
  The manager of the Identity.
• name(required): string
  The name of the Identity.
• org: string
  The org of the Identity.
• ownerType: string
  Allowed Values: [ "ASSOCIATION", "CONDITION", "EXCLUDED", "INCLUDED", "PRIMARY", "NON_REVIEWABLE" ]

  ChildType indicating the type of owner (PRIMARY for primary owner or INCLUDED for secondary owner).
• userName: string
  The user name of the Identity.

{
    "type":"object",
    "description":"The Identity summary.",
    "required":[
        "id",
        "name",
        "email"
    ],
    "properties":{
        "id":{
            "description":"The ID of the Identity.",
            "type":"string"
        },
        "name":{
            "description":"The name of the Identity.",
            "type":"string"
        },
        "email":{
            "description":"The email of the Identity.",
            "type":"string"
        },
        "manager":{
            "description":"The manager of the Identity.",
            "type":"string"
        },
        "org":{
            "description":"The org of the Identity.",
            "type":"string"
        },
        "employeeType":{
            "description":"The employee type of the Identity.",
            "type":"string"
        },
        "jobCode":{
            "description":"The job code of the Identity.",
            "type":"string"
        },
        "location":{
            "description":"The location of the Identity.",
            "type":"string"
        },
        "userName":{
            "description":"The user name of the Identity.",
            "type":"string"
        },
        "ownerType":{
            "type":"string",
            "description":"ChildType indicating the type of owner (PRIMARY for primary owner or INCLUDED for secondary owner).",
            "x-obmcs-top-level-enum":"#/definitions/ChildType",
            "enum":[
                "ASSOCIATION",
                "CONDITION",
                "EXCLUDED",
                "INCLUDED",
                "PRIMARY",
                "NON_REVIEWABLE"
            ]
        },
        "agOrganizations":{
            "description":"The ag orgs of the Identity.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AgOrgSummary"
            }
        }
    }
}

Nested Schema : agOrganizations

Type: array

The ag orgs of the Identity.

Show Source

• Array of: object AgOrgSummary
  Ag Org summary.

{
    "description":"The ag orgs of the Identity.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AgOrgSummary"
    }
}

Nested Schema : AgOrgSummary

Type: object

Ag Org summary.

Show Source

• displayName(required): string
  The name of the Ag org.
• value(required): string
  The Id of the Ag org.

{
    "type":"object",
    "description":"Ag Org summary.",
    "required":[
        "value",
        "displayName"
    ],
    "properties":{
        "value":{
            "description":"The Id of the Ag org.",
            "type":"string"
        },
        "displayName":{
            "description":"The name of the Ag org.",
            "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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top

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": "[e-mail]",
            "manager": John Smith,
            "org": null,
            "employeeType": null,
            "jobCode": null,
            "location": null,
            "userName": null,
            "ownerType": "PRIMARY",
            "agOrganizations": [
            ]
        }
    ]
}

Back to Top