Cerbos JavaScript SDK
    Preparing search index...

    Interface Options

    Options for creating a new Client.

    interface Options {
        adminCredentials?: AdminCredentials;
        headers?: HeadersInit | (() => Awaitable<HeadersInit>);
        onValidationError?: ValidationFailedCallback | "throw";
        playgroundInstance?: string;
        userAgent?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    adminCredentials?: AdminCredentials

    Credentials for the admin API.

    undefined

    headers?: HeadersInit | (() => Awaitable<HeadersInit>)

    Headers to add to every request to the policy decision point.

    Headers can be included in the policy decision point's audit logs by setting the includeMetadataKeys or excludeMetadataKeys fields in the audit configuration block.

    The User-Agent header is set using Options.userAgent.

    undefined

    onValidationError?: ValidationFailedCallback | "throw"

    Action to take when input fails schema validation.

    Possible values are

    undefined

    playgroundInstance?: string

    Identifier of the playground instance to use when prototyping against the hosted demo policy decision point.

    undefined

    userAgent?: string

    Custom user agent to prepend to the built-in value.

    undefined