@faable/auth-js - v1.7.4
    Preparing search index...

    Type Alias FaableAuthClientConfig

    FaableAuthClientConfig: {
        audience?: string;
        authorizationParams?: AuthorizationParams;
        clientId: string;
        cookieDomain?: string;
        cookieOptions?: CookieOptions;
        domain: string;
        flowType?: AuthFlowType;
        lock?: LockFunc;
        redirectUri?: string;
        scope?: string;
        storage?: SupportedStorage | "cookie" | "localStorage";
        storageKey?: string;
        useRefreshTokens?: boolean;
    } & BaseLogOptions

    Configuration accepted by createClient and the FaableAuthClient constructor.

    domain and clientId are the only required fields. Everything else has sensible defaults — see the individual properties for the specifics.

    Type Declaration

    • Optionalaudience?: string

      Default API audience the access tokens issued for this client should be bound to. Forwarded to /authorize and to the /oauth/token POST bodies (code exchange, refresh, OTP). signInWith* methods accept an audience argument to override it per call.

    • OptionalauthorizationParams?: AuthorizationParams
    • clientId: string

      Required. Application client ID from the dashboard.

    • OptionalcookieDomain?: string
    • OptionalcookieOptions?: CookieOptions

      (Optional) Overrides for the cookie storage attributes. Setting this also implicitly switches to the cookie adapter, so passing storage: 'cookie' is not required when you only want to tweak attributes.

    • domain: string

      Required. Your Faable Auth tenant domain.

    • OptionalflowType?: AuthFlowType

      OAuth flow used when initiating sign-in. Defaults to 'pkce' in browsers and 'implicit' elsewhere.

    • Optional Experimentallock?: LockFunc

      Provide your own locking mechanism based on the environment. By default no locking is done at this time.

    • OptionalredirectUri?: string

      Default callback URL. Falls back to window.location.origin.

    • Optionalscope?: string

      Space-separated scopes. Defaults to openid profile email.

    • Optionalstorage?: SupportedStorage | "cookie" | "localStorage"

      Where to keep the session. Pass 'localStorage' (default) or 'cookie' for the bundled adapters, or any custom SupportedStorage implementation. The cookie adapter ships with sane defaults (Path=/, SameSite=Lax, auto Secure on HTTPS, 30-day Max-Age); use cookieOptions to override.

    • OptionalstorageKey?: string

      Optional prefix for the storage key. Final key is ${storageKey}-${clientId}.

    • OptionaluseRefreshTokens?: boolean

    Settings

    Member Visibility