Oracle Access Governance REST APIs

Get a list of Access Bundles

get

/access-governance/access-controls/20250331/accessBundles

Returns details of all available access bundles with support for pagination.

Request

Query Parameters

approvalWorkflowId: string

Minimum Length: 1

Maximum Length: 255

A filter to return only resources that match the given approval workflow id.
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
orchestratedSystemId: string

Minimum Length: 1

Maximum Length: 255

A filter to return only resources that match given orchestrated system identifier.
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.
requestableBy: string

Minimum Length: 1

Maximum Length: 255

A filter to return only resources that match the given identityType.

Allowed Values: [ "ANY", "NONE" ]
sortBy: string

A filter to be used for sorting Access Bundles with the given sort by field. Only one sort order may be provided.

Default Value: timeUpdatedOn

Allowed Values: [ "name", "timeUpdated", "createdBy" ]
sortOrder: string

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

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

A filter to be used for finding Access Bundles with the given status.

Default Value: ALL

Allowed Values: [ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ]
userId: string

Minimum Length: 1

Maximum Length: 255

Identifier of the user who is performing the operation

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 Bundle 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 : AccessBundleCollection

Type: object

Results of an Access Bundle list request.

Show Source

items(required): array items

List of Access Bundle summaries.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Access Bundle summaries.",
            "items":{
                "$ref":"#/definitions/AccessBundleSummary"
            }
        }
    },
    "description":"Results of an Access Bundle list request."
}

Nested Schema : items

Type: array

List of Access Bundle summaries.

Show Source

Array of: object AccessBundleSummary

Access Bundle summary object.

{
    "type":"array",
    "description":"List of Access Bundle summaries.",
    "items":{
        "$ref":"#/definitions/AccessBundleSummary"
    }
}

Nested Schema : AccessBundleSummary

Type: object

Access Bundle summary object.

Show Source

accessBundleType: string

Allowed Values: [ "RESOURCE_BUNDLE", "PERMISSION_BUNDLE" ]

Type of the Access Bundle.
approvalWorkflowId: string

The id of the approval workflow that is applicable to the Access Bundle.
createdBy: object IdInfo

Generic identifying information object.
customAttributes: object customAttributes

Custom attributes associated with the Access Bundle.
description: string

Access Bundle description.
id(required): string

Unique identifier that is immutable on creation by the system.
isOwner: boolean

True if the identity of the caller is the owner of the Access Bundle.
name: string

Access Bundle name.
orchestratedSystem: object IdInfo

Generic identifying information object.
primaryOwner: object PrimaryOwner

Details of a primary Owner
requestableBy: string

Allowed Values: [ "ANY", "NONE" ]

The identity type that may request the Access Bundle.
status: string

Allowed Values: [ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]

Status of the Access Bundle.
tags: array tags

List of tags attached to the Access Bundle.
timeCreated: string(date-time)

Time when the Access Bundle was created. An RFC3339 formatted datetime string.
timeUpdated: string(date-time)

Time when the Access Bundle was last updated. An RFC3339 formatted datetime string.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation by the system."
        },
        "name":{
            "type":"string",
            "description":"Access Bundle name."
        },
        "description":{
            "type":"string",
            "description":"Access Bundle description."
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Access Bundle.",
            "items":{
                "type":"string"
            }
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was created. An RFC3339 formatted datetime string."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was last updated. An RFC3339 formatted datetime string."
        },
        "createdBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "requestableBy":{
            "type":"string",
            "description":"The identity type that may request the Access Bundle.",
            "enum":[
                "ANY",
                "NONE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/RequestableBy"
        },
        "status":{
            "type":"string",
            "description":"Status of the Access Bundle.",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityStatus",
            "x-default-description":"ACTIVE"
        },
        "approvalWorkflowId":{
            "type":"string",
            "description":"The id of the approval workflow that is applicable to the Access Bundle."
        },
        "orchestratedSystem":{
            "$ref":"#/definitions/IdInfo"
        },
        "accessBundleType":{
            "type":"string",
            "description":"Type of the Access Bundle.",
            "enum":[
                "RESOURCE_BUNDLE",
                "PERMISSION_BUNDLE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AccessBundleType"
        },
        "primaryOwner":{
            "$ref":"#/definitions/PrimaryOwner"
        },
        "isOwner":{
            "type":"boolean",
            "description":"True if the identity of the caller is the owner of the Access Bundle."
        },
        "customAttributes":{
            "type":"object",
            "description":"Custom attributes associated with the Access Bundle.",
            "properties":{
            }
        }
    },
    "description":"Access Bundle summary object."
}

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the entity."
        },
        "name":{
            "type":"string",
            "description":"name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic identifying information object."
}

Nested Schema : customAttributes

Type: object

Custom attributes associated with the Access Bundle.

Show Source

{
    "type":"object",
    "description":"Custom attributes associated with the Access Bundle.",
    "properties":{
    }
}

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.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"id of the primary Owner."
        },
        "displayName":{
            "type":"string",
            "description":"display name of the primary Owner."
        }
    },
    "description":"Details of a primary Owner"
}

Nested Schema : tags

Type: array

List of tags attached to the Access Bundle.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Access Bundle.",
    "items":{
        "type":"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.

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