1. Oracle Access Governance REST APIs
  2. Tasks
  3. Policies

Update a Policy

put

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

Updates the details of an existing policy with a given ID.

Request

Path Parameters
Header Parameters
  • The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Body ()
Details for the updated Policy.
Root Schema : UpdatePolicyDetails
Type: object
The information to be updated
Show Source
Nested Schema : assignments
Type: array
List of assignments associated with Policy.
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the Policy
Show Source
Nested Schema : owners
Type: array
List of owner entities
Show Source
Nested Schema : tags
Type: array
List of tags attached to the Policy.
Show Source
Nested Schema : PolicyAssignment
Type: object
PolicyAssignment Model.
Show Source
Nested Schema : accessBundles
Type: array
List of access bundles
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the permission association
Show Source
Nested Schema : identityGroups
Type: array
List of identity groups
Show Source
Nested Schema : roles
Type: array
List of roles
Show Source
Nested Schema : Info
Type: object
Generic information object.
Show Source
Nested Schema : OwnerSummary
Type: object
Owner entity object
Show Source
Back to Top

Response

Supported Media Types

200 Response

The updated Policy
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Policy
Type: object
Policy model.
Show Source
Nested Schema : assignments
Type: array
List of assignments associated with Permission Association.
Show Source
Nested Schema : IdInfo
Type: object
Generic identifying information object.
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the permission association
Show Source
Nested Schema : owners
Type: array
List of owner entities
Show Source
Nested Schema : tags
Type: array
List of tags attached to the Permission Association.
Show Source
Nested Schema : PolicyAssignment
Type: object
PolicyAssignment Model.
Show Source
Nested Schema : accessBundles
Type: array
List of access bundles
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the permission association
Show Source
Nested Schema : identityGroups
Type: array
List of identity groups
Show Source
Nested Schema : roles
Type: array
List of roles
Show Source
Nested Schema : Info
Type: object
Generic information object.
Show Source
Nested Schema : OwnerSummary
Type: object
Owner entity object
Show Source

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

Default Response

Unknown Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source
Back to Top

Examples

The following example shows how to update a policy by submitting a PUT request. In this example, as an extension to create example, we will keep one identity collection in the policy.

cURL Example - Without Query Parameters

curl -i -L -X PUT \
   -H "Authorization:Bearer <your-access-token>" \
   -H "Content-Type:application/json" \
   -d \
'{
  "name": "Admin DBUM Policy Update",
  "description": "Admin DBUM Policy Update",
  "submittedBy": "globalId.125123c3-xxx-4d6a-b6d4-xxx.18.xxx",
  "tags": [
    "DBUM UA Policy Update"
  ],
  "customAttributes": {},
  "displayName": "Admin Database Policy Update",
  "assignments": [
    {
      "assignmentId": "",
      "assignmentType": "ACCESS_BUNDLE",
      "identityType": "ALL",
      "identityCollections": [
        {
          "id": "a4b3dd4b-xxx-4d77-858c-xxx",
          "name": "Database Administrators"
        }
      ],
      "accessBundles": [
        {
          "id": "52fea7fb-xxx-4b1e-bc37-xxx",
          "name": "SQL Tuning Access"
        },
        {
          "id": "45ed5c4c-xxx-4e80-ba1c-xxx",
          "name": "DBUM Standard SQL Tuning Access UA2"
        },
        {
          "id": "xxx-xxx-xxx-xxx-xxx",
          "name": "Oracle DBUM Performance Admin Access"
        }
      ]
    }
  ],
  "owners": [
    {
      "id": "globalId.125123c3-xxx-4d6a-b6d4-xxx.18.xxx",
      "name": "Amel Maclead",
      "isPrimary": true
    }
  ]
}' \
 '<${service-instance-url}/access-governance/access-controls/20250331/policies/${policyID}>'

Submit the PUT request

${service-instance-url}/access-governance/access-controls/${version}/policies/${policyID}

Example Request Payload

{
  "name": "Admin DBUM Policy Update",
  "description": "Admin DBUM Policy Update",
  "submittedBy": "globalId.125123c3-xxx-4d6a-b6d4-xxx.18.xxx",
  "tags": [
    "DBUM UA Policy Update"
  ],
  "customAttributes": {},
  "displayName": "Admin Database Policy Update",
  "assignments": [
    {
      "assignmentId": "",
      "assignmentType": "ACCESS_BUNDLE",
      "identityType": "ALL",
      "identityCollections": [
        {
          "id": "a4b3dd4b-xxx-4d77-858c-xxx",
          "name": "Database Administrators"
        }
      ],
      "accessBundles": [
        {
          "id": "52fea7fb-xxx-4b1e-bc37-xxx",
          "name": "SQL Tuning Access"
        },
        {
          "id": "45ed5c4c-xxx-4e80-ba1c-xxx",
          "name": "DBUM Standard SQL Tuning Access UA2"
        },
        {
          "id": "xxx-xxx-xxx-xxx-xxx",
          "name": "Oracle DBUM Performance Admin Access"
        }
      ]
    }
  ],
  "owners": [
    {
      "id": "globalId.125123c3-xxx-4d6a-b6d4-xxx.18.xxx",
      "name": "Amel Maclead",
      "isPrimary": true
    }
  ]
}

Example of the Response Body

The following example shows the contents of the response body in JSON format, including the details of an identity who updated the policy:

{
    "id": "2e451b51-xxx-4bbc-9894-xxx",
    "name": "Admin DBUM Policy Update",
    "description": "Admin DBUM Policy Update",
    "status": "ACTIVE",
    "timeCreated": "2025-05-07T15:44:50.209Z",
    "timeUpdated": "2025-05-07T15:47:43.301Z",
    "ownershipCollectionId": "03b05e0d-xxx-4f7e-a101-xxx",
    "owners": [
        {
            "id": "globalId.125123c3-xxx-4d6a-b6d4-xxx.18.xxx",
            "name": "Amel Maclead",
            "isPrimary": true
        }
    ],
    "createdBy": {
        "id": "globalId.125123c3-xxx-4d6a-b6d4-xxx.18.xxx",
        "name": "Amel Maclead",
        "displayName": "Amel Maclead"
    },
    "updatedBy": {
        "id": "globalId.125123c3-xxx-4d6a-b6d4-xxx.18.xxx",
        "name": "Amel Maclead",
        "displayName": "Amel Maclead"
    },
    "tags": [
        "DBUM UA Policy Update"
    ],
    "customAttributes": {},
    "displayName": "Admin Database Policy Update",
    "assignments": [
        {
            "assignmentId": "54831c9d-xxx-459a-b209-xxx",
            "assignmentType": "ACCESS_BUNDLE",
            "identityType": "HUMAN",
            "identityCollections": [
                {
                    "id": "a4b3dd4b-xxx-4d77-858c-xxx",
                    "name": "Database Administrators"
                }
            ],
            "accessBundles": [
                {
                    "id": "45ed5c4c-xxx-4e80-ba1c-xxx",
                    "name": "DBUM Standard SQL Tuning Access UA2",
                    "displayName": "DBUM Standard SQL Tuning Access UA2",
                    "owners": null
                },
                {
                    "id": "52fea7fb-xxx-4b1e-bc37-xxx",
                    "name": "SQL Tuning Access"
                },
                {
                    "id": "xxx-xxx-xxx-xxx-xxx",
                    "name": "Oracle DBUM Performance Admin Access"
                }
            ],
            "roles": [],
            "customAttributes": null
        }
    ],
    "riskLevel": null
}
Back to Top