Cerbos JavaScript SDK
    Preparing search index...

    Interface CheckResourcesRequest

    Input to Client.checkResources.

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

    Properties

    auxData? includeMetadata? principal requestContext? requestId? resources

    Properties

    auxData?: AuxData

    Auxiliary data.

    {}

    includeMetadata?: boolean

    Include additional metadata in the results?

    false

    principal: Principal

    The principal to check.

    requestContext?: RequestContext

    Metadata to attach to the request.

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

    This information will be captured in the audit logs if audit logging is enabled in the policy decision point server.

    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