Get Policies
post
/access-governance/access-reviews/20250331/campaigns/policies
Retrieves a list of policies for running policy reviews.
Request
Query Parameters
-
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" ]
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.
The filters to apply.
Root Schema : KeywordFilteredDetails
Type:
object
The filters to apply along with the keyword contains filters.
Show Source
-
campaignType:
string
Allowed Values:
[ "ACCESS", "OWNERSHIP" ]
Campaign type (ACCESS or OWNERSHIP). The default is ACCESS on backend. -
criteria:
array criteria
Maximum Number of Items:
20
The list of criteria. -
keywordContains:
string
Maximum Length:
100
The substring to match the name or description to. -
scope(required):
string
Allowed Values:
[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ]
The scope of the campaign.
Nested Schema : criteria
Type:
array
Maximum Number of Items:
20
The list of criteria.
Show Source
-
Array of:
object Criteria
The criteria to use as a filter.
Nested Schema : Criteria
Type:
object
The criteria to use as a filter.
Show Source
-
conditions:
array conditions
Maximum Number of Items:
100
Filter condition (these conditions have an AND binding between them). -
subCriteria:
array subCriteria
The list of values of the criteria.
-
type(required):
string
Allowed Values:
[ "ORGANIZATION", "JOB_CODE", "IDENTITY_LOCATION", "RESOURCE", "RESOURCE_LOCATION", "ENTITLEMENT", "ROLE", "DOMAIN", "COMPARTMENT", "CLOUD_PROVIDER", "POLICY", "POLICY_CREATED", "CUSTOM_ATTRIBUTE", "CUSTOM_ATTRIBUTE_VALUE", "IDENTITY_COLLECTION", "IC_CREATED", "TARGET_IDENTITY", "TARGET", "GLOBAL_IDENTITY", "AM_WORKFLOW", "NOT_REVIEWED_SINCE", "ACCESS_GUARDRAIL", "GRANTED_PERMISSION_TYPE", "TEMPORAL_TYPE" ]
The type of the criteria. -
value:
array value
Maximum Number of Items:
500
The list of values of the criteria (these values have an OR binding between them).
Nested Schema : conditions
Type:
array
Maximum Number of Items:
100
Filter condition (these conditions have an AND binding between them).
Show Source
-
Array of:
object Condition
The information about Condition.
Nested Schema : subCriteria
Type:
array
The list of values of the criteria.
Show Source
-
Array of:
object Criteria
The criteria to use as a filter.
Nested Schema : value
Type:
array
Maximum Number of Items:
500
The list of values of the criteria (these values have an OR binding between them).
Show Source
Nested Schema : Condition
Type:
object
The information about Condition.
Show Source
-
additionalAttributes:
object additionalAttributes
Additional Properties Allowed: additionalPropertiesAdditional attributes for additional information related to the condition.
-
basicCondition(required):
object BasicCondition
The information about Condition.
-
childConditions:
object BasicConditionCollection
Collection of conditions.
-
type(required):
string
Allowed Values:
[ "IDENTITY_ATTRIBUTE", "PERMISSION", "DOES_NOT_HAVE_PERMISSION" ]
The type for AG Resource.
Nested Schema : additionalAttributes
Type:
object
Additional Properties Allowed
Show Source
Additional attributes for additional information related to the condition.
Nested Schema : BasicCondition
Type:
object
The information about Condition.
Show Source
-
dataType:
string
Allowed Values:
[ "STRING", "NUMBER", "BOOLEAN", "DATE" ]
Data type for the condition Identifier -
displayName(required):
string
Minimum Length:
1
Maximum Length:255
Access Guardrails Identifier -
lhs(required):
string
Minimum Length:
1
Maximum Length:512
Left hand side of the condition. -
operator(required):
string
Allowed Values:
[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TILL", "FROM", "BETWEEN", "NOT_BETWEEN", "IN", "NOT_IN", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH", "NOT_BEGINS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "IS_NULL", "IS_NOT_NULL", "EQUAL_WITH_NULL" ]
The operator for a access guardrail. -
rhs(required):
array rhs
Right hand side of the condition.
-
rhsUiDetails:
array rhsUiDetails
Right hand side details of the condition.
Nested Schema : BasicConditionCollection
Type:
object
Collection of conditions.
Show Source
-
items(required):
array items
List of condition.
Nested Schema : rhsUiDetails
Type:
array
Right hand side details of the condition.
Show Source
-
Array of:
object UiDetail
Ui detail for rendering values on UI
Nested Schema : UiDetail
Type:
object
Ui detail for rendering values on UI
Show Source
-
name(required):
string
Name of value
-
value(required):
string
Value
Nested Schema : items
Type:
array
List of condition.
Show Source
-
Array of:
object BasicCondition
The information about Condition.
Response
Supported Media Types
- application/json
200 Response
A page of policies 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 : PolicyCollection
Type:
object
PolicyCollection contains summarized information about Policies.
Show Source
-
items(required):
array items
List containing summarized information about Policies.
Nested Schema : items
Type:
array
List containing summarized information about Policies.
Show Source
-
Array of:
object PolicySummary
Policy Summary.
Nested Schema : PolicySummary
Type:
object
Policy Summary.
Show Source
-
createdBy:
object IdInfo
Generic identifying information object.
-
customAttributes:
object customAttributes
Metadata associated with the access bundle
-
description:
string
Description of the Policy.
-
id(required):
string
The Unique Oracle ID (OCID) that is immutable on creation.
-
isOwner:
boolean
Boolean value checking if logged-in user is owner of this resource or not.
-
name:
string
A user-friendly name. Have to be unique. Avoid entering confidential information.
-
primaryOwner:
object PrimaryOwner
Details of a primary Owner.
-
status:
string
Allowed Values:
[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]
Status of the Policy -
tags:
array tags
List of tags attached to the Policy.
-
timeCreated:
string(date-time)
Time when the Policy was created. An RFC3339 formatted datetime string
-
timeUpdated:
string(date-time)
Time when the Policy was last updated. An RFC3339 formatted datetime string
Nested Schema : IdInfo
Type:
object
Generic identifying information object.
Show Source
-
displayName:
string
Display Name of the entity.
-
id:
string
Id of the entity.
-
name:
string
Name of the entity.
Nested Schema : customAttributes
Type:
object
Metadata associated with the access bundle
Show Source
Nested Schema : PrimaryOwner
Type:
object
Details of a primary Owner.
Show Source
-
displayName:
string
Display name of the primary Owner.
-
value:
string
Id of the primary Owner.
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.
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.
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.
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.
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.
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.
Examples
The following example shows how to retrieve a list of available policies for performing Access Control reviews.
cURL Request Example
curl -i -L -X POST \
-H "Authorization:Bearer <your long access token>" \
-H "Content-Type:application/json" \
-d \
'{
"criteria": [],
"scope": "AG",
"campaignType": "ACCESS"
}' \ \
'<${service-instance-url}/access-governance/access-reviews/${version}/campaigns/policies>'
Sample Request Payload
Select
POST
and add the following URL${service-instance-url}/access-governance/access-reviews/${version}/campaigns/policies
{
"criteria": [],
"scope": "AG",
"campaignType": "ACCESS"
}
Example of the Response Code
You'll receive 200 response with the following body:
{
"items": [
{
"id": "93bcxxe9-10c0-4b58-9b34-23ccxx961c2a",
"name": "Compartment-Dev-App",
"description": "Development environment for application services",
"type": null,
"compartmentName": "Dev-App",
"compartmentFullName": "Tenancy/Dev-App"
},
{
"id": "9cd0xx69-1f8f-4514-9395-87b4xxe54c2d",
"name": "Compartment-DB-Test",
"description": "Testing environment for database workloads",
"type": null,
"compartmentName": "DB-Test",
"compartmentFullName": "Tenancy/DB-Test"
},
{
"id": "d6b5xx45-529e-42ad-89e7-1aa2xx75bc69",
"name": "Compartment-Prod-Web",
"description": "Production web services compartment",
"type": null,
"compartmentName": "Prod-Web",
"compartmentFullName": "Tenancy/Prod-Web"
},
{
"id": "1f0bxxf1-a4e2-4664-97e4-aaafxxe88259",
"name": "Compartment-Networking",
"description": "Networking resources and VCNs",
"type": null,
"compartmentName": "Networking",
"compartmentFullName": "Tenancy/Networking"
},
{
"id": "3fd6xxdc-101d-4399-837e-9f2dxxcd3312",
"name": "Compartment-Security",
"description": "IAM policies and security configurations",
"type": null,
"compartmentName": "Security",
"compartmentFullName": "Tenancy/Security"
},
{
"id": "8028xxd6-33d1-436a-af81-e7e5xx66de71",
"name": "Compartment-Monitoring",
"description": "Monitoring and logging services",
"type": null,
"compartmentName": "Monitoring",
"compartmentFullName": "Tenancy/Monitoring"
},
{
"id": "9769xxd6-ae36-4b37-b450-18a2xx0206df",
"name": "Compartment-Analytics",
"description": "Analytics and data pipeline workloads",
"type": null,
"compartmentName": "Analytics",
"compartmentFullName": "Tenancy/Analytics"
},
{
"id": "19faxx23-6d69-4046-8d8d-ad4exx7b3ac4",
"name": "Compartment-DevOps",
"description": "CI/CD pipelines and automation scripts",
"type": null,
"compartmentName": "DevOps",
"compartmentFullName": "Tenancy/DevOps"
},
{
"id": "447fxx17-7416-4a1c-b3fb-a3a0xx5d7a2d",
"name": "Compartment-Backup",
"description": "Backup and disaster recovery resources",
"type": null,
"compartmentName": "Backup",
"compartmentFullName": "Tenancy/Backup"
},
{
"id": "bcb3xx3e-b99e-4043-a209-eb91xx5eac7f",
"name": "Compartment-Shared-Services",
"description": "Shared services used across multiple teams",
"type": null,
"compartmentName": "Shared-Services",
"compartmentFullName": "Tenancy/Shared-Services"
}
]
}