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

Update Role

put

/access-governance/access-controls/20250331/roles/{roleId}

Updates the details of an existing role 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 Role.
Root Schema : UpdateRoleDetails
Type: object
The information to be updated.
Show Source
Nested Schema : accessBundles
Type: array
List of Access Bundles
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the role
Show Source
Nested Schema : owners
Type: array
List of owner entities
Show Source
Nested Schema : tags
Type: array
List of tags attached to the Role
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 Role
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 : Role
Type: object
Role object.
Show Source
Nested Schema : accessBundles
Type: array
List of Access Bundles
Show Source
Nested Schema : IdInfo
Type: object
Generic identifying information object.
Show Source
Nested Schema : customAttributes
Type: object
Metadata associated with the role
Show Source
Nested Schema : owners
Type: array
List of owner entities
Show Source
Nested Schema : tags
Type: array
List of tags attached to the Role
Show Source
Nested 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 : 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 a role by submitting a PUT request. In this example, as an extension to create example, we will add another access bundle permission set for the database admin

Note:

Generate Access Token using grant_type = password.

cURL Example - Without Query Parameters

curl -i -L -X PUT \
   -H "Authorization:Bearer <your-access-token>" \
   -H "Content-Type:application/json" \
   -d \
'{
  "name": "Database Administrator Role",
  "description": "Responsible for managing database access and ensuring optimized SQL performance.",
  "requestableBy": "ANY",
  "approvalWorkflowId": "NO_APPROVAL_REQUIRED",
  "tags": [
    "Database Role"
  ],
  "accessBundles": [
    {
      "id": "b943f987-xxxx-4bac-bca0-6a09ded5dcad",
      "name": "DBUM Standard SQL Tuning Access UA 8",
      "displayName": "DBUM Standard SQL Tuning Access UA 8",
      "owners": [
        {
          "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
          "name": "Bill Clark",
          "isPrimary": true
        }
      ]
    },
    {
      "id": "9f6a9e49-xxxx-4211-b702-cd47072346a2",
      "name": "ALTER ANY TABLE",
      "displayName": "Database Privilege - ALTER ANY TABLE",
      "owners": [
        {
          "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
          "name": "Bill Clark",
          "isPrimary": true
        }
      ]
    }
  ],
  "customAttributes": null,
  "displayName": "Database Administrator Role",
  "owners": [
    {
      "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
      "name": "Bill Clark",
      "isPrimary": true
    }
  ]
}' \
 '<${service-instance-url}/access-governance/access-controls/20250331/roles/${roleID}>'

Example Request Payload

{
  "name": "Database Administrator Role",
  "description": "Responsible for managing database access and ensuring optimized SQL performance.",
  "requestableBy": "ANY",
  "approvalWorkflowId": "NO_APPROVAL_REQUIRED",
  "tags": [
    "Database Role"
  ],
  "accessBundles": [
    {
      "id": "b943f987-xxxx-4bac-bca0-6a09ded5dcad",
      "name": "DBUM Standard SQL Tuning Access UA 8",
      "displayName": "DBUM Standard SQL Tuning Access UA 8",
      "owners": [
        {
          "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
          "name": "Bill Clark",
          "isPrimary": true
        }
      ]
    },
    {
      "id": "9f6a9e49-xxxx-4211-b702-cd47072346a2",
      "name": "ALTER ANY TABLE",
      "displayName": "Database Privilege - ALTER ANY TABLE",
      "owners": [
        {
          "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
          "name": "Bill Clark",
          "isPrimary": true
        }
      ]
    }
  ],
  "customAttributes": null,
  "displayName": "Database Administrator Role",
  "owners": [
    {
      "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
      "name": "Bill Clark",
      "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 role:

{
  "id": "7642ff7d-xxxx-45c4-88d4-db7d2e79e85f",
  "name": "Database Administrator Role",
  "description": "Responsible for managing database access and ensuring optimized SQL performance.",
  "requestableBy": {
    "id": "ANY",
    "name": "Anyone",
    "displayName": "Anyone"
  },
  "status": "ACTIVE",
  "approvalWorkflowId": {
    "id": "NO_APPROVAL_REQUIRED",
    "name": "No Approval Required",
    "displayName": "No Approval Required"
  },
  "tags": [
    "Database Role"
  ],
  "accessBundles": [
    {
      "id": "b943f987-xxxx-4bac-bca0-6a09ded5dcad",
      "name": "DBUM Standard SQL Tuning Access UA 8",
      "displayName": "DBUM Standard SQL Tuning Access UA 8",
      "owners": [
        {
          "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
          "name": "Bill Clark",
          "isPrimary": true
        }
      ],
  "createdBy" : {
    "id" : "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
    "name" : "Amel Maclead",
    "displayName" : "Amel Maclead"
  },
  "updatedBy" : {
    "id" : "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b201421b44aa046b3ceb16a",
    "name" : "Amel Maclead",
    "displayName" : "Amel Maclead"
  },
  "customAttributes" : null,
  "externalId" : "cid1.agcsgovernanceinstance.dev.dev.xxxxxxxxpzw5rdia4pv5rudpgmf5enb2yzcloj2pbd5ogxaructfrhgbuq7a",
  "displayName" : "Database Admin Role"
}
Back to Top