Cerbos JavaScript SDK
    Preparing search index...

    Interface CheckResourcesRequest

    Input to Client.checkResources.

    interface CheckResourcesRequest {
        auxData?: AuxData;
        includeMetadata?: boolean;
        principal: Principal;
        requestId?: string;
        resources: ResourceCheck[];
    }
    Index

    Properties

    auxData? includeMetadata? principal requestId? resources

    Properties

    auxData?: AuxData

    Auxiliary data.

    {}

    includeMetadata?: boolean

    Include additional metadata in the results?

    false

    principal: Principal

    The principal to check.

    requestId?: string

    An identifier for tracing the request.

    A randomly-generated UUID.
    resources: ResourceCheck[]

    The resources and actions to check.

    Settings

    Member Visibility

    On This Page

    Properties