descope library
A package that provides convenient access to the Descope user management and authentication APIs for Flutter apps.
Classes
- AuthenticationResponse
- Returned from user authentication calls.
- Descope
- Provides functions for working with the Descope API.
- DescopeAuth
- General authentication functions
- DescopeConfig
- The configuration of the Descope SDK.
- DescopeEnchantedLink
- Authenticate users using one of three special links that once clicked, can authenticate the user.
- DescopeFlow
- Authenticate a user using a flow.
- DescopeFlowOptions
- Options to control how a flow runs
- DescopeLogger
- The DescopeLogger class can be used to customize logging functionality in the Descope SDK.
- DescopeMagicLink
- Authenticate users using a special link that once clicked, can authenticate the user.
- DescopeMobileFlowOptions
- Options to run a mobile flow
- DescopeNetworkClient
- The DescopeNetworkClient abstract class can be used to override how HTTP requests are performed by the SDK when calling the Descope server.
- DescopeOAuth
- Authenticate a user using an OAuth provider.
- DescopeOtp
- Authenticate users using a one time password (OTP) code, sent via a delivery method of choice. The code then needs to be verified using the verify function. It is also possible to add an email or phone to an existing user after validating it via OTP.
- DescopePasskey
- Authenticate users using passkeys.
- DescopePassword
- Authenticate users using a password.
- DescopeSdk
- Provides functions for working with the Descope API.
- DescopeSession
-
The
DescopeSessionclass represents a successful sign in operation. - DescopeSessionLifecycle
-
This abstract class can be used to customize how a
DescopeSessionManagerobject manages its DescopeSession while the application is running. - DescopeSessionStorage
-
This abstract class can be used to customize how a
DescopeSessionManagerobject stores the active DescopeSession between application launches. - DescopeSso
- Authenticate a user using SSO.
- DescopeToken
- A DescopeToken is a utility wrapper around a single JWT value.
- DescopeTotp
- Authenticate users using Timed One-time Passwords (TOTP) codes.
- DescopeUser
- The DescopeUser class represents an existing user in Descope.
- DescopeWebFlowOptions
- Options to run a web flow
- EnchantedLinkResponse
- Returned from calls that start an enchanted link flow.
- OAuthProvider
- The provider to use in an OAuth flow.
- PasswordPolicy
- Represents the rules for valid passwords.
- RefreshResponse
- Returned from the refreshSession call.
- SessionLifecycle
- The default implementation of the DescopeSessionLifecycle interface.
- SessionStorage
- The default implementation of the DescopeSessionStorage.
- SessionStorageStore
-
A helper class that takes care of the actual storage of session data. The default
function implementations in this class do nothing or return
null. - SignInOptions
- Used to require additional behaviors when authenticating a user.
- SignUpDetails
- Used to provide additional details about a user in sign up calls.
- TotpResponse
- Returned from TOTP calls that create a new seed.
- UpdateOptions
- Used to configure how users are updated.
Enums
- DeliveryMethod
- The delivery method for an OTP or Magic Link message.
Extensions
- AddAuthorization on Request
Exceptions / Errors
- DescopeException
-
The concrete type of
Exceptionthrown by all operations in the Descope SDK.