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

Update an Access Bundle

put

/access-governance/access-controls/20250331/accessBundles/{accessBundleId}

Updates the details of an existing access bundle 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 Access Bundle.
Root Schema : UpdateAccessBundleDetails
Type: object
The information to be updated.
Show Source
Nested Schema : accessGuardrails
Type: array
List of access guardrail ids attached to the Access Bundle.
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the access bundle
Show Source
Nested Schema : OrchestratedSystemAttributeSummary
Type: object
Account & permission attributes
Show Source
Nested Schema : owners
Type: array
List of owner entities
Show Source
Nested Schema : tags
Type: array
List of tags attached to the Access Bundle
Show Source
Nested Schema : accountAttributes
Type: array
List of Orchestrated System account attributes
Show Source
Nested Schema : permissionAttributes
Type: array
List of Orchestrated System permission attributes
Show Source
Nested Schema : OrchestratedSystemAttributeDataSummary
Type: object
Orchestrated System Attributes
Show Source
Nested Schema : children
Type: array
nested attributes
Show Source
Nested Schema : values
Type: array
Attribute Values
Show Source
Nested Schema : NestedAttributesSummary
Type: object
Nested set of Orchestrated System attributes
Show Source
Nested Schema : items
Type: array
Orchestrated System attributes
Show Source
Nested Schema : OwnerSummary
Type: object
Owner entity object
Show Source
Back to Top

Response

Supported Media Types

200 Response

The updated Access Bundle
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 : AccessBundle
Type: object
Access Bundle object.
Show Source
Nested Schema : accessGuardrails
Type: array
List of access guardrail information attached to the Access Bundle.
Show Source
Nested Schema : IdInfo
Type: object
Generic identifying information object.
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the access bundle
Show Source
Nested Schema : OrchestratedSystemAttributeSummary
Type: object
Account & permission attributes
Show Source
Nested Schema : owners
Type: array
List of owner entities
Show Source
Nested Schema : permissions
Type: array
List of permissions
Show Source
Nested Schema : tags
Type: array
List of tags attached to the Access Bundle
Show Source
Nested Schema : AccessGuardrailDetails
Type: object
Access Guardrail object
Show Source
Nested Schema : accountAttributes
Type: array
List of Orchestrated System account attributes
Show Source
Nested Schema : permissionAttributes
Type: array
List of Orchestrated System permission attributes
Show Source
Nested Schema : OrchestratedSystemAttributeDataSummary
Type: object
Orchestrated System Attributes
Show Source
Nested Schema : children
Type: array
nested attributes
Show Source
Nested Schema : values
Type: array
Attribute Values
Show Source
Nested Schema : NestedAttributesSummary
Type: object
Nested set of Orchestrated System attributes
Show Source
Nested Schema : items
Type: array
Orchestrated System attributes
Show Source
Nested Schema : OwnerSummary
Type: object
Owner entity object
Show Source
Nested Schema : PermissionSummary
Type: object
Description of Permission.
Show Source
Nested Schema : PermissionTypeSummary
Type: object
PermissionType Summary.
Show Source
Nested Schema : ResourceSummary
Type: object
Resource Summary.
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the resource
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

412 Response

Precondition failed
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 an access bundle. Replace placeholder values with actual values before running the sample command.

Note:

Generate Access Token using grant_type = password. For more information, see Get the Bearer Token for Authoirzation using Password Credentials.

cURL Request Example

curl -i -X PUT \
   -H "Authorization:Bearer <your-access-token>" \
   -H "Content-Type:application/json" \
   -d \
'{
  "name": "DBUM Standard SQL Tuning Access UA - Update",
  "displayName": "DBUM AB UA API Update",
  "description": "DBUM AB UA API",
  "tags": ["DBUM UA"],
  "owners": [
    {
      "id": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.xxxxx",
      "name": "Amel MacLead",
      "isPrimary": true
    }
  ],
  "requestableBy": "ANY",
  "approvalWorkflowId": "NO_APPROVAL_REQUIRED",
  "orchestratedSystemId": "da7efca4-8c7a-4d4f-8ad3.xxxxx",
  "accessBundleType": "PERMISSION_BUNDLE",
  "verb": "string",
  "items": [
    {
      "id": "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxx",
      "name": "ADMINISTER ANY SQL TUNING SET"
    }
  ],
  "externalId": null,
  "domainName": null,
  "resourceType": null,
  "accountProfileId": "84321700-1a93-4cf2-9226-3f4c26fd.xxxxx",
  "accountProfileName": "dbum AP 1",
  "orchestratedSystemAttributes": {
    "accountAttributes": [],
    "permissionAttributes": [
      {
        "name": "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxx",
        "type": "RepeatableFieldSet",
        "title": null,
        "values": ["ADMINISTER ANY SQL TUNING SET"],
        "children": [
          {
            "items": [
              {
                "name": "privilegeAdminOption",
                "type": "String",
                "title": "dbum.targetAccount.armd.privileges.privilegeAdminOption.title",
                "children": [],
                "lookupType": "withAdminOption",
                "permissionType": "privileges",
                "discriminator": null,
                "values":["YES"]
              }
            ]
          }
        ],
        "discriminator": null,
        "isQuestion": true
      }
    ]
  },
  "customAttributes": {}
}' \
 '<${service-instance-url}/access-governance/access-controls/20250331/accessBundles/${accessBundleID}>'

Example Request Payload

{
  "name": "DBUM Standard SQL Tuning Access UA",
  "displayName": "DBUM AB UA API",
  "description": "DBUM AB UA API",
  "tags": ["DBUM UA"],
  "owners": [
    {
      "id": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.xxxxx",
      "name": "Amel MacLead",
      "isPrimary": true
    }
  ],
  "requestableBy": "ANY",
  "approvalWorkflowId": "NO_APPROVAL_REQUIRED",
  "orchestratedSystemId": "da7efca4-8c7a-4d4f-8ad3.xxxxx",
  "accessBundleType": "PERMISSION_BUNDLE",
  "verb": "string",
  "items": [
    {
      "id": "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxx",
      "name": "ADMINISTER ANY SQL TUNING SET"
    }
  ],
  "externalId": null,
  "domainName": null,
  "resourceType": null,
  "accountProfileId": "84321700-1a93-4cf2-9226-3f4c26fd.xxxxx",
  "accountProfileName": "dbum AP 1",
  "orchestratedSystemAttributes": {
    "accountAttributes": [],
    "permissionAttributes": [
      {
        "name": "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxx",
        "type": "RepeatableFieldSet",
        "title": null,
        "values": ["ADMINISTER ANY SQL TUNING SET"],
        "children": [
          {
            "items": [
              {
                "name": "privilegeAdminOption",
                "type": "String",
                "title": "dbum.targetAccount.armd.privileges.privilegeAdminOption.title",
                "children": [],
                "lookupType": "withAdminOption",
                ""permissionType": "privileges",
                "discriminator": null,
                "values":["YES"]
              }
            ]
          }
        ],
        "discriminator": null,
        "isQuestion": true
      }
    ]
  },
  "customAttributes": {}
}

Example of the Response Code

It may take a few seconds to create an access bundle. Do not try to abort the request.

You'll receive 200 OK response along with the following response body:

{
  "accessBundleType" : "PERMISSION_BUNDLE",
  "id" : "8307dc91-d378-41e0-8589-1e4812cd.xxxxx",
  "name" : "DBUM Standard SQL Tuning Access UA",
  "displayName" : "DBUM AB UA API",
  "description" : "DBUM AB UA API",
  "tags" : ["DBUM UA"],
  "timeCreated" : "2025-03-26T07:35:53.262Z",
  "timeUpdated" : "2025-03-26T07:35:53.262Z",
  "createdBy" : {
    "id" : "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.xxxxx",
    "name" : "Ama Maclead",
    "displayName" : "Ama Maclead"
  },
  "updatedBy" : {
    "id" : "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.xxxxx",
    "name" : "Ama Maclead",
    "displayName" : "Ama Maclead"
  },
  "requestableBy" : {
    "id" : "ANY",
    "name" : "Anyone",
    "displayName" : "Anyone"
  },
  "status" : "ACTIVE",
  "approvalWorkflowId" : {
    "id" : "NO_APPROVAL_REQUIRED",
    "name" : "No Approval Required",
    "displayName" : "No Approval Required"
  },
  "orchestratedSystem" : {
    "id" : "da7efca4-8c7a-4d4f-8ad3.xxxxx",
    "name" : "ownership-reviews-july-DBUM",
    "displayName" : "ownership-reviews-july-DBUM"
  },
  "orchestratedSystemType" : "ICF",
  "ownershipCollectionId" : "9ce09155-968f-46b0-98f0-b81313f4.xxxxx",
  "owners" : [
    {
      "id" : "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.xxxxx",
      "name" : "Amel MacLead",
      "isPrimary" : true
    }
  ],
  "externalId" : "ocid1.agcsgovernanceinstance.dev.dev.amaaaaaapzw5rdia.xxxxx",
  "cloudAccountName" : null,
  "domainName" : null,
  "resourceType" : null,
  "compartmentName" : null,
  "compartmentFqn" : null,
  "orchestratedSystemAttributes" : {
    "accountAttributes" : [],
    "permissionAttributes" : [
      {
        "name" : "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxx",
        "title" : "ADMINISTER ANY SQL TUNING SET",
        "values" : null,
        "type" : "RepeatableFieldSet",
        "permissionType" : null,
        "children" : [
          {
            "items" : [
              {
                "name" : "privilegeAdminOption",
                "title" : "dbum.targetAccount.armd.privileges.privilegeAdminOption.title",
                "values" : null,
                "type" : "String",
                "permissionType" : null,
                "children" : [],
                "discriminator" : null,
                "isQuestion" : null
              }
            ]
          }
        ],
        "discriminator" : null,
        "isQuestion" : true
      }
    ]
  },
  "accountProfileId" : "84321700-1a93-4cf2-9226-3f4c26fd.xxxxx",
  "accountProfileName" : "dbum AP 1",
  "customAttributes" : {},
  "permissions" : [
    {
      "id" : "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxx",
      "name" : "ADMINISTER ANY SQL TUNING SET",
      "description" : null,
      "type" : "ENTITLEMENTS",
      "timeCreated" : "2024-09-25T13:02:20.369Z",
      "timeUpdated" : null,
      "resource" : {
        "id" : "resource.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxx",
        "name" : "ownership-reviews-july-DBUM",
        "displayName" : "ownership-reviews-july-DBUM",
        "type" : "DBUM",
        "customAttributes" : null
      },
      "permissionType" : {
        "id" : "etype.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxx",
        "name" : "icf.connector.entitlement.type.privileges",
        "displayName" : "Privilege",
        "externalId" : "privileges"
      }
    }
  ]
}
Back to Top