Users class

The Users service allows you to manage your project users.

Constructors

Users(Client client)

Properties

client → Client

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

create({required String userId, String? email, String? phone, String? password, String? name}) → Future<User>

Create user

createArgon2User({required String userId, required String email, required String password, String? name}) → Future<User>

Create user with Argon2 password

createBcryptUser({required String userId, required String email, required String password, String? name}) → Future<User>

Create user with bcrypt password

createMD5User({required String userId, required String email, required String password, String? name}) → Future<User>

Create user with MD5 password

createMfaRecoveryCodes({required String userId}) → Future<MfaRecoveryCodes>

Create MFA Recovery Codes

createPHPassUser({required String userId, required String email, required String password, String? name}) → Future<User>

Create user with PHPass password

createScryptModifiedUser({required String userId, required String email, required String password, required String passwordSalt, required String passwordSaltSeparator, required String passwordSignerKey, String? name}) → Future<User>

Create user with Scrypt modified password

createScryptUser({required String userId, required String email, required String password, required String passwordSalt, required int passwordCpu, required int passwordMemory, required int passwordParallel, required int passwordLength, String? name}) → Future<User>

Create user with Scrypt password

createSession({required String userId}) → Future<Session>

Create session

createSHAUser({required String userId, required String email, required String password, PasswordHash? passwordVersion, String? name}) → Future<User>

Create user with SHA password

createTarget({required String userId, required String targetId, required MessagingProviderType providerType, required String identifier, String? providerId, String? name}) → Future<Target>

Create User Target

createToken({required String userId, int? length, int? expire}) → Future<Token>

Create token

delete({required String userId}) → Future

Delete user

deleteIdentity({required String identityId}) → Future

Delete identity

deleteMfaAuthenticator({required String userId, required AuthenticatorType type}) → Future<User>

Delete Authenticator

deleteSession({required String userId, required String sessionId}) → Future

Delete user session

deleteSessions({required String userId}) → Future

Delete user sessions

deleteTarget({required String userId, required String targetId}) → Future

Delete user target

get({required String userId}) → Future<User>

Get user

getMfaRecoveryCodes({required String userId}) → Future<MfaRecoveryCodes>

Get MFA Recovery Codes

getPrefs({required String userId}) → Future<Preferences>

Get user preferences

getTarget({required String userId, required String targetId}) → Future<Target>

Get User Target

list({List<String>? queries, String? search}) → Future<UserList>

List users

listIdentities({List<String>? queries, String? search}) → Future<IdentityList>

List Identities

listLogs({required String userId, List<String>? queries}) → Future<LogList>

List user logs

listMemberships({required String userId}) → Future<MembershipList>

List user memberships

listMfaFactors({required String userId}) → Future<MfaFactors>

List Factors

listSessions({required String userId}) → Future<SessionList>

List user sessions

listTargets({required String userId, List<String>? queries}) → Future<TargetList>

List User Targets

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 userId, required String email}) → Future<User>

Update email

updateEmailVerification({required String userId, required bool emailVerification}) → Future<User>

Update email verification

updateLabels({required String userId, required List<String> labels}) → Future<User>

Update user labels

updateMfa({required String userId, required bool mfa}) → Future<User>

Update MFA

updateMfaRecoveryCodes({required String userId}) → Future<MfaRecoveryCodes>

Regenerate MFA Recovery Codes

updateName({required String userId, required String name}) → Future<User>

Update name

updatePassword({required String userId, required String password}) → Future<User>

Update password

updatePhone({required String userId, required String number}) → Future<User>

Update phone

updatePhoneVerification({required String userId, required bool phoneVerification}) → Future<User>

Update phone verification

updatePrefs({required String userId, required Map prefs}) → Future<Preferences>

Update user preferences

updateStatus({required String userId, required bool status}) → Future<User>

Update user status

updateTarget({required String userId, required String targetId, String? identifier, String? providerId, String? name}) → Future<Target>

Update User target

Operators

operator ==(Object other) → bool

The equality operator.

inherited