Interface PlanResourcesResponseBase

Common fields between different PlanResourcesResponse types.

interface PlanResourcesResponseBase {
    cerbosCallId: string;
    metadata: PlanResourcesMetadata | undefined;
    requestId: string;
    validationErrors: ValidationError[];
}

Hierarchy (View Summary)

PlanResourcesResponseBase
- PlanResourcesConditionalResponse
- PlanResourcesUnconditionalResponse

Index

Properties

cerbosCallId metadata requestId validationErrors

Properties

cerbosCallId

cerbosCallId: string

The unique identifier for the request used in audit logs.

Remarks

Requires the Cerbos policy decision point server to be at least v0.33.

metadata

metadata: PlanResourcesMetadata | undefined

Additional information about the query plan.

Remarks

undefined if includeMetadata was false.

requestId

requestId: string

The identifier for tracing the request.

validationErrors

validationErrors: ValidationError[]

Any schema validation errors for the principal or resource attributes.