Analyze Access Guardrails
post
/access-governance/access-controls/20250331/accessGuardrails/analyze
against Identities for any violations.
Request
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.
Details for the Access Guardrails analysis.
Root Schema : AnalyzeAccessGuardrailsDetails
Type:
object
Request Body for analyzing Access Guardrails against Identities.
Show Source
-
accessGuardrailIds:
array accessGuardrailIds
Access Guardrail Ids.
-
globalIdentityIds(required):
array globalIdentityIds
Global Identity Ids.
Response
Supported Media Types
- application/json
200 Response
The Access Guardrail analysis was successfully completed.
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 : AnalyzeAccessGuardrailsResult
Type:
object
Response body for analyzing Access Guardrails against Identities.
Show Source
-
items(required):
array items
Violation details corresponding to each global identity id.
-
violationCount(required):
integer
violationCount.
Nested Schema : items
Type:
array
Violation details corresponding to each global identity id.
Show Source
-
Array of:
object AnalyzeAccessGuardrailsViolationDetails
Analyze Access Guardrails Violation details
Nested Schema : AnalyzeAccessGuardrailsViolationDetails
Type:
object
Analyze Access Guardrails Violation details
Show Source
-
accessGuardrailId:
string
accessGuardrailId
-
globalIdentityId(required):
string
globalIdentityId
-
hasViolation(required):
boolean
hasViolation
-
violationDetails:
object violationDetails
Additional Properties Allowed: additionalPropertiesA map where keys represent unique rule identifiers and values are lists of violations.
Nested Schema : violationDetails
Type:
object
Additional Properties Allowed
Show Source
A map where keys represent unique rule identifiers and values are lists of violations.
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.
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.
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.
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 analyze violations for an identity. Replace placeholder values with actual values before running the sample command.
Before analyzing an access guardrail, you need to run the following APIs to fetch the required data:
- List Access Guardrails - [GET] {BasePath}/accessGuardrails
- List Identities - [GET] {BasePath}/identities
cURL Request Example
curl -i -X POST \
-H "Authorization:Bearer <your-access-token>" \
-H "Content-Type:application/json" \
-d \
'{
"globalIdentityIds": [
"globalId.OCI.bd49ff2a-5c47-4242-xxxx-9ba235fbb0ec.9fxxx61d84394960469c2af598b63d4"
],
"accessGuardrailIds": [
"a4203401-46c3-4xxx-891a-b1c127fa94ba"
]
}' \
'<${service-instance-url}/access-governance/access-controls/20250331/accessGuardrails/analyze>'
Submit the POST request
${service-instance-url}/access-governance/access-controls/${version}/accessGuardrails/analyze
Example Request Payload
{
"globalIdentityIds": [
"globalId.OCI.bd49ff2a-5c47-4242-xxxx-9ba235fbb0ec.9fxxx61d84394960469c2af598b63d4"
],
"accessGuardrailIds": [
"a4203401-46c3-4xxx-891a-b1c127fa94ba"
]
}
Example of the Response Code
You'll receive 200 OK response along with the following response body:
{
"violationCount" : 1,
"items" : [ {
"globalIdentityId" : "globalId.OCI.bd49ff2a-5c47-4242-xxxx-9ba235fbb0ec.9fxxx61d84394960469c2af598b63d4",
"hasViolation" : true,
"accessGuardrailId" : "a4203401-46c3-xxx-891a-b1c127fa94ba",
"violationDetails" : {
"47beef27-b07a-497e-xxxx-765fbba966aa" : [ "This Identity does not have identity attribute Organization equals MK_Org_01" ]
}
} ]
}