audit

List Data Audit Events

Lists data audit events that match query parameters.

get/v1/audit/events

Request

  • Base URL: https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com
  • URL: https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com/v1/audit/events
  • Auth: HTTP bearer

Query parameters

filterOps.context.changeIDstring

ID for the audit event. Use this to uniquely identify a specific audit record.

filterOps.context.requestIDstring

ID for the request that caused the event. Use to correlate multiple audit events triggered by a single API request.

filterOps.context.sessionIDstring

ID for the session in which the request was sent. Present when a session context is available.

filterOps.context.actorstring

Member who sent the request. Depending on actorType, this may be a user ID or a service account ID. For users this is their email address.

filterOps.context.actorType'NONE' | 'USER' | 'GROUP' | 'SERVICE_ACCOUNT' | 'SQL_SERVICE_ACCOUNT'

Type of member who sent the request.

filterOps.context.accessType'ACCESS_NONE' | 'API' | 'SQL' | 'OKTA_LOGIN'

Type of access for the request.

filterOps.context.ipAddressstring

IP Address of the client that made the request.

filterOps.context.originstring

HTTP Origin request header (including scheme, hostname, and port) of the request. Present only for browser-originated requests. Absent for server-to-server API calls.

filterOps.context.authMode'AUTH_NONE' | 'OKTA_JWT' | 'SERVICE_ACCOUNT_JWT' | 'PAT_JWT' | 'API_KEY' | 'STS'

Authentication mode the actor used. OKTA_JWT: Federated identity via Okta SSO. SERVICE_ACCOUNT_JWT: Service account JWT (machine-to-machine). PAT_JWT: Personal Access Token issued as a JWT. API_KEY: Static API key.

filterOps.context.jwtIDstring

ID of the JWT token (the jti claim). Identifies the specific token used for this request.

filterOps.context.bearerTokenContextIDstring

User context embedded in the bearer token. Present when a bearer token encodes additional user context.

filterOps.context.clientTraceIDstring

Correlation ID supplied by the caller, so you can find audit events by the request ID your own systems already use. Opaque to Skyflow: recorded as sent and never interpreted. Distinct from traceID, which is Skyflow's own internal trace. Capped at 128 characters.

filterOps.parentAccountIDstring

Resources with the specified parent account ID.

filterOps.accountIDstring required
filterOps.workspaceIDstring

Resources with the specified workspace ID.

filterOps.vaultIDstring

Resources with the specified vault ID.

filterOps.resourceIDsstring

Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of "<resourceType>/<resourceID>". For example, "VAULT/12345, USER/67890".

filterOps.request.clientInfo.userEmailstring

Email of the end user on whose behalf the caller made the request, from the ctx.email claim of the bearer token.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.