Jump to

• Request
• Response
• Examples

Get Access Governance criteria type with its states

get

/access-governance/access-reviews/20250331/campaigns/systemBrowser/ag/criteria

Retrieves a list of available Access Governance criteria types and their availability states. Applicable for Ownership 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" ]
• state: string
  The state of system criteria type.

  Allowed Values: [ "AVAILABLE", "NOT_AVAILABLE" ]

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of Ag criteria type with its states.

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.

Body ()

Root Schema : AgCriteriaSummaryCollection

Type: object

The list of AgCriteriaSummary.

Show Source

• items(required): array items
  The list of AgCriteriaSummary.

{
    "type":"object",
    "description":"The list of AgCriteriaSummary.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"The list of AgCriteriaSummary.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AgCriteriaSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

The list of AgCriteriaSummary.

Show Source

• Array of: object AgCriteriaSummary
  It contains the info of AG criteria type and criteria state.

{
    "description":"The list of AgCriteriaSummary.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AgCriteriaSummary"
    }
}

Nested Schema : AgCriteriaSummary

Type: object

It contains the info of AG criteria type and criteria state.

Show Source

• state(required): string
  Allowed Values: [ "AVAILABLE", "NOT_AVAILABLE" ]

  The state of the criteria.
• type(required): string
  Allowed Values: [ "AG_ENTITLEMENT", "AG_APPROVAL_WORKFLOW", "AG_IDENTITY_COLLECTION", "AG_SYSTEM", "AG_POLICY", "AG_ROLE", "AG_ACCESS_GUARDRAIL" ]

  The type of the AG criteria.

{
    "type":"object",
    "description":"It contains the info of AG criteria type and criteria state.",
    "required":[
        "type",
        "state"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The type of the AG criteria.",
            "x-obmcs-top-level-enum":"#/definitions/AgCriteriaType",
            "enum":[
                "AG_ENTITLEMENT",
                "AG_APPROVAL_WORKFLOW",
                "AG_IDENTITY_COLLECTION",
                "AG_SYSTEM",
                "AG_POLICY",
                "AG_ROLE",
                "AG_ACCESS_GUARDRAIL"
            ]
        },
        "state":{
            "type":"string",
            "description":"The state of the criteria.",
            "x-obmcs-top-level-enum":"#/definitions/SystemCriteriaState",
            "enum":[
                "AVAILABLE",
                "NOT_AVAILABLE"
            ]
        }
    }
}

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top

Examples

The following example shows how to retrieve a list of available campaign criteria types for the Oracle Access Governance system.

cURL Example - Without Query Parameters

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

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
"items" : [ {
  "type" : "AG_ACCESS_GUARDRAIL",
  "state" : "AVAILABLE"
}, {
  "type" : "AG_APPROVAL_WORKFLOW",
  "state" : "AVAILABLE"
}, {
  "type" : "AG_ENTITLEMENT",
  "state" : "AVAILABLE"
}, {
  "type" : "AG_IDENTITY_COLLECTION",
  "state" : "AVAILABLE"
}, {
  "type" : "AG_POLICY",
  "state" : "AVAILABLE"
}, {
  "type" : "AG_ROLE",
  "state" : "AVAILABLE"
}, {
  "type" : "AG_SYSTEM",
  "state" : "AVAILABLE"
} ]
}

Back to Top