Get a list of Access Guardrails
get
/access-governance/access-controls/20250331/accessGuardrails
Returns details of all available access guardrails with support for pagination.
Request
Query Parameters
-
keywordContains: string
Keyword to filter on. Only one keyword may be provided. Default is empty string.
-
limit: integer
Minimum Value:
1
Maximum Value:1000
The maximum number of items to return.Default Value:10
-
name: string
Maximum Length:
100
A name to filter results -
ownerId: string
Owner ID to filter on
-
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. -
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.
Response
Supported Media Types
- application/json
200 Response
A list of Access Guardrail Summaries
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 : AccessGuardrailCollection
Type:
object
Results of a AccessGuardrail search. Contains both AccessGuardrailSummary items and other data.
Show Source
-
items(required):
array items
List of access guardrail.
Nested Schema : items
Type:
array
List of access guardrail.
Show Source
-
Array of:
object AccessGuardrailSummary
Summary of the AccessGuardrail.
Nested Schema : AccessGuardrailSummary
Type:
object
Summary of the AccessGuardrail.
Show Source
-
id(required):
string
Unique identifier that is immutable on creation
-
lifecycleState(required):
string
Allowed Values:
[ "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" ]
The current state of the AccessGuardrail. -
name:
string
Access Guardrail Identifier, can be renamed
-
primaryOwnerDisplayName:
string
DisplayName of the primary owner.
-
tags:
array tags
Tags for the AccessGuardrail.
-
timeCreated:
string(date-time)
The time the the AccessGuardrail was created. An RFC3339 formatted datetime string
-
timeUpdated:
string(date-time)
The time the the AccessGuardrail was updated. An RFC3339 formatted datetime string
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 Access Guardrails by submitting a GET request
cURL Example - Without Query Parameters
curl -i -X GET \
-H "Authorization:Bearer <your access token>" \
'https://<host>/access-governance/access-controls/20250331/accessGuardrails'
cURL Example - With Query Parameters
cURL command to restrict the list of Access Guardrails.
curl -i -X GET \
-H "Authorization:Bearer <your access token>" \
'https://<host>/access-governance/access-controls/20250331/accessGuardrails?limit=1'
Example of the Response Body
The following example shows the contents of the response body in JSON format, including a list of all available Access Guardrails:
{
"items":[
{
"id": "01ffca11-xxxx-4d8f-bd89-b043e018axx",
"name": "AD Access Guardrails API Sample",
"lifecycleState": "ACTIVE",
"tags":[
],
"primaryOwnerDisplayName": "Amel Maclead",
"timeCreated": "2025-03-25T06:31:58.548Z",
"timeUpdated": "2025-03-25T06:31:58.548Z"
}
]
}