Oracle Access Governance REST APIs

Get the overview report for the given campaign

get

/access-governance/access-reviews/20250331/campaigns/{campaignId}/overviewReport

Retrieve the overview report for the given campaign.

Request

Path Parameters

campaignId(required): string

Unique Campaign identifier.

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 overview report for the given campaign.

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

Type: object

The overview report of the review task status.

Show Source

assignmentTypeTotals(required): array assignmentTypeTotals

The totals related to each assignment type.
autoActionedCount: integer

The count of tasks that were auto actioned.
groupTotals(required): array groupTotals

The totals related to each group criteria.
timeGenerated(required): string(date-time)

The date that the overview report was generated.
totalCount: integer

The total count of all access review tasks.

{
    "type":"object",
    "description":"The overview report of the review task status.",
    "required":[
        "timeGenerated",
        "assignmentTypeTotals",
        "groupTotals"
    ],
    "properties":{
        "timeGenerated":{
            "description":"The date that the overview report was generated.",
            "type":"string",
            "format":"date-time"
        },
        "assignmentTypeTotals":{
            "description":"The totals related to each assignment type.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AssignmentTypeTally"
            }
        },
        "groupTotals":{
            "description":"The totals related to each group criteria.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupTally"
            }
        },
        "autoActionedCount":{
            "description":"The count of tasks that were auto actioned.",
            "type":"integer"
        },
        "totalCount":{
            "description":"The total count of all access review tasks.",
            "type":"integer"
        }
    }
}

Nested Schema : assignmentTypeTotals

Type: array

The totals related to each assignment type.

Show Source

Array of: object AssignmentTypeTally

The tally counts of the assignment type.

{
    "description":"The totals related to each assignment type.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AssignmentTypeTally"
    }
}

Nested Schema : groupTotals

Type: array

The totals related to each group criteria.

Show Source

Array of: object GroupTally

The tally counts of the group.

{
    "description":"The totals related to each group criteria.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupTally"
    }
}

Nested Schema : AssignmentTypeTally

Type: object

The tally counts of the assignment type.

Show Source

approvedCount(required): integer

The count of the approved reviews.
assignedCount: integer

The count of the assigned reviews.
modifiedCount: integer

The count of the modified reviews.
pendingCount(required): integer

The count of the pending reviews.
removedCount: integer

The count of the removed reviews.
revokedCount(required): integer

The count of the revoked reviews.
type(required): string

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

The type of the assignment.

{
    "type":"object",
    "description":"The tally counts of the assignment type.",
    "required":[
        "type",
        "pendingCount",
        "approvedCount",
        "revokedCount"
    ],
    "properties":{
        "type":{
            "description":"The type of the assignment.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/AssignmentType",
            "enum":[
                "ACCOUNT",
                "PERMISSION",
                "ROLE",
                "POLICY",
                "IC_STRUCTURAL",
                "UNMATCHED_ACCOUNT",
                "ORCH_SYSTEM",
                "AM_WORKFLOW",
                "ACCESS_GUARDRAIL"
            ]
        },
        "pendingCount":{
            "description":"The count of the pending reviews.",
            "type":"integer"
        },
        "approvedCount":{
            "description":"The count of the approved reviews.",
            "type":"integer"
        },
        "revokedCount":{
            "description":"The count of the revoked reviews.",
            "type":"integer"
        },
        "modifiedCount":{
            "description":"The count of the modified reviews.",
            "type":"integer"
        },
        "assignedCount":{
            "description":"The count of the assigned reviews.",
            "type":"integer"
        },
        "removedCount":{
            "description":"The count of the removed reviews.",
            "type":"integer"
        }
    }
}

Nested Schema : GroupTally

Type: object

The tally counts of the group.

Show Source

topGroups(required): array topGroups

The list of the top 5 values in this group.
type(required): string

Allowed Values: [ "ORGANIZATION", "RESOURCE", "ROLE", "CLOUD_ACCOUNT", "POLICY_CREATED_SINCE", "IC_CREATED_SINCE", "UA_TARGET", "UA_INSIGHTS", "AG_ORGANIZATION" ]

The type of the group.

{
    "type":"object",
    "description":"The tally counts of the group.",
    "required":[
        "type",
        "topGroups"
    ],
    "properties":{
        "type":{
            "description":"The type of the group.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/GroupType",
            "enum":[
                "ORGANIZATION",
                "RESOURCE",
                "ROLE",
                "CLOUD_ACCOUNT",
                "POLICY_CREATED_SINCE",
                "IC_CREATED_SINCE",
                "UA_TARGET",
                "UA_INSIGHTS",
                "AG_ORGANIZATION"
            ]
        },
        "topGroups":{
            "description":"The list of the top 5 values in this group.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TopGroupTally"
            }
        }
    }
}

Nested Schema : topGroups

Type: array

The list of the top 5 values in this group.

Show Source

Array of: object TopGroupTally

The tally counts of the top value in the group

{
    "description":"The list of the top 5 values in this group.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TopGroupTally"
    }
}

Nested Schema : TopGroupTally

Type: object

The tally counts of the top value in the group

Show Source

name(required): string

The name of the top group value
value(required): integer

The count or frequency of the group

{
    "type":"object",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the top group value"
        },
        "value":{
            "type":"integer",
            "description":"The count or frequency of the group"
        }
    },
    "description":"The tally counts of the top value in the group"
}

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 Campaigns Report. Replace placeholder values with actual values before running the sample command.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/access-reviews/${version}/campaigns/${campaignId}/overviewReport'

Example of the Response Body

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

This response outlines the status of different assignment types in an access review process, including accounts, permissions, roles, and workflows. It provides a summary of pending, approved, and revoked counts to track access changes.

{
    "timeGenerated": "2025-06-02T06:55:06.644Z",
    "assignmentTypeTotals": [
        {
            "type": "ACCOUNT",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "PERMISSION",
            "pendingCount": 1,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "ROLE",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "SYSTEM_ACCESS",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "WORKFLOW_APPROVAL",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "ACCESS_POLICY",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        }
    ],
    "groupTotals": [
        {
            "type": "RESOURCE",
            "topGroups": [
                {
                    "name": "Database Access Review - July",
                    "pendingCount": 1,
                    "approvedCount": 0,
                    "revokedCount": 0,
                    "modifiedCount": 0
                }
            ]
        },
        {
            "type": "DEPARTMENT",
            "topGroups": [
                {
                    "name": "Software Engineering Team",
                    "pendingCount": 1,
                    "approvedCount": 0,
                    "revokedCount": 0,
                    "modifiedCount": 0
                }
            ]
        },
        {
            "type": "ORGANIZATION",
            "topGroups": [
                {
                    "name": "IT Governance Committee",
                    "pendingCount": 1,
                    "approvedCount": 0,
                    "revokedCount": 0,
                    "modifiedCount": 0
                }
            ]
        }
    ]
}