Account class
The Account service allows you to authenticate and manage a user account.
Properties
Methods
-
create(
{required String userId, required String email, required String password, String? name}) → Future< User> - Create account
-
createAnonymousSession(
) → Future< Session> - Create anonymous session
-
createEmailPasswordSession(
{required String email, required String password}) → Future< Session> - Create email password session
-
createEmailToken(
{required String userId, required String email, bool? phrase}) → Future< Token> - Create email token (OTP)
-
createJWT(
) → Future< Jwt> - Create JWT
-
createMagicURLToken(
{required String userId, required String email, String? url, bool? phrase}) → Future< Token> - Create magic URL token
-
createMfaAuthenticator(
{required AuthenticatorType type}) → Future< MfaType> - Create Authenticator
-
createMfaChallenge(
{required AuthenticationFactor factor}) → Future< MfaChallenge> - Create MFA Challenge
-
createMfaRecoveryCodes(
) → Future< MfaRecoveryCodes> - Create MFA Recovery Codes
-
createOAuth2Token(
{required OAuthProvider provider, String? success, String? failure, List< String> ? scopes}) → Future - Create OAuth2 token
-
createPhoneToken(
{required String userId, required String phone}) → Future< Token> - Create phone token
-
createPhoneVerification(
) → Future< Token> - Create phone verification
-
createRecovery(
{required String email, required String url}) → Future< Token> - Create password recovery
-
createSession(
{required String userId, required String secret}) → Future< Session> - Create session
-
createVerification(
{required String url}) → Future< Token> - Create email verification
-
deleteIdentity(
{required String identityId}) → Future - Delete identity
-
deleteMfaAuthenticator(
{required AuthenticatorType type}) → Future - Delete Authenticator
-
deleteSession(
{required String sessionId}) → Future - Delete session
-
deleteSessions(
) → Future - Delete sessions
-
get(
) → Future< User> - Get account
-
getMfaRecoveryCodes(
) → Future< MfaRecoveryCodes> - Get MFA Recovery Codes
-
getPrefs(
) → Future< Preferences> - Get account preferences
-
getSession(
{required String sessionId}) → Future< Session> - Get session
-
listIdentities(
{List< String> ? queries}) → Future<IdentityList> - List Identities
-
listLogs(
{List< String> ? queries}) → Future<LogList> - List logs
-
listMfaFactors(
) → Future< MfaFactors> - List Factors
-
listSessions(
) → Future< SessionList> - List sessions
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateEmail(
{required String email, required String password}) → Future< User> - Update email
-
updateMagicURLSession(
{required String userId, required String secret}) → Future< Session> - Update magic URL session
-
updateMFA(
{required bool mfa}) → Future< User> - Update MFA
-
updateMfaAuthenticator(
{required AuthenticatorType type, required String otp}) → Future< User> - Verify Authenticator
-
updateMfaChallenge(
{required String challengeId, required String otp}) → Future - Create MFA Challenge (confirmation)
-
updateMfaRecoveryCodes(
) → Future< MfaRecoveryCodes> - Regenerate MFA Recovery Codes
-
updateName(
{required String name}) → Future< User> - Update name
-
updatePassword(
{required String password, String? oldPassword}) → Future< User> - Update password
-
updatePhone(
{required String phone, required String password}) → Future< User> - Update phone
-
updatePhoneSession(
{required String userId, required String secret}) → Future< Session> - Update phone session
-
updatePhoneVerification(
{required String userId, required String secret}) → Future< Token> - Update phone verification (confirmation)
-
updatePrefs(
{required Map prefs}) → Future< User> - Update preferences
-
updateRecovery(
{required String userId, required String secret, required String password}) → Future< Token> - Create password recovery (confirmation)
-
updateSession(
{required String sessionId}) → Future< Session> - Update session
-
updateStatus(
) → Future< User> - Update status
-
updateVerification(
{required String userId, required String secret}) → Future< Token> - Create email verification (confirmation)
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited