auth0_dart_auth_sdk library
Classes
- Auth0AcceptRequestRequest
- Represents a request to accept a passwordless login request via Auth0's magic link.
- Auth0AcceptRequestResponse
- Represents the response from accepting a passwordless authentication request.
- Auth0AddAuthenticatorRequest
- Represents a request to add a new authenticator for Multi-Factor Authentication (MFA) in Auth0's authentication system.
- Auth0AddAuthenticatorResponse
- Response model for adding an authenticator to Auth0.
- Auth0AuthenticateUser
- Handles user authentication with Auth0.
- Auth0AuthenticateUserRequest
- Represents the request payload for authenticating a user via Auth0's Resource Owner Password Grant (password-based authentication).
- Auth0AuthenticateUserResponse
- Represents the response returned after a successful Auth0 user authentication.
- Auth0Authenticator
- Represents a Multi-Factor Authentication (MFA) authenticator registered in Auth0.
- Auth0AuthorizeApplicationBuilder
- A utility class to build an Auth0 authorization URL.
- Auth0AuthorizeApplicationClientRegisterRequest
- A request model containing parameters needed to generate an Auth0 authorization URL.
- Auth0AuthorizeApplicationClientRegisterResponse
- A response model representing the Auth0 application authorization URL.
- Auth0AuthorizeApplicationRequest
- A request model representing parameters required to initiate an Auth0 authorization code flow or other OAuth 2.0 flows.
- Auth0AuthorizeApplicationResponse
- A response model containing the full authorization URL used to initiate an OAuth 2.0 or OpenID Connect flow with Auth0.
- Auth0AuthorizeApplicationService
- A service class responsible for building Auth0 Authorization URLs for initiating OAuth2/OIDC login flows.
- Auth0AuthorizeEndpoint
-
A service class for generating Auth0
/authorizeendpoint URLs. - Auth0AuthorizeEndpointRequest
- Represents a request to Auth0's OAuth 2.0/OpenID Connect authorization endpoint.
- Auth0AuthorizeEndpointResponse
- Represents the response containing the constructed authorization URL for Auth0's OAuth 2.0/OpenID Connect flow.
- Auth0BackChannelLogin
- A class to handle back-channel login with Auth0.
- Auth0BackChannelLoginRequest
- Represents the request payload used for initiating a back-channel login flow with Auth0.
- Auth0BackChannelLoginResponse
- Represents the response received after initiating a back-channel login request with Auth0.
- Auth0ChallengeRequest
- Represents a request to initiate a multi-factor authentication (MFA) challenge with Auth0's authentication service.
- Auth0ChallengeResponse
- Represents the response from an Auth0 MFA challenge initiation request.
- Auth0ChangePassword
- A service class for handling password change requests with Auth0.
- Auth0ChangePasswordRequest
- Represents a request to change a user's password in Auth0.
- Auth0ChangePasswordResponse
- Represents the response received from Auth0 after a password change request.
- Auth0DatabaseAdLdapPassive
- Handles passive authentication using Database, Active Directory (AD), or LDAP connections with Auth0.
- Auth0DatabaseAdLdapPassiveRequest
- Represents the request payload for passive authentication via Auth0 using database, Active Directory (AD), or LDAP connections.
- Auth0DatabaseAdLdapPassiveResponse
- Represents the response from passive authentication
- Auth0DeleteAuthenticatorClient
- Client for deleting MFA (Multi-Factor Authentication) authenticators from Auth0.
- Auth0DeleteAuthenticatorRequest
- Represents a request to delete a Multi-Factor Authentication (MFA) authenticator from an Auth0 user account.
- Auth0DeleteAuthenticatorResponse
- Represents the response from deleting an MFA (Multi-Factor Authentication) authenticator.
- Auth0EnterpriseSaml
- Main service class to handle Auth0 enterprise SAML authentication flows.
- Auth0EnterpriseSamlRequest
- Represents the parameters needed to start an enterprise SAML login flow.
- Auth0EnterpriseSamlResponse
- Represents the result of the enterprise SAML login flow after Auth0 redirect.
- Auth0GetCodeOrLink
- Handles the process of sending a passwordless authentication code or link using Auth0.
- Auth0GetCodeOrLinkRequest
- Represents the request payload to initiate a code or link-based authentication flow with Auth0.
- Auth0GetCodeOrLinkResponse
- Represents the response from a request to initiate code or link-based authentication flow with Auth0.
- Auth0GetMetadata40Request
-
Represents the request for fetching metadata from the Auth0
/metadata40endpoint. - Auth0GetMetadata40Response
-
Represents the response from the Auth0
/metadata40endpoint. - Auth0GetUserInfoRequest
- Represents a request to fetch user information from Auth0's /userinfo endpoint.
- Auth0GetUserInfoResponse
- Represents the user information response from Auth0's /userinfo endpoint.
- Auth0GlobalTokenRevocation
- A service for handling global token revocation via Auth0.
- Auth0GlobalTokenRevocationRequest
- Represents a request to revoke a token globally across an Auth0 tenant
- Auth0GlobalTokenRevocationResponse
- Represents the response from a request to globally revoke a token with Auth0.
- Auth0IdpInitiatedSSOFlowRequest
- Model for the request to build an IdP Initiated SSO Flow URL.
- Auth0IdpInitiatedSSOFlowResponse
- Model for the response containing the constructed SSO URL.
- Auth0ListAuthenticators
- A client for listing multi-factor authentication (MFA) authenticators from Auth0.
- Auth0ListAuthenticatorsRequest
- Represents a request to list a user's MFA (Multi-Factor Authentication) authenticators from Auth0.
- Auth0ListAuthenticatorsResponse
- Represents the response from listing a user's MFA (Multi-Factor Authentication) authenticators.
- Auth0LoginRequest
- Encapsulates all parameters needed for an Auth0 authentication request.
- Auth0LoginResponse
- Contains all tokens and metadata returned from a successful Auth0 authentication.
- Auth0LoginService
- Service for authenticating users with Auth0's OAuth 2.0 token endpoint.
- Auth0Logout
- A service for handling Auth0 user logout.
- Auth0LogoutRequest
- Represents the logout request payload for Auth0.
- Auth0LogoutResponse
- Represents the response containing the generated Auth0 logout URL.
- Auth0MfaAddAuthenticator
- A client for interacting with Auth0's Multi-Factor Authentication (MFA) API endpoints.
- Auth0MfaApiClient
- Client for interacting with Auth0's MFA/recovery API endpoints
- Auth0MfaVerifyOob
- A service class responsible for handling Multi-Factor Authentication (MFA) verification using Out-of-Band (OOB) mechanisms with Auth0.
- Auth0MfaVerifyOpt
- A service that handles OTP (One-Time Password) verification using Auth0's MFA endpoint.
- Auth0MultiFactorService
- A service for handling multi-factor authentication (MFA) operations with Auth0.
- Auth0MultiFactorVerifyRequest
- Represents a request to verify a multi-factor authentication (MFA) challenge with Auth0.
- Auth0MultiFactorVerifyResponse
- Represents the successful response from verifying a multi-factor authentication (MFA) challenge with Auth0.
- Auth0OidcLogout
- Provides OpenID Connect (OIDC) compliant logout functionality for Auth0.
- Auth0OidcLogoutRequest
- Represents the request payload for OIDC logout via Auth0.
- Auth0SamlLogout
- A service class that handles SAML logout functionality through Auth0.
- Auth0SamlLogoutRequest
- Represents the request payload for a SAML logout operation via Auth0.
- Auth0SamlLogoutResponse
- Represents the response containing the generated SAML logout URL.
- Auth0Signup
- A service for handling user signups via Auth0.
- Auth0SignupRequest
- Represents the request payload for signing up a new user in Auth0.
- Auth0SignupResponse
- Represents the response from a signup request in Auth0.
- Auth0SocialLogin
- Handles social login authentication with Auth0.
- Auth0UserProfile
- A class to interact with the Auth0 UserInfo endpoint to retrieve user profile information.
- Auth0UserProfileRequest
- Represents the request model to retrieve a user profile from Auth0.
- Auth0UserProfileResponse
- Represents the user profile response returned by Auth0.
- AuthOMultifactorChallengeRequest
- A service class for initiating Multi-Factor Authentication (MFA) challenges with Auth0's authentication service.
Functions
-
auth0GetMetadata40(
{required Uri auth0DomainUri, required Auth0GetMetadata40Request request, Client? client}) → Future< Auth0GetMetadata40Response> -
Fetches metadata from the Auth0
/metadata40endpoint using the providedaccessToken. -
auth0GetToken(
{required String domain, required Auth0GetTokenRequest request, Client? client}) → Future< Auth0GetTokenResponse> - Requests an authentication token from Auth0's OAuth 2.0 token endpoint.
-
auth0GetUserInfo(
{required String domain, required Auth0GetUserInfoRequest request, Duration timeout = const Duration(seconds: 10)}) → Future< Auth0GetUserInfoResponse> - Fetches user information from Auth0 using the /userinfo endpoint.
-
Auth0IdpInitiatedSSOFlow(
{required Uri auth0DomainUri, required Auth0IdpInitiatedSSOFlowRequest request}) → Auth0IdpInitiatedSSOFlowResponse - Constructs a URL for an Identity Provider (IdP) initiated Single Sign-On (SSO) flow.
Exceptions / Errors
- Auth0AcceptRequestException
- Exception thrown when accepting a passwordless authentication request fails.
- Auth0BackChannelLoginException
- Exception thrown when a back-channel login request fails in the Auth0 authentication process.
- Auth0ChallengeException
- An exception thrown when an Auth0 challenge fails during authentication.
- Auth0ChangePasswordException
- An exception thrown when a password change operation with Auth0 fails.
- Auth0DatabaseAdLdapPassiveException
- Exception thrown when passive authentication fails using a database, Active Directory (AD), or LDAP connection during the Auth0 authentication process.
- Auth0DeleteAuthenticatorException
- An exception thrown when an error occurs during the deletion of an MFA (Multi-Factor Authentication) authenticator in Auth0.
- Auth0EnterpriseSamlException
- Exception thrown when enterprise SAML authentication fails in the Auth0 authentication flow.
- Auth0ListAuthenticatorsException
- An exception thrown when an error occurs while listing MFA (Multi-Factor Authentication) authenticators from Auth0.
- Auth0LoginException
- Exception thrown when authentication fails in Auth0LoginService.
- Auth0MultifactorVerifyException
- An exception thrown when multi-factor authentication (MFA) verification fails.
- Auth0SignupException
- Exception thrown when a signup operation fails during the Auth0 authentication process.
- Auth0SocialLoginException
- Exception thrown when social login fails during the Auth0 authentication process.
- Auth0UserInfoException
- An exception thrown when a user info request to Auth0 fails.
- Auth0UserProfileException
- Exception thrown when retrieving or processing the Auth0 user profile fails.