Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.
ReferenceBeta

Audit

The audit events of Console in the caller's organization: changes to it, its workspaces, members, and API keys, with the queries that read them.

Queries

myAuditEvents

The audit events Console keeps of the caller's organization, the one the token names, newest first by default. Console authorizes the read itself, from the caller's membership of the organization and access in Console: a caller it refuses gets PERMISSION_DENIED with extensions.dependency console. Only console's events are read: filter.products absent or empty reads them, and naming any other product fails with VALIDATION_ERROR. AuditEvent.workspace resolves only to the caller's own workspace, the one the token names, and is null for an event of another workspace or of none. node(id:) does not resolve these events. The types are the ones BdrQuery.myAuditEvents returns too.

myAuditEvents(
    filter: AuditEventFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: AuditEventOrder = { field: OCCURRED_AT, direction: DESC }
  ): AuditEventConnection!

Arguments

Name
Type
Description

filter

AuditEventFilter

Filtering options for the returned events.

first

Int

The first n elements from the paginated list.

after

String

The elements that come after the specified cursor.

last

Int

The last n elements from the paginated list.

before

String

The elements that come before the specified cursor.

orderBy

AuditEventOrder

The ordering options for the returned events.

Input types:

AuditEventFilter

Filtering options for audit events. The server that keeps the events can bound each statement of a read by a statement timeout, five seconds by default: a read that runs longer fails with VALIDATION_ERROR and no field, and a narrower one goes through: a shorter period between from and to, exact values instead of *Contains text, or fewer products. A field whose filter sets *Contains text that is not blank adds 50 to the request's complexity, so one request holds only a few such reads.

Field
Type
Description

actorIds

[ID!]

Filter by actors (OR within field).

actorIdContains

String

Partial match on actor ID (case-insensitive contains).

aggregateTypes

[Code!]

Filter by entity types (OR within field).

aggregateTypeContains

String

Partial match on entity type (case-insensitive contains).

aggregateIds

[ID!]

Filter by specific entity IDs (OR within field).

aggregateIdContains

String

Partial match on entity ID (case-insensitive contains).

eventCodes

[String!]

Filter by event codes (OR within field), each matched exactly as the product recorded it, letter case included. A code no event has matches nothing.

operations

Filter by operations (OR within field). Naming both operations and eventTypes fails with VALIDATION_ERROR.

eventTypes

Filter by operations (OR within field); the same as operations.

sourceTypes

Filter by source types (OR within field).

products

[Code!]

Filter by products (OR within field). Each field reads one product, such as bdr for BdrQuery.myAuditEvents and billing for BillingQuery.myAuditEvents. Absent or empty: that product; any other product fails with VALIDATION_ERROR.

traceId

String

Filter by trace ID.

traceIdContains

String

Partial match on trace ID (case-insensitive contains).

from

Return events that occurred after this timestamp.

to

Return events that occurred before this timestamp.

AuditEventOrder

Ordering options for audit events.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

AuditEventConnection

A paginated list of AuditEvent items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


myEntityHistory

The audit events Console keeps about one entity of the caller's organization, such as a workspace or an API key, newest first by default. The access and the products are as for myAuditEvents.

Arguments

Name
Type
Description

entityId

ID!

The ID of the entity whose events to return.

filter

AuditEventFilter

Filtering options for the returned events.

first

Int

The first n elements from the paginated list.

after

String

The elements that come after the specified cursor.

last

Int

The last n elements from the paginated list.

before

String

The elements that come before the specified cursor.

orderBy

AuditEventOrder

The ordering options for the returned events.

Input types:

AuditEventFilter

Filtering options for audit events. The server that keeps the events can bound each statement of a read by a statement timeout, five seconds by default: a read that runs longer fails with VALIDATION_ERROR and no field, and a narrower one goes through: a shorter period between from and to, exact values instead of *Contains text, or fewer products. A field whose filter sets *Contains text that is not blank adds 50 to the request's complexity, so one request holds only a few such reads.

Field
Type
Description

actorIds

[ID!]

Filter by actors (OR within field).

actorIdContains

String

Partial match on actor ID (case-insensitive contains).

aggregateTypes

[Code!]

Filter by entity types (OR within field).

aggregateTypeContains

String

Partial match on entity type (case-insensitive contains).

aggregateIds

[ID!]

Filter by specific entity IDs (OR within field).

aggregateIdContains

String

Partial match on entity ID (case-insensitive contains).

eventCodes

[String!]

Filter by event codes (OR within field), each matched exactly as the product recorded it, letter case included. A code no event has matches nothing.

operations

Filter by operations (OR within field). Naming both operations and eventTypes fails with VALIDATION_ERROR.

eventTypes

Filter by operations (OR within field); the same as operations.

sourceTypes

Filter by source types (OR within field).

products

[Code!]

Filter by products (OR within field). Each field reads one product, such as bdr for BdrQuery.myAuditEvents and billing for BillingQuery.myAuditEvents. Absent or empty: that product; any other product fails with VALIDATION_ERROR.

traceId

String

Filter by trace ID.

traceIdContains

String

Partial match on trace ID (case-insensitive contains).

from

Return events that occurred after this timestamp.

to

Return events that occurred before this timestamp.

AuditEventOrder

Ordering options for audit events.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

AuditEventConnection

A paginated list of AuditEvent items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


See also

Last updated

Was this helpful?