UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim,TUserPasskey> Class

Definition

Namespace:: Microsoft.AspNetCore.Identity.EntityFrameworkCore

Assembly:: Microsoft.AspNetCore.Identity.EntityFrameworkCore.dll

Package:: Microsoft.AspNetCore.Identity.EntityFrameworkCore v10.0.0-preview.7.25380.108

Source:: UserStore.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a new instance of a persistence store for the specified user and role types.

public class UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim,TUserPasskey> : Microsoft.AspNetCore.Identity.UserStoreBase<TUser,TRole,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>, IDisposable, Microsoft.AspNetCore.Identity.IProtectedUserStore<TUser>, Microsoft.AspNetCore.Identity.IUserPasskeyStore<TUser>, Microsoft.AspNetCore.Identity.IUserStore<TUser> where TUser : IdentityUser<TKey> where TRole : IdentityRole<TKey> where TContext : DbContext where TKey : IEquatable<TKey> where TUserClaim : IdentityUserClaim<TKey>, new() where TUserRole : IdentityUserRole<TKey>, new() where TUserLogin : IdentityUserLogin<TKey>, new() where TUserToken : IdentityUserToken<TKey>, new() where TRoleClaim : IdentityRoleClaim<TKey>, new() where TUserPasskey : IdentityUserPasskey<TKey>, new()

type UserStore<'User, 'Role, 'Context, 'Key, 'UserClaim, 'UserRole, 'UserLogin, 'UserToken, 'RoleClaim, 'UserPasskey (requires 'User :> IdentityUser<'Key> and 'Role :> IdentityRole<'Key> and 'Context :> DbContext and 'Key :> IEquatable<'Key> and 'UserClaim :> IdentityUserClaim<'Key> and 'UserClaim : (new : unit -> 'UserClaim) and 'UserRole :> IdentityUserRole<'Key> and 'UserRole : (new : unit -> 'UserRole) and 'UserLogin :> IdentityUserLogin<'Key> and 'UserLogin : (new : unit -> 'UserLogin) and 'UserToken :> IdentityUserToken<'Key> and 'UserToken : (new : unit -> 'UserToken) and 'RoleClaim :> IdentityRoleClaim<'Key> and 'RoleClaim : (new : unit -> 'RoleClaim) and 'UserPasskey :> IdentityUserPasskey<'Key> and 'UserPasskey : (new : unit -> 'UserPasskey))> = class
    inherit UserStoreBase<'User, 'Role, 'Key, 'UserClaim, 'UserRole, 'UserLogin, 'UserToken, 'RoleClaim (requires 'User :> IdentityUser<'Key> and 'Role :> IdentityRole<'Key> and 'Key :> IEquatable<'Key> and 'UserClaim :> IdentityUserClaim<'Key> and 'UserClaim : (new : unit -> 'UserClaim) and 'UserRole :> IdentityUserRole<'Key> and 'UserRole : (new : unit -> 'UserRole) and 'UserLogin :> IdentityUserLogin<'Key> and 'UserLogin : (new : unit -> 'UserLogin) and 'UserToken :> IdentityUserToken<'Key> and 'UserToken : (new : unit -> 'UserToken) and 'RoleClaim :> IdentityRoleClaim<'Key> and 'RoleClaim : (new : unit -> 'RoleClaim))>
    interface IProtectedUserStore<'User (requires 'User :> IdentityUser<'Key>)>
    interface IUserStore<'User (requires 'User :> IdentityUser<'Key>)>
    interface IDisposable
    interface IUserPasskeyStore<'User (requires 'User :> IdentityUser<'Key>)>

Public Class UserStore(Of TUser, TRole, TContext, TKey, TUserClaim, TUserRole, TUserLogin, TUserToken, TRoleClaim, TUserPasskey)
Inherits UserStoreBase(Of TUser, TRole, TKey, TUserClaim, TUserRole, TUserLogin, TUserToken, TRoleClaim)
Implements IDisposable, IProtectedUserStore(Of TUser), IUserPasskeyStore(Of TUser), IUserStore(Of TUser)

Type Parameters

TUser

The type representing a user.

TRole

The type representing a role.

TContext

The type of the data context class used to access the store.

TKey

The type of the primary key for a role.

TUserClaim

The type representing a claim.

TUserRole

The type representing a user role.

TUserLogin

The type representing a user external login.

TUserToken

The type representing a user token.

TRoleClaim

The type representing a role claim.

TUserPasskey

The type representing a user passkey.

Inheritance: Object

UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>

UserStoreBase<TUser,TRole,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>
UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim,TUserPasskey>

Implements: IProtectedUserStore<TUser> IUserPasskeyStore<TUser> IUserStore<TUser> IDisposable

Constructors

UserStore<TUser,TRole,TContext,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim,TUserPasskey>(TContext, IdentityErrorDescriber)

Creates a new instance of the store.

Properties

AutoSaveChanges	Gets or sets a flag indicating if changes should be persisted after CreateAsync, UpdateAsync and DeleteAsync are called.
Context	Gets the database context for this store.
ErrorDescriber	Gets or sets the IdentityErrorDescriber for any error that occurred with the current operation. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
Users	A navigation property for the users the store contains.

Methods

AddClaimsAsync(TUser, IEnumerable<Claim>, CancellationToken)	Adds the `claims` given to the specified `user`.
AddLoginAsync(TUser, UserLoginInfo, CancellationToken)	Adds the `login` given to the specified `user`.
AddOrUpdatePasskeyAsync(TUser, UserPasskeyInfo, CancellationToken)	Creates a new passkey credential in the store for the specified `user`, or updates an existing passkey.
AddToRoleAsync(TUser, String, CancellationToken)	Adds the given `normalizedRoleName` to the specified `user`.
AddUserTokenAsync(TUserToken)	Add a new user token.
AddUserTokenAsync(TUserToken)	Add a new user token. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
ConvertIdFromString(String)	Converts the provided `id` to a strongly typed key object. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
ConvertIdToString(TKey)	Converts the provided `id` to its string representation. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
CountCodesAsync(TUser, CancellationToken)	Returns how many recovery code are still valid for a user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
CreateAsync(TUser, CancellationToken)	Creates the specified `user` in the user store.
CreateUserClaim(TUser, Claim)	Called to create a new instance of a IdentityUserClaim<TKey>. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
CreateUserLogin(TUser, UserLoginInfo)	Called to create a new instance of a IdentityUserLogin<TKey>. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
CreateUserPasskey(TUser, UserPasskeyInfo)	Called to create a new instance of a IdentityUserPasskey<TKey>.
CreateUserRole(TUser, TRole)	Called to create a new instance of a IdentityUserRole<TKey>. (Inherited from UserStoreBase<TUser,TRole,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
CreateUserToken(TUser, String, String, String)	Called to create a new instance of a IdentityUserToken<TKey>. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
DeleteAsync(TUser, CancellationToken)	Deletes the specified `user` from the user store.
Dispose()	Dispose the store (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
FindByEmailAsync(String, CancellationToken)	Gets the user, if any, associated with the specified, normalized email address.
FindByIdAsync(String, CancellationToken)	Finds and returns a user, if any, who has the specified `userId`.
FindByLoginAsync(String, String, CancellationToken)	Retrieves the user associated with the specified login provider and login provider key.
FindByNameAsync(String, CancellationToken)	Finds and returns a user, if any, who has the specified normalized user name.
FindByPasskeyIdAsync(Byte[], CancellationToken)	Finds and returns a user, if any, associated with the specified passkey credential identifier.
FindPasskeyAsync(TUser, Byte[], CancellationToken)	Finds a passkey for the specified user with the specified credential id.
FindRoleAsync(String, CancellationToken)	Return a role with the normalized name if it exists.
FindTokenAsync(TUser, String, String, CancellationToken)	Find a user token if it exists.
FindUserAsync(TKey, CancellationToken)	Return a user with the matching userId if it exists.
FindUserAsync(TKey, CancellationToken)	Return a user with the matching userId if it exists. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
FindUserLoginAsync(String, String, CancellationToken)	Return a user login with provider, providerKey if it exists.
FindUserLoginAsync(TKey, String, String, CancellationToken)	Return a user login with the matching userId, provider, providerKey if it exists.
FindUserLoginAsync(TKey, String, String, CancellationToken)	Return a user login with the matching userId, provider, providerKey if it exists. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
FindUserRoleAsync(TKey, TKey, CancellationToken)	Return a user role for the userId and roleId if it exists.
FindUserRoleAsync(TKey, TKey, CancellationToken)	Return a user role for the userId and roleId if it exists. (Inherited from UserStoreBase<TUser,TRole,TKey,TUserClaim,TUserRole,TUserLogin,TUserToken,TRoleClaim>)
GetAccessFailedCountAsync(TUser, CancellationToken)	Retrieves the current failed access count for the specified `user`.. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetAuthenticatorKeyAsync(TUser, CancellationToken)	Get the authenticator key for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetClaimsAsync(TUser, CancellationToken)	Get the claims associated with the specified `user` as an asynchronous operation.
GetEmailAsync(TUser, CancellationToken)	Gets the email address for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetEmailConfirmedAsync(TUser, CancellationToken)	Gets a flag indicating whether the email address for the specified `user` has been verified, true if the email address is verified otherwise false. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetLockoutEnabledAsync(TUser, CancellationToken)	Retrieves a flag indicating whether user lockout can enabled for the specified user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetLockoutEndDateAsync(TUser, CancellationToken)	Gets the last DateTimeOffset a user's last lockout expired, if any. Any time in the past should be indicates a user is not locked out. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetLoginsAsync(TUser, CancellationToken)	Retrieves the associated logins for the specified <param ref="user" />.
GetNormalizedEmailAsync(TUser, CancellationToken)	Returns the normalized email for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetNormalizedUserNameAsync(TUser, CancellationToken)	Gets the normalized user name for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetPasskeysAsync(TUser, CancellationToken)	Gets the passkey credentials for the specified `user`.
GetPasswordHashAsync(TUser, CancellationToken)	Gets the password hash for a user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetPhoneNumberAsync(TUser, CancellationToken)	Gets the telephone number, if any, for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetPhoneNumberConfirmedAsync(TUser, CancellationToken)	Gets a flag indicating whether the specified `user`'s telephone number has been confirmed. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetRolesAsync(TUser, CancellationToken)	Retrieves the roles the specified `user` is a member of.
GetSecurityStampAsync(TUser, CancellationToken)	Get the security stamp for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetTokenAsync(TUser, String, String, CancellationToken)	Returns the token value. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetTwoFactorEnabledAsync(TUser, CancellationToken)	Returns a flag indicating whether the specified `user` has two factor authentication enabled or not, as an asynchronous operation. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetUserIdAsync(TUser, CancellationToken)	Gets the user identifier for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetUserNameAsync(TUser, CancellationToken)	Gets the user name for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
GetUsersForClaimAsync(Claim, CancellationToken)	Retrieves all users with the specified claim.
GetUsersInRoleAsync(String, CancellationToken)	Retrieves all users in the specified role.
HasPasswordAsync(TUser, CancellationToken)	Returns a flag indicating if the specified user has a password. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
IncrementAccessFailedCountAsync(TUser, CancellationToken)	Records that a failed access has occurred, incrementing the failed access count. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
IsInRoleAsync(TUser, String, CancellationToken)	Returns a flag indicating if the specified user is a member of the give `normalizedRoleName`.
RedeemCodeAsync(TUser, String, CancellationToken)	Returns whether a recovery code is valid for a user. Note: recovery codes are only valid once, and will be invalid after use. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
RemoveClaimsAsync(TUser, IEnumerable<Claim>, CancellationToken)	Removes the `claims` given from the specified `user`.
RemoveFromRoleAsync(TUser, String, CancellationToken)	Removes the given `normalizedRoleName` from the specified `user`.
RemoveLoginAsync(TUser, String, String, CancellationToken)	Removes the `loginProvider` given from the specified `user`.
RemovePasskeyAsync(TUser, Byte[], CancellationToken)	Removes a passkey credential from the specified `user`.
RemoveTokenAsync(TUser, String, String, CancellationToken)	Deletes a token for a user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
RemoveUserTokenAsync(TUserToken)	Remove a new user token.
RemoveUserTokenAsync(TUserToken)	Remove a new user token. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
ReplaceClaimAsync(TUser, Claim, Claim, CancellationToken)	Replaces the `claim` on the specified `user`, with the `newClaim`.
ReplaceCodesAsync(TUser, IEnumerable<String>, CancellationToken)	Updates the recovery codes for the user while invalidating any previous recovery codes. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
ResetAccessFailedCountAsync(TUser, CancellationToken)	Resets a user's failed access count. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SaveChanges(CancellationToken)	Saves the current store.
SetAuthenticatorKeyAsync(TUser, String, CancellationToken)	Sets the authenticator key for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetEmailAsync(TUser, String, CancellationToken)	Sets the `email` address for a `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetEmailConfirmedAsync(TUser, Boolean, CancellationToken)	Sets the flag indicating whether the specified `user`'s email address has been confirmed or not. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetLockoutEnabledAsync(TUser, Boolean, CancellationToken)	Set the flag indicating if the specified `user` can be locked out.. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetLockoutEndDateAsync(TUser, Nullable<DateTimeOffset>, CancellationToken)	Locks out a user until the specified end date has passed. Setting a end date in the past immediately unlocks a user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetNormalizedEmailAsync(TUser, String, CancellationToken)	Sets the normalized email for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetNormalizedUserNameAsync(TUser, String, CancellationToken)	Sets the given normalized name for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetPasswordHashAsync(TUser, String, CancellationToken)	Sets the password hash for a user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetPhoneNumberAsync(TUser, String, CancellationToken)	Sets the telephone number for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetPhoneNumberConfirmedAsync(TUser, Boolean, CancellationToken)	Sets a flag indicating if the specified `user`'s phone number has been confirmed.. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetSecurityStampAsync(TUser, String, CancellationToken)	Sets the provided security `stamp` for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetTokenAsync(TUser, String, String, String, CancellationToken)	Sets the token value for a particular user. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetTwoFactorEnabledAsync(TUser, Boolean, CancellationToken)	Sets a flag indicating whether the specified `user` has two factor authentication enabled or not, as an asynchronous operation. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
SetUserNameAsync(TUser, String, CancellationToken)	Sets the given `userName` for the specified `user`. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
ThrowIfDisposed()	Throws if this class has been disposed. (Inherited from UserStoreBase<TUser,TKey,TUserClaim,TUserLogin,TUserToken>)
UpdateAsync(TUser, CancellationToken)	Updates the specified `user` in the user store.

Applies to

Feedback

Was this page helpful?