Oracle Access Governance REST APIs

Get a list of Campaigns

get

/access-governance/access-reviews/20250331/campaigns

Returns a list of all campaigns.

Request

Query Parameters

keywordContains: array[string]

Collection Format: multi

Maximum Number of Items: 5

The list of keywords to filter on
limit: integer

Minimum Value: 1

Maximum Value: 1000

The maximum number of items to return.

Default Value: 10
page: string

Minimum Length: 1

A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
sortBy: string

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Default Value: timeCreated

Allowed Values: [ "timeCreated", "displayName" ]
sortOrder: string

The sort order to use, either 'ASC' or 'DESC'.

Allowed Values: [ "ASC", "DESC" ]
status: string

The status of the campaign.

Allowed Values: [ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ]

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

A page of campaignSummary objects.

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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 : CampaignCollection

Type: object

Results of a campaign search.

Show Source

items(required): array items

List of campaign summaries.

{
    "type":"object",
    "description":"Results of a campaign search.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of campaign summaries.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CampaignSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of campaign summaries.

Show Source

Array of: object CampaignSummary

Summary of the AgcsCampaign.

{
    "description":"List of campaign summaries.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CampaignSummary"
    }
}

Nested Schema : CampaignSummary

Type: object

Summary of the AgcsCampaign.

Show Source

creatorId: string

The ID of the creator.
displayName(required): string

The campaign display name.
frequency: string

Allowed Values: [ "ONE_TIME", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ]

The frequency of a recurring campaign.
id(required): string

Unique identifier that is immutable on creation.
isApprovalWfCampaign: boolean

If the current campaign is having approval workflow.
isRecurring: boolean

Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.
ownerId: string

The owner ID of the campaign.
ownerName: string

The owner name of the campaign.
reviewProgress: number(float)

The progress of the review.
scope: string

Allowed Values: [ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ]

The scope of the campaign.
status(required): string

Allowed Values: [ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ]

The status of the campaign.
timeDue: string(date-time)

The time that the campaign will end.
timeStarted: string(date-time)

The time that the campaign will start.
type(required): string

Allowed Values: [ "ACCESS", "OWNERSHIP" ]

The type of the campaign (access or ownership).

{
    "description":"Summary of the AgcsCampaign.",
    "type":"object",
    "required":[
        "id",
        "displayName",
        "status",
        "type"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation.",
            "type":"string"
        },
        "displayName":{
            "description":"The campaign display name.",
            "type":"string"
        },
        "type":{
            "description":"The type of the campaign (access or ownership).",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignType",
            "enum":[
                "ACCESS",
                "OWNERSHIP"
            ]
        },
        "ownerName":{
            "description":"The owner name of the campaign.",
            "type":"string"
        },
        "ownerId":{
            "description":"The owner ID of the campaign.",
            "type":"string"
        },
        "creatorId":{
            "description":"The ID of the creator.",
            "type":"string"
        },
        "status":{
            "description":"The status of the campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignState",
            "enum":[
                "DRAFT",
                "SCHEDULED",
                "IN_PROGRESS",
                "READY_FOR_APPROVAL",
                "APPROVED",
                "TERMINATED",
                "SYSTEM_ABORTED"
            ]
        },
        "timeStarted":{
            "description":"The time that the campaign will start.",
            "type":"string",
            "format":"date-time"
        },
        "timeDue":{
            "description":"The time that the campaign will end.",
            "type":"string",
            "format":"date-time"
        },
        "reviewProgress":{
            "description":"The progress of the review.",
            "type":"number",
            "format":"float"
        },
        "frequency":{
            "description":"The frequency of a recurring campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/Frequency",
            "enum":[
                "ONE_TIME",
                "MONTHLY",
                "QUARTERLY",
                "HALF_YEARLY",
                "YEARLY"
            ]
        },
        "isRecurring":{
            "description":"Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.",
            "type":"boolean"
        },
        "scope":{
            "description":"The scope of the campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignScope",
            "enum":[
                "GOVERNANCE_SYSTEM",
                "CLOUD_PROVIDER",
                "AG"
            ]
        },
        "isApprovalWfCampaign":{
            "description":"If the current campaign is having approval workflow.",
            "type":"boolean"
        }
    }
}

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 a list of all the campaigns.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<service-instance>/access-governance/access-reviews/${version}/campaigns'

cURL Example - With Query Parameters

cURL command to restrict the data and include only IN_PROGRESS campaigns.

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<service-instance>/access-governance/access-reviews/${version}/campaigns?status=IN_PROGRESS'

Example of the Response Body

The following example shows the contents of the response body in JSON format, including a list of In Progress Campaigns:

{
    "items": [
        {
            "id": "ocid1.agcscampaign.oc1.iad.amaaaaaapzw5rdxxxxxxxe3f6obzlpjoze7tito4cpm6nwe2hpga5vtm56yq",
            "displayName": "Quarterly Access Audit - Q2 2025",
            "type": "ACCESS",
            "ownerName": "Bill Clark",
            "ownerId": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.55045.02xxxxbb4b201421b44aa046b3ceb16a",
            "creatorId": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.02xxxxbb4b201421b44aa046b3ceb16a",
            "status": "IN_PROGRESS",
            "timeStarted": "2025-06-02T06:52:25.684Z",
            "timeDue": "2025-06-07T06:52:25.684Z",
            "reviewProgress": 0.0,
            "frequency": "ONE_TIME",
            "isRecurring": false,
            "scope": "AG",
            "isApprovalWfCampaign": true
        }
    ]
}