Oracle Access Governance REST APIs

Get a list of Access Control Access Reviews

get

/access-governance/access-reviews/20250331/accessReviews/accessControl

Returns details of all access control access reviews for a given user with support of pagination.

Request

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

Default Value: assignmentName

Allowed Values: [ "owner", "assignmentName", "recommendation", "daysRemaining", "campaignName" ]
sortOrder: string

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

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

Minimum Length: 1

Maximum Length: 255

Identifier of the user who is performing the operation.

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

A page of ReviewTaskSummary objects.

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.
opc-total-items: integer

The total number of items.

Root Schema : AccessControlAccessReviewSummaryCollection

Type: object

Results of an access control access reviews search.

Show Source

items(required): array items

List of access control access review summaries.

{
    "type":"object",
    "description":"Results of an access control access reviews search.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of access control access review summaries.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccessControlAccessReviewSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of access control access review summaries.

Show Source

Array of: object AccessControlAccessReviewSummary

The summary of access control review task.

{
    "description":"List of access control access review summaries.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AccessControlAccessReviewSummary"
    }
}

Nested Schema : AccessControlAccessReviewSummary

Type: object

The summary of access control review task.

Show Source

assignmentDescription: string

The description of the assignment to be reviewed.
assignmentName(required): string

The name of the assignment for access control review task.
assignmentType(required): string

Allowed Values: [ "ACCOUNT", "PERMISSION", "ROLE", "POLICY", "IC_STRUCTURAL", "UNMATCHED_ACCOUNT", "ORCH_SYSTEM", "AM_WORKFLOW", "ACCESS_GUARDRAIL" ]

The type of the assignment to be reviewed.
campaignId: string

Campaign Id for the review task.
campaignName(required): string

The campaign name of the access control review task.
campaignType(required): string

Allowed Values: [ "ACCESS", "OWNERSHIP" ]

review task belongs to which campaign type (access or ownership).
daysRemaining(required): integer

The days remaining of the access control review task.
id(required): string

The ID of the access control review task.
isReassignable: boolean

Flag indicating whether the review task can be reassigned or not.
owner: string

The owner name of the access control review task.
recommendation(required): string

Allowed Values: [ "ACCEPT", "REVIEW" ]

The recommendation of the access control review task.
templateType: string

Allowed Values: [ "IDENTITY", "AG_IDENTITY", "EVENT", "AG_EVENT", "CLOUD_PROVIDER", "POLICY", "IC_STRUCTURAL", "AG_POLICY", "GOVERNANCE_SYSTEM", "AG", "GOVERNANCE_SYSTEM_EVENT", "CLOUD_PROVIDER_EVENT" ]

The template type of the campaign.

{
    "type":"object",
    "description":"The summary of access control review task.",
    "required":[
        "id",
        "assignmentName",
        "assignmentType",
        "recommendation",
        "campaignName",
        "campaignType",
        "daysRemaining"
    ],
    "properties":{
        "id":{
            "description":"The ID of the access control review task.",
            "type":"string"
        },
        "campaignId":{
            "description":"Campaign Id for the review task.",
            "type":"string"
        },
        "assignmentName":{
            "description":"The name of the assignment for access control review task.",
            "type":"string"
        },
        "assignmentDescription":{
            "description":"The description of the assignment to be reviewed.",
            "type":"string"
        },
        "assignmentType":{
            "description":"The type of the assignment to be reviewed.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/AssignmentType",
            "enum":[
                "ACCOUNT",
                "PERMISSION",
                "ROLE",
                "POLICY",
                "IC_STRUCTURAL",
                "UNMATCHED_ACCOUNT",
                "ORCH_SYSTEM",
                "AM_WORKFLOW",
                "ACCESS_GUARDRAIL"
            ]
        },
        "owner":{
            "description":"The owner name of the access control review task.",
            "type":"string"
        },
        "recommendation":{
            "description":"The recommendation of the access control review task.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/Recommendation",
            "enum":[
                "ACCEPT",
                "REVIEW"
            ]
        },
        "campaignName":{
            "description":"The campaign name of the access control review task.",
            "type":"string"
        },
        "daysRemaining":{
            "description":"The days remaining of the access control review task.",
            "type":"integer"
        },
        "templateType":{
            "description":"The template type of the campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/TemplateType",
            "enum":[
                "IDENTITY",
                "AG_IDENTITY",
                "EVENT",
                "AG_EVENT",
                "CLOUD_PROVIDER",
                "POLICY",
                "IC_STRUCTURAL",
                "AG_POLICY",
                "GOVERNANCE_SYSTEM",
                "AG",
                "GOVERNANCE_SYSTEM_EVENT",
                "CLOUD_PROVIDER_EVENT"
            ]
        },
        "campaignType":{
            "description":"review task belongs to which campaign type (access or ownership).",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignType",
            "enum":[
                "ACCESS",
                "OWNERSHIP"
            ]
        },
        "isReassignable":{
            "description":"Flag indicating whether the review task can be reassigned or not.",
            "type":"boolean"
        }
    }
}

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 a list of all the Access Control reviews for an identity. The userId query parameter is mandatory while retrieving a list.

cURL Example - With Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://${service-instance}/access-governance/access-reviews/${version}/accessReviews/accessControl?userId=${userId}'

Example of the Response Body

The following example shows the contents of the response body in JSON format, including a list of In Progress Campaigns:

{
    "items": [
        {
            "id": "ocid1.agcsreviewtask.oc1.iad.amaaaaaaebkbezqaaviu73xxxxxg7owxbz2iijxxxxxjaucd2yrxxxxxewia",
            "campaignId": "ocid1.agcscampaign.oc1.iad.amaaaaaaebkbezqack7shxxxxxjbv4y2je67xxxxxaeipcr33xxxxxupa",
            "assignmentName": "Finance Team Access Group Membership Review",
            "assignmentDescription": "Review group membership of Finance Team for Payroll",
            "assignmentType": "IC_STRUCTURAL",
            "owner": "John Doe",
            "recommendation": "ACCEPT",
            "campaignName": "Finance Group Membership Review - Apr 2025",
            "daysRemaining": 3582,
            "templateType": "AG",
            "campaignType": "ACCESS",
            "isReassignable": false
        },
        {
            "id": "ocid1.agcsreviewtask.oc1.iad.amaaaaaaebkbezqac6b34lxxxxxotefv4qpf75xxxxxah3724lyxxxxxw7ra",
            "campaignId": "ocid1.agcscampaign.oc1.iad.amaaaaaaebkbezqamftsexxxxx7nsm2coxljxxxxxbiswto5axxxxxq2a",
            "assignmentName": "HR Group Review",
            "assignmentDescription": "Evaluate group membership of HR Team for Operations",
            "assignmentType": "IC_STRUCTURAL",
            "owner": "Jane Smith",
            "recommendation": "REVIEW",
            "campaignName": "HR Group Membership Review - Apr 2025",
            "daysRemaining": 3593,
            "templateType": "CLOUD_PROVIDER",
            "campaignType": "ACCESS",
            "isReassignable": false
        }
    ]
}