Interface Event

interface Event {
    id: string;
    locality: string;
    methodName: string;
    organizationId: string;
    principal?: EventPrincipal;
    productName: string;
    projectId?: string;
    recordedAt?: Date;
    requestBody?: Record<string, unknown>;
    requestId: string;
    resource?: AuditTrail.v1alpha1.Resource;
    serviceName: string;
    sourceIp: string;
    statusCode: number;
    userAgent?: string;
}

Properties

id locality methodName organizationId principal? productName projectId? recordedAt? requestBody? requestId resource? serviceName sourceIp statusCode userAgent?

Properties

id

id: string

ID of the event.

locality

locality: string

Locality of the resource attached to the event.

methodName

methodName: string

API method called to trigger the event.

organizationId

organizationId: string

Organization ID containing the event.

Optionalprincipal

principal?: EventPrincipal

User or IAM application at the origin of the event.

productName

productName: string

Product name of the resource attached to the event.

OptionalprojectId

projectId?: string

(Optional) Project of the resource attached to the event.

OptionalrecordedAt

recordedAt?: Date

Timestamp of the event.

OptionalrequestBody

requestBody?: Record<string, unknown>

Request at the origin of the event.

requestId

requestId: string

Unique identifier of the request at the origin of the event.

Optionalresource

resource?: AuditTrail.v1alpha1.Resource

Resource attached to the event.

serviceName

serviceName: string

API name called to trigger the event.

sourceIp

sourceIp: string

IP address at the origin of the event.

statusCode

statusCode: number

HTTP status code resulting of the API call.

OptionaluserAgent

userAgent?: string

User Agent at the origin of the event.

Settings

On This Page

Properties