auth0_flutter_platform_interface library

Classes

Account
ActorToken
Represents the acting party in a Custom Token Exchange delegation or impersonation flow (RFC 8693 actor_token / actor_token_type).
AndroidCredentialsConfiguration
Configuration options for the Android platform that can be set while instantiating the CredentialsManager.
ApiCredentials
User's credentials obtained from Auth0 for a specific API (audience) as the result of exchanging the stored refresh token using a Multi-Resource Refresh Token (MRRT).
ApiRequest<TOptions extends RequestOptions>
Auth0FlutterAuthPlatform
Auth0FlutterDPoPPlatform
Platform interface for DPoP (Demonstrating Proof-of-Possession) operations.
Auth0FlutterMfaPlatform
Auth0FlutterMyAccountPlatform
Auth0FlutterWebAuthPlatform
Auth0FlutterWebPlatform
AuthCustomTokenExchangeOptions
AuthDPoPHeadersOptions
AuthenticationMethod
AuthLoginOptions
AuthLoginWithCodeOptions
AuthPasskeyExchangeOptions
AuthPasskeyLoginChallengeOptions
AuthPasskeySignupChallengeOptions
AuthPasswordlessChallengeEmailOptions
AuthPasswordlessChallengePhoneOptions
AuthPasswordlessLoginOptions
AuthPasswordlessLoginWithOtpOptions
AuthRenewOptions
AuthResetPasswordOptions
AuthSignupOptions
AuthSSOExchangeOptions
Options used to call Auth0FlutterAuthPlatform.ssoExchange().
AuthUserInfoOptions
BaseRequest<TOptions extends RequestOptions?>
ClearApiCredentialsOptions
Options used to remove the stored API credentials for a given audience via CredentialsManagerPlatform.clearApiCredentials().
ClientOptions
The options for the underlying SDK on the web platform.
Credentials
A collection of authentication artifacts obtained from Auth0 when a user logs in.
CredentialsManagerConfiguration
Class used to set platform-specific configuration for CredentialsManager in the SDK.
CredentialsManagerPlatform
The interface that implementations of CredentialsManager must implement.
CredentialsManagerRequest<TOptions extends RequestOptions?>
CredentialsOptions
CustomTabsOptions
Configuration for using Chrome Custom Tabs on Android.
DatabaseUser
DPoPHeaders
DPoPRequest<TOptions>
Request object for DPoP utility operations.
EmptyRequestOptions
EnrollmentChallenge
ExchangeTokenOptions
Options for custom token exchange on web platforms.
Factor
GetApiCredentialsOptions
Options used to retrieve ApiCredentials via CredentialsManagerPlatform.getApiCredentials().
GetCredentialsOptions
Options used to retrieve Credentials using the CredentialsManagerPlatform.
GetSSOCredentialsOptions
Options used to retrieve SSOCredentials via CredentialsManagerPlatform.getSSOCredentials().
HasValidCredentialsOptions
Options used to check if a non-expired pair of Credentials can be obtained using the CredentialsManagerPlatform.
IdTokenValidationConfig
Configuration settings for ID token validation.
IOSCredentialsConfiguration
Configuration options for the iOS platform that can be set while instantiating the CredentialsManager. It can be used to set the keychain store key,access group and accessibility level for the stored credentials.
LocalAuthentication
Settings for local authentication prompts.
LoginOptions
LogoutOptions
MethodChannelAuth0FlutterAuth
MethodChannelAuth0FlutterDPoP
Method channel implementation of Auth0FlutterDPoPPlatform.
MethodChannelAuth0FlutterMfa
MethodChannelAuth0FlutterMyAccount
MethodChannelAuth0FlutterWebAuth
MethodChannelCredentialsManager
Method Channel implementation to communicate with the Native CredentialsManager
MfaAuthenticator
An MFA authenticator enrolled by the user, as returned by MfaApi.getAuthenticators.
MfaChallenge
The result of initiating an MFA challenge via MfaApi.challenge.
MfaChallengeOptions
Options for requesting an MFA challenge against an enrolled authenticator.
MfaEnrollEmailOptions
Options for enrolling a new email-based out-of-band factor.
MfaEnrollmentChallenge
The result of initiating an MFA enrollment via one of the MfaApi.enroll* methods.
MfaEnrollPhoneOptions
Options for enrolling a new phone-based out-of-band (SMS) factor.
MfaEnrollPushOptions
Options for enrolling a new push-notification factor (Guardian app).
MfaEnrollTotpOptions
Options for enrolling a new TOTP (authenticator app) factor.
MfaFactor
A single MFA factor referenced in an mfa_required error's requirements, e.g. otp, phone, email, push-notification, recovery-code.
MfaGetAuthenticatorsOptions
Options for listing the MFA authenticators enrolled for the user associated with an mfa_token.
MfaRequirements
The factors a user can use or enroll, parsed from the mfa_requirements field of an mfa_required error.
MfaVerifyOptions
Options for verifying an MFA challenge and exchanging it for credentials.
MyAccountConfirmEnrollmentOptions
MyAccountDeleteAuthMethodOptions
MyAccountEnrollEmailOptions
MyAccountEnrollPasskeyChallengeOptions
MyAccountEnrollPasskeyOptions
MyAccountEnrollPhoneOptions
MyAccountEnrollPushOptions
MyAccountEnrollRecoveryCodeOptions
MyAccountEnrollTotpOptions
MyAccountGetAuthMethodOptions
MyAccountGetAuthMethodsOptions
MyAccountGetFactorsOptions
MyAccountGetUserProfileOptions
MyAccountPasskeyAuthenticationMethod
An enrolled passkey authentication method returned by the My Account API.
MyAccountProfile
The current user's profile, as returned by the My Account API /me/v1/profile endpoint.
MyAccountUpdateAuthMethodOptions
MyAccountUpdateUserProfileOptions
MyAccountValidationError
A server-side validation error returned by the My Account API, typically on a 400 response. See MyAccountException.validationErrors.
MyAccountVerifyOtpOptions
PasskeyAuthenticatorResponse
The authenticator's response within a PasskeyCredential.
PasskeyChallenge
A challenge issued by Auth0 to begin a passkey ceremony.
PasskeyCredential
A passkey credential obtained from the platform authenticator.
PasskeyEnrollmentChallenge
A challenge issued by the My Account API to begin a passkey enrollment ceremony.
PasswordlessChallenge
A challenge issued by Auth0 when starting a passwordless OTP flow against a database connection.
PopupLoginOptions
ProfileFieldPolicy
Describes whether a profile field can be edited by the user and why.
RenewCredentialsOptions
Options to renew Credentials using the CredentialsManagerPlatform.
SafariViewController
Configuration for using SFSafariViewController on iOS.
SaveCredentialsOptions
Options used to save Credentials using the CredentialsManagerPlatform.
SSOCredentials
Authentication artifacts used to establish a web session from a native application context (Native to Web SSO).
StubAuth0FlutterWeb
UserActor
Represents the act (actor) claim from an ID token issued during a Custom Token Exchange delegation or impersonation flow.
UserAgent
UserProfile
A collection of properties that represents the authenticated user, extracted from ID token claims.
WebAuthLoginOptions
WebAuthLogoutOptions
WebAuthRequest<TOptions extends RequestOptions>
WebGetTokenByPasskeyOptions
Options for exchanging a passkey credential response for Auth0 tokens on the web platform.
WebPasskeyChallenge
A passkey challenge issued by Auth0 on the web platform.
WebPasskeyLoginChallengeOptions
Options for requesting a passkey login challenge on the web platform.
WebPasskeySignupChallengeOptions
Options for requesting a passkey signup challenge on the web platform.
WindowsWebAuthLoginOptions
Options for performing PKCE-based login via Universal Login on Windows.
WindowsWebAuthLogoutOptions
Options for performing logout via Universal Login on Windows.

Enums

Accessibility
The accessibility level for the credentials on iOS.
AuthenticationMethodType
The type of authentication method, used to filter results when listing authentication methods via getAuthenticationMethods.
CacheLocation
The location where cached data is stored by the underlying SDK on the web platform.
CacheMode
How the cache is to be used when requesting new tokens silently.
DeliveryMethod
How a passwordless OTP is delivered when challenging with a phone number.
LocalAuthenticationLevel
The level of authentication required.
MfaVerifyGrantType
The kind of credential being verified, which determines the MFA grant type used in the token exchange.
PasskeyVerificationMethod
An identifier whose ownership must be verified with a one-time code before a passkey signup can complete.
PasswordlessType
Types of passwordless authentication.
PhoneType
ProfileFieldAccess
Whether a profile field can be edited by the user.
ProfileFieldSource
Where a profile field's value comes from.
SafariViewControllerPresentationStyle
Presentation styles for when using SFSafariViewController on iOS. For the full description of what each option does, please see the UIModelPresentationStyle docs.

Constants

authCustomTokenExchangeMethod → const String
authLoginMethod → const String
authLoginWithEmailCodeMethod → const String
authLoginWithSmsCodeMethod → const String
authPasskeyCredentialExchangeMethod → const String
authPasskeyLoginChallengeMethod → const String
authPasskeySignupChallengeMethod → const String
authPasswordlessChallengeWithEmailMethod → const String
authPasswordlessChallengeWithPhoneNumberMethod → const String
authPasswordlessLoginWithOtpMethod → const String
authRenewMethod → const String
authResetPasswordMethod → const String
authSignUpMethod → const String
authSSOExchangeMethod → const String
authStartPasswordlessWithEmailMethod → const String
authStartPasswordlessWithPhoneNumberMethod → const String
authUserInfoMethod → const String
cancelMethod → const String
credentialsManagerClearAllMethod → const String
credentialsManagerClearApiCredentialsMethod → const String
credentialsManagerClearCredentialsMethod → const String
credentialsManagerGetApiCredentialsMethod → const String
credentialsManagerGetCredentialsMethod → const String
credentialsManagerGetSSOCredentialsMethod → const String
credentialsManagerGetUserProfileMethod → const String
credentialsManagerHasValidCredentialsMethod → const String
credentialsManagerRenewCredentialsMethod → const String
credentialsManagerSaveCredentialsMethod → const String
dpopClearKeyMethod → const String
dpopGetHeadersMethod → const String
loginMethod → const String
logoutMethod → const String
mfaChallengeMethod → const String
mfaEnrollEmailMethod → const String
mfaEnrollPhoneMethod → const String
mfaEnrollPushMethod → const String
mfaEnrollTotpMethod → const String
mfaGetAuthenticatorsMethod → const String
mfaVerifyMethod → const String
myAccountConfirmEnrollmentMethod → const String
myAccountDeleteAuthMethodMethod → const String
myAccountEnrollEmailMethod → const String
myAccountEnrollPasskeyChallengeMethod → const String
myAccountEnrollPasskeyMethod → const String
myAccountEnrollPhoneMethod → const String
myAccountEnrollPushMethod → const String
myAccountEnrollRecoveryCodeMethod → const String
myAccountEnrollTotpMethod → const String
myAccountGetAuthMethodMethod → const String
myAccountGetAuthMethodsMethod → const String
myAccountGetFactorsMethod → const String
myAccountGetUserProfileMethod → const String
myAccountUpdateAuthMethodMethod → const String
myAccountUpdateUserProfileMethod → const String
myAccountVerifyOtpMethod → const String

Exceptions / Errors

ApiException
Auth0Exception
CredentialsManagerException
Exception thrown by MethodChannelCredentialsManager when something goes wrong.
MfaException
An error raised by an MFA operation (getAuthenticators, enroll*, challenge, verify).
MyAccountException
WebAuthenticationException
WebException
Exception thrown by Auth0FlutterWebPlatform when something goes wrong.