@auth0/auth0-react
    Preparing search index...

    Interface AnonymousSessionApiClient

    Browser-layer wrapper around auth0-auth-js AnonymousSessionClient.

    Adds local session storage (localStorage or memory) so callers never need to manage the session token themselves. getTokenSilently() returns a cached access token when still valid and renews it transparently when expired.

    The session token is stored once and shared across all audience/scope slots. Each slot stores only its own access token and expiry.

    Exposed on Auth0Client as auth0.anonymous.

    interface AnonymousSessionApiClient {
        createSession(
            options?: CreateAnonymousSessionOptions,
        ): Promise<AnonymousSession>;
        getClaims(): null;
        getTokenSilently(
            options?: AnonymousGetTokenSilentlyOptions,
        ): Promise<AnonymousTokenResult>;
        hasSession(): boolean;
        logout(): Promise<void>;
        mintTransferToken(): Promise<string | null>;
    }
    Index
    createSession getClaims getTokenSilently hasSession logout mintTransferToken

    • Always returns null in EA — session tokens are issued as opaque JWEs and cannot be decoded client-side. Reserved for future JWT format support.

      Returns null

    • Returns a valid anonymous access token, renewing it when expired.

      If the stored access token is still fresh (more than 60 s remaining), it is returned directly without a network call. Otherwise the session token is used to re-mint the access token. If the session token has also expired, the local cache is cleared and an AnonymousSessionError with code session_expired is thrown — call createSession() to start a new session.

      Parameters

      Returns Promise<AnonymousTokenResult>

      with code session_expired if the session token has expired.

    • Returns true if a session token exists in the local cache.

      Returns boolean

    • Ends the anonymous session and clears all locally stored tokens.

      Returns Promise<void>

    • Mints a short-lived transfer ticket (30s single-use JWE) for linking the anonymous session during loginWithRedirect(). Returns null if no session is active or the request fails — callers must never be blocked from login.

      Returns Promise<string | null>

    Settings
    Member Visibility

    On This Page
    Methods