Oracle Access Governance REST APIs

Get Policy

get

/access-governance/access-controls/20250331/policies/{policyId}

Returns details of a policy with a given ID.

Request

Path Parameters

policyId(required): string

Unique Policy 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 Policy for the given id

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

Type: object

Policy model.

Show Source

assignments: array assignments

List of assignments associated with Permission Association.
createdBy: object IdInfo

Generic identifying information object.
customAttributes: object customAttributes

Metadata associated with the permission association
description: string

Description of the Permission Association.
displayName: string

displayName of the Permission Association
id(required): string

The Unique Oracle ID (OCID) that is immutable on creation.
name: string

A user-friendly name. Have to be unique, and it's changeable. Avoid entering confidential information.
owners: array owners

List of owner entities
ownershipCollectionId: string

Ownership collection associate with the Identity Group
riskLevel: integer

Risk Level of Policy. 0 stands for low and 1 for high risk.
status: string

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

Status of the Permission Association.
tags: array tags

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

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

Time when the Permission Association Rule was last updated. An RFC3339 formatted datetime string
updatedBy: object IdInfo

Generic identifying information object.

{
    "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, and it's changeable. Avoid entering confidential information."
        },
        "description":{
            "type":"string",
            "description":"Description of the Permission Association."
        },
        "status":{
            "type":"string",
            "description":"Status of the Permission Association.",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityStatus",
            "x-default-description":"ACTIVE"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Permission Association Rule was created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Permission Association Rule was last updated. An RFC3339 formatted datetime string"
        },
        "ownershipCollectionId":{
            "type":"string",
            "description":"Ownership collection associate with the Identity Group"
        },
        "owners":{
            "type":"array",
            "description":"List of owner entities",
            "items":{
                "$ref":"#/definitions/OwnerSummary"
            }
        },
        "createdBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "updatedBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Permission Association.",
            "items":{
                "type":"string"
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the permission association",
            "properties":{
            }
        },
        "displayName":{
            "type":"string",
            "description":"displayName of the Permission Association"
        },
        "assignments":{
            "type":"array",
            "description":"List of assignments associated with Permission Association.",
            "items":{
                "$ref":"#/definitions/PolicyAssignment"
            }
        },
        "riskLevel":{
            "type":"integer",
            "description":"Risk Level of Policy. 0 stands for low and 1 for high risk."
        }
    },
    "description":"Policy model."
}

Nested Schema : assignments

Type: array

List of assignments associated with Permission Association.

Show Source

Array of: object PolicyAssignment

PolicyAssignment Model.

{
    "type":"array",
    "description":"List of assignments associated with Permission Association.",
    "items":{
        "$ref":"#/definitions/PolicyAssignment"
    }
}

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 permission association

Show Source

{
    "type":"object",
    "description":"Metadata associated with the permission association",
    "properties":{
    }
}

Nested Schema : owners

Type: array

List of owner entities

Show Source

Array of: object OwnerSummary

Owner entity object

{
    "type":"array",
    "description":"List of owner entities",
    "items":{
        "$ref":"#/definitions/OwnerSummary"
    }
}

Nested Schema : tags

Type: array

List of tags attached to the Permission Association.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Permission Association.",
    "items":{
        "type":"string"
    }
}

Nested Schema : PolicyAssignment

Type: object

PolicyAssignment Model.

Show Source

accessBundles: array accessBundles

List of access bundles
assignmentId: string

Assignment Id used for permission Association..
assignmentType: string

Allowed Values: [ "ACCESS_BUNDLE", "ROLE" ]

Type of the assignment that is being requested.
customAttributes: object customAttributes

Metadata associated with the permission association
identityGroups: array identityGroups

List of identity groups
identityType: string

Type of the identity
roles: array roles

List of roles

{
    "type":"object",
    "properties":{
        "assignmentId":{
            "type":"string",
            "description":"Assignment Id used for permission Association.."
        },
        "assignmentType":{
            "type":"string",
            "description":"Type of the assignment that is being requested.",
            "enum":[
                "ACCESS_BUNDLE",
                "ROLE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/PolicyAssignmentType"
        },
        "identityType":{
            "type":"string",
            "description":"Type of the identity"
        },
        "identityGroups":{
            "type":"array",
            "description":"List of identity groups",
            "items":{
                "$ref":"#/definitions/Info"
            }
        },
        "accessBundles":{
            "type":"array",
            "description":"List of access bundles",
            "items":{
                "$ref":"#/definitions/Info"
            }
        },
        "roles":{
            "type":"array",
            "description":"List of roles",
            "items":{
                "$ref":"#/definitions/Info"
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the permission association",
            "properties":{
            }
        }
    },
    "description":"PolicyAssignment Model."
}

Nested Schema : accessBundles

Type: array

List of access bundles

Show Source

Array of: object Info

Generic information object.

{
    "type":"array",
    "description":"List of access bundles",
    "items":{
        "$ref":"#/definitions/Info"
    }
}

Nested Schema : customAttributes

Type: object

Metadata associated with the permission association

Show Source

{
    "type":"object",
    "description":"Metadata associated with the permission association",
    "properties":{
    }
}

Nested Schema : identityGroups

Type: array

List of identity groups

Show Source

Array of: object Info

Generic information object.

{
    "type":"array",
    "description":"List of identity groups",
    "items":{
        "$ref":"#/definitions/Info"
    }
}

Nested Schema : roles

Type: array

List of roles

Show Source

Array of: object Info

Generic information object.

{
    "type":"array",
    "description":"List of roles",
    "items":{
        "$ref":"#/definitions/Info"
    }
}

Nested Schema : Info

Type: object

Generic 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 information object."
}

Nested Schema : OwnerSummary

Type: object

Owner entity object

Show Source

id(required): string

Unique identifier that is immutable on creation
isPrimary(required): boolean

Is this entity the primary owner?
name(required): string

Name of the owner

{
    "type":"object",
    "required":[
        "id",
        "isPrimary",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation"
        },
        "name":{
            "type":"string",
            "description":"Name of the owner"
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Is this entity the primary owner?"
        }
    },
    "description":"Owner entity object"
}

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 details of a specific policy. Replace placeholder values with the actual values.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<host>/access-governance/access-controls/20250331/policy/${policyId}'

Example of the Response Body

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

{
    "id": "958b9x2a-0993-4x16-8ff2-d4730307c1c0",
    "name": "Database Admin Policy",
    "description": "Defines administrative privileges for managing database systems, including schema, object management, and maintenance operations.",
    "status": "ACTIVE",
    "timeCreated": "2025-04-10T20:58:00.273Z",
    "timeUpdated": "2025-04-10T20:58:00.273Z",
    "ownershipCollectionId": null,
    "owners": [
        {
            "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
            "name": "Amel MacLead",
            "isPrimary": true
        }
    ],
    "createdBy": {
        "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
        "name": "Amel MacLead",
        "displayName": "Amel MacLead"
    },
    "updatedBy": {
        "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
        "name": "Amel MacLead",
        "displayName": "Amel MacLead"
    },
    "tags": null,
    "customAttributes": null,
    "displayName": "Database Admin Policy",
    "assignments": [
        {
            "assignmentId": "222075f6-xxx-4c0e-b42c-47dbbaf0546d",
            "assignmentType": "ACCESS_BUNDLE",
            "identityType": "HUMAN",
            "identityGroups": [
                {
                    "id": "a4b3dd4b-xxx-4d77-858c-383a9c809f35",
                    "name": "Database Admin Group",
                    "displayName": "Database Admin Group",
                    "owners": [
                        {
                            "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                            "name": "Amel MacLead",
                            "isPrimary": true
                        }
                    ]
                }
            ],
            "accessBundles": [
                {
                    "id": "feb5f02e-324a-4fb8-a9b6-a6da93139387",
                    "name": "DB-Admin-operations-0404b",
                    "displayName": "DB-Admin-operations-0404b",
                    "owners": [
                        {
                            "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                            "name": "Amel MacLead",
                            "isPrimary": true
                        }
                    ]
                },
                {
                    "id": "fdae3a05-8004-4f7d-98f7-a82f749c8de0",
                    "name": "Database Schema Management",
                    "displayName": "Database Schema Management",
                    "owners": [
                        {
                            "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                            "name": "Amel MacLead",
                            "isPrimary": true
                        }
                    ]
                },
                {
                    "id": "402da86b-87b7-4792-9121-dc10516f119b",
                    "name": "Database Object Management",
                    "displayName": "Database Object Management",
                    "owners": [
                        {
                            "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                            "name": "Amel MacLead",
                            "isPrimary": true
                        }
                    ]
                }
            ],
            "roles": [],
            "customAttributes": null
        }
    ],
    "riskLevel": null
}