React Native Auth0 - v5.5.0
    Preparing search index...

    Interface WebAuth0Options

    Extends the core Auth0Options with web-specific configuration that is passed down to @auth0/auth0-spa-js.

    Platform specific: Web only.

    https://auth0.github.io/auth0-spa-js/interfaces/Auth0ClientOptions.html

    interface WebAuth0Options {
        domain: string;
        localAuthenticationOptions?: LocalAuthenticationOptions;
        clientId: string;
        timeout?: number;
        headers?: Record<string, string>;
        useDPoP?: boolean;
        maxRetries?: number;
        cacheLocation?: "memory" | "localstorage";
        useRefreshTokens?: boolean;
        useRefreshTokensFallback?: boolean;
        audience?: string;
        scope?: string;
        useMrrt?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    domain localAuthenticationOptions? clientId timeout? headers? useDPoP? maxRetries? cacheLocation? useRefreshTokens? useRefreshTokensFallback? audience? scope? useMrrt?

    Properties

    domain: string

    Your Auth0 application's domain. e.g., 'your-tenant.us.auth0.com'

    localAuthenticationOptions?: LocalAuthenticationOptions
    clientId: string

    Your Auth0 application's client ID.

    timeout?: number
    headers?: Record<string, string>
    useDPoP?: boolean

    Enables DPoP (Demonstrating Proof-of-Possession) for enhanced token security. When enabled, access and refresh tokens are cryptographically bound to a client-specific key pair.

    true

    https://datatracker.ietf.org/doc/html/rfc9449

    maxRetries?: number

    The maximum number of retry attempts for transient errors during credential renewal. Helps handle network failures and transient errors when using refresh token rotation. iOS only - This parameter is accepted on Android for API compatibility but has no effect as the Auth0.Android SDK does not currently support retry configuration.

    0 (no retries)

    ios

    cacheLocation?: "memory" | "localstorage"

    How and where to cache session data. Defaults to memory.

    useRefreshTokens?: boolean

    Enables the use of refresh tokens for silent authentication.

    useRefreshTokensFallback?: boolean

    Fallback to iframe-based token retrieval if refresh token fails.

    true
    audience?: string

    A custom audience for the getTokenSilently call.

    scope?: string

    A custom scope for the getTokenSilently call.

    useMrrt?: boolean

    Web only: Enables the use of Multi-Resource Refresh Tokens (MRRT). When enabled, useRefreshTokens is automatically set to true.

    false

    Settings

    Member Visibility

    On This Page

    Properties