Auth0 SPA SDK

Index

Getting Started

createAuth0Client

Clients

AnonymousSessionApiClient Auth0Client Fetcher MfaApiClient MyAccountApiClient PasskeyApiClient

Configuration

Auth0ClientOptions AuthorizationParams ClientAuthorizationParams ClientConfiguration CacheLocation InteractiveErrorHandler RefreshTokenMode RefreshTokenMode

Login & Logout

LogoutOptions LogoutUrlOptions PopupConfigOptions PopupLoginOptions RedirectConnectAccountOptions RedirectLoginOptions RedirectLoginResult ConnectAccountRedirectResult ResponseType

Tokens & Users

User ActClaim GetTokenSilentlyOptions GetTokenWithPopupOptions IdToken RevokeRefreshTokenOptions AnonymousGetTokenSilentlyOptions CustomFetchMinimalOutput CustomTokenExchangeOptions FetcherConfig GetTokenSilentlyVerboseResponse TokenEndpointResponse

Errors

AnonymousSessionError AuthenticationError ConnectError GenericError InvalidConfigurationError MfaRequiredError MissingRefreshTokenError MissingScopesError PasskeyChallengeError PasskeyGetTokenError PasskeyRegisterError PasskeyVerificationRequiredError PopupCancelledError PopupOpenError PopupTimeoutError TimeoutError UseDpopNonceError MfaRequirements AnonymousSessionErrorCode

Other

isFederatedDomain AnonymousSessionClient CacheKey InMemoryCache LocalStorageCache MfaChallengeError MfaEnrollmentError MfaEnrollmentFactorsError MfaError MfaListAuthenticatorsError MfaVerifyError MyAccountApiError PasskeyError AnonymousSession AnonymousSessionClaims Authenticator ChallengeAuthenticatorParams ChallengeResponse CompleteRequest CompleteResponse ConnectRequest ConnectResponse CreateAnonymousSessionOptions DecodedToken EmailAuthenticationMethod EmailEnrollmentChallengeOptions EmailEnrollmentChallengeResponse EmailEnrollmentVerifyOptions EnrollEmailParams EnrollOtpParams EnrollPushParams EnrollSmsParams EnrollVoiceParams EnrollmentFactor ErrorResponse Factor GetAnonymousAccessTokenOptions GetUserProfileOptions ICache IsFederatedDomainOptions OobEnrollmentResponse OtpEnrollmentResponse PasskeyAuthenticationMethod PasskeyCreationOptions PasskeyCredentialResponse PasskeyEnrollmentChallengeOptions PasskeyEnrollmentChallengeResponse PasskeyEnrollmentVerifyOptions PasskeyErrorResponse PasskeyLoginChallengeOptions PasskeyLoginChallengeResponse PasskeyRequestOptions PasskeySignupChallengeResponse PasswordAuthenticationMethod PasswordEnrollmentChallengeOptions PasswordEnrollmentChallengeResponse PasswordEnrollmentVerifyOptions PasswordPolicy PhoneAuthenticationMethod PhoneEnrollmentChallengeOptions PhoneEnrollmentChallengeResponse PhoneEnrollmentVerifyOptions ProfileFieldPolicy PushNotificationAuthenticationMethod PushNotificationEnrollmentChallengeOptions PushNotificationEnrollmentChallengeResponse PushNotificationEnrollmentVerifyOptions RecoveryCodeAuthenticationMethod RecoveryCodeEnrollmentChallengeOptions RecoveryCodeEnrollmentChallengeResponse RecoveryCodeEnrollmentVerifyOptions TotpAuthenticationMethod TotpEnrollmentChallengeOptions TotpEnrollmentChallengeResponse TotpEnrollmentVerifyOptions UpdateAuthenticationMethodRequest UpdateUserProfileRequest UserProfile VerifyParams WebAuthnPlatformAuthenticationMethod WebAuthnRoamingAuthenticationMethod AuthenticationMethod AuthenticationMethodType AuthenticatorType CacheEntry CacheKeyData Cacheable EnrollParams EnrollmentChallengeOptions EnrollmentChallengeResponse EnrollmentResponse EnrollmentVerifyOptions KeyManifestEntry MaybePromise MfaFactorType MfaGrantType OobChannel PasskeyGetTokenOptions PasskeyLoginChallenge PasskeyLoginOptions PasskeySignupChallenge PasskeySignupChallengeOptions PasskeySignupOptions WrappedCacheEntry

Settings

Member Visibility

Theme