Cerbos JavaScript SDK
    Preparing search index...

    Interface ClientOptions

    Options for connecting to Cerbos Hub.

    interface ClientOptions {
        baseUrl?: string;
        credentials: Credentials;
        headers?: HeadersInit | (() => Awaitable<HeadersInit>);
        userAgent?: string;
    }

    Hierarchy

    Index

    Properties

    baseUrl? credentials headers? userAgent?

    Properties

    baseUrl?: string

    Base URL of the Cerbos Hub server.

    "https://api.cerbos.cloud"

    credentials: Credentials

    Client credentials to authenticate with Cerbos Hub.

    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

    userAgent?: string

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

    undefined

    Settings

    Member Visibility

    On This Page

    Properties