Oracle Access Governance REST APIs

Get a list of Policies

get

/access-governance/access-controls/20250331/policies

Returns details of all available policies with support for pagination.

Request

Query Parameters

keywordContains: string

Keyword to filter on. Only one keyword may be provided. Default is empty string.
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. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Default Value: timeCreated

Allowed Values: [ "timeCreated", "displayName" ]
sortOrder: string

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

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

A filter to be used for finding entities with the given status.

Default Value: ALL

Allowed Values: [ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ]

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 list of Policy Summaries

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

Type: object

PolicyCollection contains summarized information about Policies.

Show Source

items(required): array items

List containing summarized information about Policies.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List containing summarized information about Policies.",
            "items":{
                "$ref":"#/definitions/PolicySummary"
            }
        }
    },
    "description":"PolicyCollection contains summarized information about Policies."
}

Nested Schema : items

Type: array

List containing summarized information about Policies.

Show Source

Array of: object PolicySummary

Policy Summary.

{
    "type":"array",
    "description":"List containing summarized information about Policies.",
    "items":{
        "$ref":"#/definitions/PolicySummary"
    }
}

Nested Schema : PolicySummary

Type: object

Policy Summary.

Show Source

createdBy: object IdInfo

Generic identifying information object.
customAttributes: object customAttributes

Metadata associated with the access bundle
description: string

Description of the Policy.
id(required): string

The Unique Oracle ID (OCID) that is immutable on creation.
isOwner: boolean

Boolean value checking if logged-in user is owner of this resource or not.
name: string

A user-friendly name. Have to be unique. Avoid entering confidential information.
primaryOwner: object PrimaryOwner

Details of a primary Owner.
status: string

Allowed Values: [ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]

Status of the Policy
tags: array tags

List of tags attached to the Policy.
timeCreated: string(date-time)

Time when the Policy was created. An RFC3339 formatted datetime string
timeUpdated: string(date-time)

Time when the Policy was last updated. An RFC3339 formatted datetime string

{
    "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. Have to be unique. Avoid entering confidential information."
        },
        "description":{
            "type":"string",
            "description":"Description of the Policy."
        },
        "createdBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Policy was created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Policy was last updated. An RFC3339 formatted datetime string"
        },
        "status":{
            "type":"string",
            "description":"Status of the Policy",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityStatus",
            "x-default-description":"ACTIVE"
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Policy.",
            "items":{
                "type":"string"
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the access bundle",
            "properties":{
            }
        },
        "primaryOwner":{
            "$ref":"#/definitions/PrimaryOwner"
        },
        "isOwner":{
            "type":"boolean",
            "description":"Boolean value checking if logged-in user is owner of this resource or not."
        }
    },
    "description":"Policy Summary."
}

Nested Schema : IdInfo

Type: object

Generic identifying information object.

Show Source

displayName: string

Display Name of the entity.
id: string

Id of the entity.
name: string

Name of the entity.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic identifying information object."
}

Nested Schema : customAttributes

Type: object

Metadata associated with the access bundle

Show Source

{
    "type":"object",
    "description":"Metadata associated with the access bundle",
    "properties":{
    }
}

Nested Schema : PrimaryOwner

Type: object

Details of a primary Owner.

Show Source

displayName: string

Display name of the primary Owner.
value: string

Id of the primary Owner.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Id of the primary Owner."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the primary Owner."
        }
    },
    "description":"Details of a primary Owner."
}

Nested Schema : tags

Type: array

List of tags attached to the Policy.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Policy.",
    "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 a list of policies by submitting a GET request.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://${service-instance-url}/access-governance/access-controls/20250331/policies'

Example of the Response Body

The following example shows the contents of the response body in JSON format, including a list of all available roles:

{
    "items": [
        {
            "id": "958b9x2a-0993-4x16-8ff2-d4730307c1c0",
            "name": "Database Administration Policy",
            "description": "Defines administrative privileges for database management, including configuration settings, user management, and system maintenance.",
            "createdBy": {
                "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                "name": "Amel MacLead",
                "displayName": "Amel MacLead"
            },
            "timeCreated": "2025-04-10T20:58:00.273Z",
            "timeUpdated": "2025-04-10T20:58:00.273Z",
            "status": "ACTIVE",
            "tags": null,
            "customAttributes": null,
            "primaryOwner": {
                "value": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                "displayName": "Amel MacLead"
            },
            "isOwner": false
        },
        {
            "id": "e158axd3-8575-4xff-892f-a293aa3c3d69",
            "name": "Database Auditing Policy",
            "description": "Establishes guidelines for auditing database activity, tracking user interactions, privilege changes, and compliance monitoring.",
            "createdBy": {
                "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                "name": "Amel MacLead",
                "displayName": "Amel MacLead"
            },
            "timeCreated": "2024-08-05T10:36:24.472Z",
            "timeUpdated": "2025-04-06T09:01:57.908Z",
            "status": "ACTIVE",
            "tags": null,
            "customAttributes": null,
            "primaryOwner": {
                "value": null,
                "displayName": null
            },
            "isOwner": null
        }
    ]
}
}