UsernamePlugin<TContext> class final

Opt-in username-first password authentication.

Implemented types

• AuthServerPlugin<TContext>
• AuthServerPluginTopologyAware<TContext>
• AuthEndpointContributor<TContext>
• AuthClientOperationContributor
• AuthPersistenceContributor
• AuthAuthenticationMethodInventoryContributor
• AuthAuthenticationMethodInventoryBinding
• AuthRateLimitContributor

Constructors

UsernamePlugin({AuthUsernameIdentifierPolicy? identifierPolicy, String authenticationMethod = authUsernameAuthenticationMethod})

Creates a username-first authentication plugin.

Properties

authenticationMethod → String

Authentication-method identifier emitted by this plugin.

final

authenticationMethodKinds → Set<AuthAuthenticationMethodKind>

Method kinds that this store can report authoritatively.

no setter, override

authenticationMethodNamespace → String

Stable namespace owned by this contributor.

no setter, override

authenticationMethodStore → Object

Store or coordinator that owns this contributor's method data.

no setter, override

clientOperations → Iterable<AuthClientOperationDescriptor>

Client operations declared by the plugin.

no setter, override

dataContract → AuthServerPluginDataContract

Declares data and destructive routes owned by this plugin.

no setter, override

endpoints → Iterable<AuthEndpointDescriptor<TContext>>

Runtime endpoints contributed by the plugin.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

id → String

Stable plugin identifier.

no setter, override

identifierPolicy → AuthUsernameIdentifierPolicy

Rules used to canonicalize username and email identifiers.

final

persistenceSchemas → Iterable<AuthPersistenceSchema>

Persistence schemas declared by the plugin.

no setter, override

rateLimitOperations → Iterable<AuthRateLimitOperation>

Rate-limit operations declared by the plugin.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited