UsernamePlugin<TContext> class final

Opt-in username-first password authentication.

Implemented types

Constructors

UsernamePlugin({AuthUsernameIdentifierPolicy? identifierPolicy, String authenticationMethod = authUsernameAuthenticationMethod}): Creates a username-first authentication plugin.

authenticationMethod → String: Authentication-method identifier emitted by this plugin.
final
authenticationMethodKinds → Set<AuthAuthenticationMethodKind>: Method kinds that this store can report authoritatively.
no setteroverride
authenticationMethodNamespace → String: Stable namespace owned by this contributor.
no setteroverride
authenticationMethodStore → Object: Store or coordinator that owns this contributor's method data.
no setteroverride
clientOperations → Iterable<AuthClientOperationDescriptor>: Client operations declared by the plugin.
no setteroverride
dataContract → AuthServerPluginDataContract: Declares data and destructive routes owned by this plugin.
no setteroverride
endpoints → Iterable<AuthEndpointDescriptor<TContext>>: Runtime endpoints contributed by the plugin.
no setteroverride
hashCode → int: The hash code for this object.
no setterinherited
id → String: Stable plugin identifier.
no setteroverride
identifierPolicy → AuthUsernameIdentifierPolicy: Rules used to canonicalize username and email identifiers.
final
persistenceSchemas → Iterable<AuthPersistenceSchema>: Persistence schemas declared by the plugin.
no setteroverride
rateLimitOperations → Iterable<AuthRateLimitOperation>: Rate-limit operations declared by the plugin.
no setteroverride
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

authenticationMethodsForUser(String userId) → Future<AuthAuthenticationMethodSnapshot>: Returns the usable methods for userId.
override
changeUsername({required String userId, required AuthUsernameChangeRequest request, DateTime? now}) → Future<AuthUsernameChangeResult>: Changes the username owned by userId.
composePluginTopology(Iterable<AuthServerPlugin<TContext>> plugins) → void: Composes this plugin with the complete registered plugin topology.
override
configure(AuthServerPluginContext<TContext> context) → void: Configures this plugin against the shared runtime context.
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
register({required TContext context, required AuthUsernameRegistrationRequest request, AuthServerPluginSessionControl? sessionControl}) → Future<AuthUsernameAuthenticationResult>: Registers a username credential and returns its new user.
removeUsername({required String userId}) → Future<void>: Removes the username credential owned by userId.
signIn({required TContext context, required AuthUsernameSignInRequest request, AuthServerPluginSessionControl? sessionControl}) → Future<AuthUsernameAuthenticationResult>: Authenticates a username or email identifier.
toString() → String: A string representation of this object.
inherited