Interface PlanResourcesConditionalResponse

A query plan for when the specified action is conditionally allowed for the principal on resources matching the input.

interface PlanResourcesConditionalResponse {
    cerbosCallId: string;
    condition: PlanExpressionOperand;
    kind: CONDITIONAL;
    metadata: PlanResourcesMetadata | undefined;
    requestId: string;
    validationErrors: ValidationError[];
}

Properties

cerbosCallId: string

The unique identifier for the request used in audit logs.

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

The root node of the query condition abstract syntax tree.

The type of plan.

metadata: PlanResourcesMetadata | undefined

Additional information about the query plan.

undefined if includeMetadata was false.

requestId: string

The identifier for tracing the request.

validationErrors: ValidationError[]

Any schema validation errors for the principal or resource attributes.