REST API for Oracle AI Data Platform Workbench

Search audit logs

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/actions/searchAuditLogs

Searches audit logs for AI Data Platform Workbench.

Request

Path Parameters

aiDataPlatformId(required): string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.

Query Parameters

limit: integer

Minimum Value: 1

Maximum Value: 1000

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

Default Value: 100
page: string

Minimum Length: 1

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

Header Parameters

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. The only valid characters for request IDs are letters, numbers, underscore, and dash.
opc-retry-token: string

Minimum Length: 1

Maximum Length: 64

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Details for the audit log search.

Root Schema : SearchAuditLogsDetails

Type: object

Information needed to search the audit logs.

Show Source

objectName: string

Name of the object.
objectType: string

Allowed Values: [ "DATA_LAKE", "ROLE", "CATALOG", "SCHEMA", "TABLE", "VOLUME", "VIEW", "WORKSPACE", "WORKSPACE_FILE", "WORKSPACE_FOLDER", "COMPUTE", "FOLDER", "FILE", "AUTO_POPULATE", "VOLUME_FILE", "VOLUME_FOLDER", "KNOWLEDGE_BASE", "KNOWLEDGE_BASE_JOB", "KNOWLEDGE_BASE_JOB_RUN", "KNOWLEDGE_BASE_OWNERSHIP", "VECTOR_STORE_CREDENTIALS", "AUDIT_LOG", "WORKFLOW", "CREDENTIAL" ]

Type of object.
operation: string

Allowed Values: [ "CREATE", "UPDATE", "DELETE", "VIEW", "GRANT", "REVOKE", "ATTACH", "DETACH", "VIEW_LOGS", "RENAME", "TERMINATE", "MOVE", "EXECUTE", "MANAGE_ACCESS", "QUERY", "MANAGE", "READ", "WRITE", "START", "STOP" ]

Type of operation.
query: string

Query to search the log.
sortBy: string

Default Value: time

Allowed Values: [ "startedBy", "status", "operation", "objectType", "objectName", "time" ]

The field to sort by.
sortOrder: string

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

Sort order for search results.

Example: DESC
startedBy: string

Operation started by.
status: string

Allowed Values: [ "SUCCEEDED", "FAILED" ]

Status of log.
timeBegin: string(date-time)

Start time of the logs.
timeEnd: string(date-time)

End time of the logs.

{
    "description":"Information needed to search the audit logs.",
    "type":"object",
    "properties":{
        "timeBegin":{
            "description":"Start time of the logs.",
            "type":"string",
            "format":"date-time"
        },
        "timeEnd":{
            "description":"End time of the logs.",
            "type":"string",
            "format":"date-time"
        },
        "objectType":{
            "type":"string",
            "description":"Type of object.",
            "x-obmcs-top-level-enum":"#/definitions/ObjectType",
            "enum":[
                "DATA_LAKE",
                "ROLE",
                "CATALOG",
                "SCHEMA",
                "TABLE",
                "VOLUME",
                "VIEW",
                "WORKSPACE",
                "WORKSPACE_FILE",
                "WORKSPACE_FOLDER",
                "COMPUTE",
                "FOLDER",
                "FILE",
                "AUTO_POPULATE",
                "VOLUME_FILE",
                "VOLUME_FOLDER",
                "KNOWLEDGE_BASE",
                "KNOWLEDGE_BASE_JOB",
                "KNOWLEDGE_BASE_JOB_RUN",
                "KNOWLEDGE_BASE_OWNERSHIP",
                "VECTOR_STORE_CREDENTIALS",
                "AUDIT_LOG",
                "WORKFLOW",
                "CREDENTIAL"
            ]
        },
        "objectName":{
            "description":"Name of the object.",
            "type":"string"
        },
        "operation":{
            "type":"string",
            "description":"Type of operation.",
            "x-obmcs-top-level-enum":"#/definitions/Operation",
            "enum":[
                "CREATE",
                "UPDATE",
                "DELETE",
                "VIEW",
                "GRANT",
                "REVOKE",
                "ATTACH",
                "DETACH",
                "VIEW_LOGS",
                "RENAME",
                "TERMINATE",
                "MOVE",
                "EXECUTE",
                "MANAGE_ACCESS",
                "QUERY",
                "MANAGE",
                "READ",
                "WRITE",
                "START",
                "STOP"
            ]
        },
        "status":{
            "type":"string",
            "description":"Status of log.",
            "x-obmcs-top-level-enum":"#/definitions/Status",
            "enum":[
                "SUCCEEDED",
                "FAILED"
            ]
        },
        "startedBy":{
            "description":"Operation started by.",
            "type":"string"
        },
        "query":{
            "description":"Query to search the log.",
            "type":"string"
        },
        "sortBy":{
            "type":"string",
            "enum":[
                "startedBy",
                "status",
                "operation",
                "objectType",
                "objectName",
                "time"
            ],
            "default":"time",
            "description":"The field to sort by.\n"
        },
        "sortOrder":{
            "description":"Sort order for search results.",
            "type":"string",
            "example":"DESC",
            "enum":[
                "ASC",
                "DESC"
            ]
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation. Audit log search is retrieved.

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 ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : AuditLogSearchResultCollection

Type: object

Search results for audit log search request.

Show Source

items(required): array items

Audit log search results.

{
    "description":"Search results for audit log search request.",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"Audit log search results.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AuditLogSearchResultSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Audit log search results.

Show Source

Array of: object AuditLogSearchResultSummary

Search result for audit log search request.

{
    "description":"Audit log search results.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AuditLogSearchResultSummary"
    }
}

Nested Schema : AuditLogSearchResultSummary

Type: object

Search result for audit log search request.

Show Source

eventId: string

Unique ID of the result.
objectName: string

Name of the object.
objectType: string

Allowed Values: [ "DATA_LAKE", "ROLE", "CATALOG", "SCHEMA", "TABLE", "VOLUME", "VIEW", "WORKSPACE", "WORKSPACE_FILE", "WORKSPACE_FOLDER", "COMPUTE", "FOLDER", "FILE", "AUTO_POPULATE", "VOLUME_FILE", "VOLUME_FOLDER", "KNOWLEDGE_BASE", "KNOWLEDGE_BASE_JOB", "KNOWLEDGE_BASE_JOB_RUN", "KNOWLEDGE_BASE_OWNERSHIP", "VECTOR_STORE_CREDENTIALS", "AUDIT_LOG", "WORKFLOW", "CREDENTIAL" ]

Type of object.
operation: string

Allowed Values: [ "CREATE", "UPDATE", "DELETE", "VIEW", "GRANT", "REVOKE", "ATTACH", "DETACH", "VIEW_LOGS", "RENAME", "TERMINATE", "MOVE", "EXECUTE", "MANAGE_ACCESS", "QUERY", "MANAGE", "READ", "WRITE", "START", "STOP" ]

Type of operation.
payload: string

Payload of logs.
source: string

Source of logs.
startedBy: string

Operation started by.
status: string

Allowed Values: [ "SUCCEEDED", "FAILED" ]

Status of log.
timeOfLog: string(date-time)

Time of the log.

{
    "description":"Search result for audit log search request.",
    "type":"object",
    "properties":{
        "eventId":{
            "description":"Unique ID of the result.",
            "type":"string"
        },
        "timeOfLog":{
            "description":"Time of the log.",
            "type":"string",
            "format":"date-time"
        },
        "objectType":{
            "type":"string",
            "description":"Type of object.",
            "enum":[
                "DATA_LAKE",
                "ROLE",
                "CATALOG",
                "SCHEMA",
                "TABLE",
                "VOLUME",
                "VIEW",
                "WORKSPACE",
                "WORKSPACE_FILE",
                "WORKSPACE_FOLDER",
                "COMPUTE",
                "FOLDER",
                "FILE",
                "AUTO_POPULATE",
                "VOLUME_FILE",
                "VOLUME_FOLDER",
                "KNOWLEDGE_BASE",
                "KNOWLEDGE_BASE_JOB",
                "KNOWLEDGE_BASE_JOB_RUN",
                "KNOWLEDGE_BASE_OWNERSHIP",
                "VECTOR_STORE_CREDENTIALS",
                "AUDIT_LOG",
                "WORKFLOW",
                "CREDENTIAL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/ObjectType"
        },
        "objectName":{
            "description":"Name of the object.",
            "type":"string"
        },
        "operation":{
            "type":"string",
            "description":"Type of operation.",
            "enum":[
                "CREATE",
                "UPDATE",
                "DELETE",
                "VIEW",
                "GRANT",
                "REVOKE",
                "ATTACH",
                "DETACH",
                "VIEW_LOGS",
                "RENAME",
                "TERMINATE",
                "MOVE",
                "EXECUTE",
                "MANAGE_ACCESS",
                "QUERY",
                "MANAGE",
                "READ",
                "WRITE",
                "START",
                "STOP"
            ],
            "x-obmcs-top-level-enum":"#/definitions/Operation"
        },
        "status":{
            "type":"string",
            "description":"Status of log.",
            "enum":[
                "SUCCEEDED",
                "FAILED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/Status"
        },
        "startedBy":{
            "description":"Operation started by.",
            "type":"string"
        },
        "source":{
            "description":"Source of logs.",
            "type":"string"
        },
        "payload":{
            "description":"Payload of logs.",
            "type":"string"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

opc-request-id: string

Unique Oracle-assigned ID 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 message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

opc-request-id: string

Unique Oracle-assigned ID 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 message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

opc-request-id: string

Unique Oracle-assigned ID 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 message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

opc-request-id: string

Unique Oracle-assigned ID 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 message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

opc-request-id: string

Unique Oracle-assigned ID 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 message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

opc-request-id: string

Unique Oracle-assigned ID 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 message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

opc-request-id: string

Unique Oracle-assigned ID 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 message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}