Oracle Access Governance REST APIs

List resource counts summary of the policy statement

get

/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/policyStatements/{policyStatementId}/resourceCounts

Returns resource counts summary of the policy statement for the policy access review.

Request

Path Parameters

accessReviewId(required): string

Unique access review identifier.
policyStatementId(required): string

Unique policy statement identifier.

Query Parameters

groupBy(required): string

The group by field for policy resources.

Allowed Values: [ "type" ]
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.
sortOrder: string

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

Allowed Values: [ "ASC", "DESC" ]
type: string

The parameter for resource dimension type. The default value is RESOURCE_TYPE.

Default Value: RESOURCE_TYPE

Allowed Values: [ "RESOURCE_TYPE", "COMPARTMENT" ]

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 details of policy statement for given policy.

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

Type: object

List of review aggregations.

Show Source

items(required): array items

List of review aggregations.

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

Nested Schema : items

Type: array

List of review aggregations.

Show Source

Array of: object ResourceAggregationSummary

The aggregation based on the reviews.

{
    "description":"List of review aggregations.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResourceAggregationSummary"
    }
}

Nested Schema : ResourceAggregationSummary

Type: object

The aggregation based on the reviews.

Show Source

count(required): integer

The count of matches for the aggregation.
dimension(required): object ResourceDimension

The dimensions that are being aggregated on.

{
    "type":"object",
    "description":"The aggregation based on the reviews.",
    "required":[
        "dimension",
        "count"
    ],
    "properties":{
        "dimension":{
            "$ref":"#/definitions/ResourceDimension"
        },
        "count":{
            "description":"The count of matches for the aggregation.",
            "type":"integer"
        }
    }
}

Nested Schema : ResourceDimension

Type: object

The dimensions that are being aggregated on.

Show Source

fullValue: string

Value represents the full name of compartment for ResourceDimensionType compartment, for other it will null or same as value.
value(required): string

Value represents the name based on ResourceDimensionType For example - resource_type like computes, databases etc. compartment names like test-compartment etc.

{
    "type":"object",
    "description":"The dimensions that are being aggregated on.",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "description":"Value represents the name based on ResourceDimensionType For example - resource_type like computes, databases etc. compartment names like test-compartment etc."
        },
        "fullValue":{
            "type":"string",
            "description":"Value represents the full name of compartment for ResourceDimensionType compartment, for other it will null or same as value."
        }
    }
}

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 resource count summary for a policy statement in a policy access control review task. Use the Access Control review task id for a policy, policy statement id to retrieve resource count included in the policy.

cURL Example

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/access-reviews/accessReviews/${accessReviewId}/policyStatements/${policyStatementId}/resourceCounts

Example of the Response Body

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

{
  "items": [
    {
      "dimension": {
        "value": "ROUTETABLE",
        "fullValue": null
      },
      "count": 2
    },
    {
      "dimension": {
        "value": "SECURITYLIST",
        "fullValue": null
      },
      "count": 2
    },
    {
      "dimension": {
        "value": "SUBNET",
        "fullValue": null
      },
      "count": 2
    },
    {
      "dimension": {
        "value": "DHCPOPTIONS",
        "fullValue": null
      },
      "count": 1
    },
    {
      "dimension": {
        "value": "INTERNETGATEWAY",
        "fullValue": null
      },
      "count": 1
    },
    {
      "dimension": {
        "value": "NATGATEWAY",
        "fullValue": null
      },
      "count": 1
    },
    {
      "dimension": {
        "value": "PUBLICIP",
        "fullValue": null
      },
      "count": 1
    },
    {
      "dimension": {
        "value": "SERVICEGATEWAY",
        "fullValue": null
      },
      "count": 1
    },
    {
      "dimension": {
        "value": "VCN",
        "fullValue": null
      },
      "count": 1
    }
  ]
}