DescopePasskey class abstract

Authenticate users using passkeys.

The authentication operations in this class are all async functions that perform network requests before and after displaying the modal authentication view. It is thus recommended to switch the user interface to a loading state before calling these functions, otherwise the user might accidentally interact with the app when the authentication view is not being displayed.

Important: Some set up is required before authentication with passkeys is possible.

  • For Android, please follow the Add support for Digital Asset Links setup, as described in the official Google docs.
  • For iOS, go through Apple's Supporting passkeys guide, in particular be sure to have an associated domain configured for your app with the webcredentials service type, whose value matches the top level domain you configured in the Descope console earlier.

Constructors

DescopePasskey()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

add({required String loginId, required String refreshJwt}) Future<void>
Updates an existing user by adding a new passkey as an authentication method.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
signIn({required String loginId, SignInOptions? options}) Future<AuthenticationResponse>
Authenticates an existing user by prompting for an existing passkey.
signUp({required String loginId, SignUpDetails? details}) Future<AuthenticationResponse>
Authenticates a new user by creating a new passkey.
signUpOrIn({required String loginId, SignInOptions? options}) Future<AuthenticationResponse>
Authenticates an existing user if one exists or creates a new one.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited