Cerbos JavaScript SDK
    Preparing search index...

    Interface PlanResourcesRequestWithAction

    Input to Client.planResources.

    interface PlanResourcesRequestWithAction {
        action: string;
        auxData?: AuxData;
        includeMetadata?: boolean;
        principal: Principal;
        requestId?: string;
        resource: ResourceQuery;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action auxData? includeMetadata? principal requestId? resource

    Properties

    action: string

    The action for which to plan.

    Use actions instead.

    auxData?: AuxData

    Auxiliary data.

    {}

    includeMetadata?: boolean

    Include additional metadata in the plan?

    false

    principal: Principal

    The principal for whom to plan.

    requestId?: string

    The identifier for tracing the request.

    A randomly-generated UUID.
    resource: ResourceQuery

    Partial details of the resources for which to plan.

    Settings

    Member Visibility

    On This Page

    Properties