Oracle Access Governance REST APIs

Approve or sign-off a campaign

post

/access-governance/access-reviews/20250331/campaigns/{campaignId}/actions/approve

Request

Path Parameters

campaignId(required): string

Unique Campaign identifier.

Header Parameters

if-match: string

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
opc-request-id: string

The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
opc-retry-token: string

Minimum Length: 1

Maximum Length: 64

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Response

Supported Media Types

application/json

200 Response

Successfully approve or sign-off the campaign.

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.

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."
}

409 Response

Conflict

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."
}

412 Response

Precondition failed

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 approve or sign-off a campaign. The campaign owner can approve and sign-off a campaign. If any other user tries to approve a campaign, you'll receive a NotAuthenticated error.

cURL Request Example

curl -i -X POST \
   -H "Authorization:Bearer <your-access-token>" \
   -H "Content-Type:application/json" \
 '<${service-instance-url}/access-governance/${si}/access-governance/access-reviews/${version}/campaigns/${campaignId}/actions/approve>'

Example of the Response Code

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" : null,
        "values" : ["ADMINISTER ANY SQL TUNING SET"],
        "type" : "RepeatableFieldSet",
        "permissionType" : null,
        "children" : [
          {
            "items" : [
              {
                "name" : "privilegeAdminOption",
                "title" : "dbum.targetAccount.armd.privileges.privilegeAdminOption.title",
                "values" : null,
                "type" : "String",
                "permissionType" : "privileges",
                "children" : [],
                "discriminator" : null,
                "isQuestion" : null,
                 "values": ["YES"]
              }
            ]
          }
        ],
        "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"
      }
    }
  ]
}