Class ExtendedSignInManager<TUser>

Inheritance
Object
SignInManager<TUser>
ExtendedSignInManager<TUser>
MultitenantSignInManager<TUser, TTenant>
Inherited Members
Microsoft.AspNetCore.Identity.SignInManager<TUser>.SignInAsync(TUser, System.Boolean, System.String)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.ValidateSecurityStampAsync(TUser, System.String)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.PasswordSignInAsync(System.String, System.String, System.Boolean, System.Boolean)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.IsTwoFactorClientRememberedAsync(TUser)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.ForgetTwoFactorClientAsync()
Microsoft.AspNetCore.Identity.SignInManager<TUser>.TwoFactorRecoveryCodeSignInAsync(System.String)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.ExternalLoginSignInAsync(System.String, System.String, System.Boolean, System.Boolean)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.GetExternalAuthenticationSchemesAsync()
Microsoft.AspNetCore.Identity.SignInManager<TUser>.UpdateExternalAuthenticationTokensAsync(Microsoft.AspNetCore.Identity.ExternalLoginInfo)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.ConfigureExternalAuthenticationProperties(System.String, System.String, System.String)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.IsLockedOut(TUser)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.PreSignInCheck(TUser)
Microsoft.AspNetCore.Identity.SignInManager<TUser>.UserManager
Microsoft.AspNetCore.Identity.SignInManager<TUser>.Context
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: IRM.AspNetCore.Identity
Assembly: IRM.AspNetCore.Identity.dll
Syntax
public class ExtendedSignInManager<TUser> : SignInManager<TUser> where TUser : class, IUser
Type Parameters
TUser

Constructors

ExtendedSignInManager(ExtendedUserManager<TUser>, IHttpContextAccessor, IUserClaimsPrincipalFactory<TUser>, IOptions<ExtendedIdentityOptions>, IOptionsSnapshot<TenantIdentityOptions>, ExtendedIdentityErrorDescriber, ILogger<ExtendedSignInManager<TUser>>, IAuthenticationSchemeProvider)

Creates a new instance of ExtendedSignInManager<TUser>.

Declaration
public ExtendedSignInManager(ExtendedUserManager<TUser> userManager, IHttpContextAccessor contextAccessor, IUserClaimsPrincipalFactory<TUser> claimsFactory, IOptions<ExtendedIdentityOptions> optionsAccessor, IOptionsSnapshot<TenantIdentityOptions> tenantIdentityOptionsAccessor, ExtendedIdentityErrorDescriber errorDescriber, ILogger<ExtendedSignInManager<TUser>> logger, IAuthenticationSchemeProvider schemes)
Parameters
ExtendedUserManager<TUser> userManager

An instance of ExtendedSignInManager{TUser}.ExtendedUserManager used to retrieve users.
Microsoft.AspNetCore.Http.IHttpContextAccessor contextAccessor

The accessor used to access the Microsoft.AspNetCore.Http.HttpContext.
Microsoft.AspNetCore.Identity.IUserClaimsPrincipalFactory<TUser> claimsFactory

The factory to use to create claims principals for a user.
Microsoft.Extensions.Options.IOptions<ExtendedIdentityOptions> optionsAccessor

The accessor used to access the ExtendedIdentityOptions.
IOptionsSnapshot<TenantIdentityOptions> tenantIdentityOptionsAccessor

The accessor used to access the TenantIdentityOptions.
ExtendedIdentityErrorDescriber errorDescriber

The ExtendedIdentityErrorDescriber used to provider error messages.
Microsoft.Extensions.Logging.ILogger<ExtendedSignInManager<TUser>> logger

The logger used to log messages, warnings and errors.
Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider schemes

The scheme provider that is used enumerate the authentication schemes.

Properties

ExtendedUserManager

Gets or sets the ExtendedUserManager<TUser> used by this sign-in manager.

Declaration
protected ExtendedUserManager<TUser> ExtendedUserManager { get; set; }
Property Value
ExtendedUserManager<TUser>

Options

Get the ExtendedIdentityOptions.

Declaration
protected ExtendedIdentityOptions Options { get; }
Property Value
ExtendedIdentityOptions

TenantIdentityOptions

Gets the TenantIdentityOptions.

Declaration
public TenantIdentityOptions TenantIdentityOptions { get; }
Property Value
TenantIdentityOptions

Methods

AddRequiredInformationAndSignInAsync(String, String)

Adds an e-mail address and/or a phone number to a user.

Declaration
public virtual async Task<SignInResult> AddRequiredInformationAndSignInAsync(string email, string phoneNumber)
Parameters
String email

The email address to be added to the user.
String phoneNumber

The phone number to be added to the user.
Returns
System.Threading.Tasks.Task<SignInResult>

The System.Threading.Tasks.Task object representing the asynchronous operation containing the SignInResult for the sign-in attempt.

AssociateExternalLoginSignInAsyn(UserLoginInfo)

Associates an external login with an invited user.

Declaration
public virtual async Task<IdentityResult> AssociateExternalLoginSignInAsyn(UserLoginInfo login)
Parameters
Microsoft.AspNetCore.Identity.UserLoginInfo login

The external Microsoft.AspNetCore.Identity.UserLoginInfo to associate with the invited user.
Returns
System.Threading.Tasks.Task<IdentityResult>

The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult of the operation.
Remarks

AssociateExternalLoginSignInAsyn is used in conjuction with InvitedUserSignInAsync(String, String).

AssociatePasswordSignInAsync(String)

Associates a local account for an invited user.

Declaration
public virtual async Task<IdentityResult> AssociatePasswordSignInAsync(string password)
Parameters
String password

The password for the user to hash and store.
Returns
System.Threading.Tasks.Task<IdentityResult>

The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult of the operation.
Remarks

AssociatePasswordSignInAsync is used in conjuction with InvitedUserSignInAsync(String, String).

AutoLinkUserAsync(SignInResult, ExternalLoginInfo, Boolean)

Tries to auto provision a user for a Microsoft.AspNetCore.Identity.SignInResult.Failed result.

Declaration
public virtual async Task<SignInResult> AutoLinkUserAsync(SignInResult result, ExternalLoginInfo info, bool userAcceptedTerms = false)
Parameters
SignInResult result

The original SignInResult returned by ExternalLoginSignInAsync(Boolean).
Microsoft.AspNetCore.Identity.ExternalLoginInfo info

The Microsoft.AspNetCore.Identity.ExternalLoginInfo from the external login service.
Boolean userAcceptedTerms

true if the user confirmed the required agreement; otherwise false.
Returns
System.Threading.Tasks.Task<SignInResult>

Either result or a new SignInResult from a new call to ExternalLoginSignInAsync(Boolean) after an auto provision of the user.
Remarks

This method does nothing if AllowAutoprovisionOfUser isn't turned on.

Auto provision of a user is the process where an external login is automatically associated with a user. The association is based on a claim (for example sub or email) that the external login provider returns and that matches a local user instance.

AutoLinkUserAsync(SignInResult, Boolean)

Tries to auto provision a user for a Microsoft.AspNetCore.Identity.SignInResult.Failed result.

Declaration
public virtual async Task<SignInResult> AutoLinkUserAsync(SignInResult result, bool userAcceptedTerms = false)
Parameters
SignInResult result

The original SignInResult returned by ExternalLoginSignInAsync(Boolean).
Boolean userAcceptedTerms

true if the user confirmed the required agreement; otherwise false.
Returns
System.Threading.Tasks.Task<SignInResult>

Either result or a new SignInResult from a new call to ExternalLoginSignInAsync(Boolean) after an auto provision of the user.
Remarks

This method does nothing if AllowAutoprovisionOfUser isn't turned on.

Auto provision of a user is the process where an external login is automatically associated with a user. The association is based on a claim (for example sub or email) that the external login provider returns and that matches a local user instance.

BeginExternalLoginAsync(String, AuthenticationProperties)

Begins an external login.

Declaration
public virtual Task<IActionResult> BeginExternalLoginAsync(string provider, AuthenticationProperties properties)
Parameters
String provider

The requested login provider.
Microsoft.AspNetCore.Authentication.AuthenticationProperties properties

The Microsoft.AspNetCore.Authentication.AuthenticationProperties for the
Returns
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>

The resolved login provider.

CanSignInAsync(TUser)

Declaration
public override async Task<bool> CanSignInAsync(TUser user)
Parameters
TUser user

Returns
System.Threading.Tasks.Task<Boolean>

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.CanSignInAsync(TUser)

CheckPasswordSignInAsync(TUser, String, Boolean)

Declaration
public override async Task<SignInResult> CheckPasswordSignInAsync(TUser user, string password, bool lockoutOnFailure)
Parameters
TUser user

String password

Boolean lockoutOnFailure

Returns
System.Threading.Tasks.Task<SignInResult>

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.CheckPasswordSignInAsync(TUser, System.String, System.Boolean)

ConfirmEmailAndSignInAsync(String)

Confirms the e-mail address of a previously verified user and then sign-in the user, as an asynchronous operation.

Declaration
public virtual Task<SignInResult> ConfirmEmailAndSignInAsync(string code)
Parameters
String code

The e-mailed code to verify.
Returns
System.Threading.Tasks.Task<SignInResult>

The task object representing the asynchronous operation containing the result for the sign-in attempt.

ConfirmPhoneNumberAndSignInAsync(String)

Confirms the phone number of a previously verified user and then sign-in the user, as an asynchronous operation.

Declaration
public virtual Task<SignInResult> ConfirmPhoneNumberAndSignInAsync(string code)
Parameters
String code

The code to verify.
Returns
System.Threading.Tasks.Task<SignInResult>

The task object representing the asynchronous operation containing the result for the sign-in attempt.

CreateClaimFilterContextAsync(ExternalLoginInfo, String)

Creates a ClaimFilterContext<TUser> for info.

Declaration
public virtual Task<ClaimFilterContext<TUser>> CreateClaimFilterContextAsync(ExternalLoginInfo info, string caller)
Parameters
Microsoft.AspNetCore.Identity.ExternalLoginInfo info

The Microsoft.AspNetCore.Identity.ExternalLoginInfo to create a context for.
String caller

The action that is about to exeute claim filters.
Returns
System.Threading.Tasks.Task<ClaimFilterContext<TUser>>

The System.Threading.Tasks.Task that represents the asynchronous operation, containing the ClaimFilterContext<TUser>.

CreateClaimFilterContextAsync(ClaimsPrincipal, String, String, Nullable<Guid>)

Creates a ClaimFilterContext<TUser> with the provided values and ExternalPrincipal set if there is an externa login.

Declaration
public virtual async Task<ClaimFilterContext<TUser>> CreateClaimFilterContextAsync(ClaimsPrincipal principal, string caller, string loginProvider, Guid? tenantId = null)
Parameters
System.Security.Claims.ClaimsPrincipal principal

The System.Security.Claims.ClaimsPrincipal for the user.
String caller

The action that is about to exeute claim filters.
String loginProvider

The login provider used.
System.Nullable<System.Guid> tenantId

The unique identity of the tenant (if any).
Returns
System.Threading.Tasks.Task<ClaimFilterContext<TUser>>

The System.Threading.Tasks.Task that represents the asynchronous operation, containing the ClaimFilterContext<TUser>.

CreateImpersonatedUserPrincipalAsync(TUser, String[])

Creates an impersonated System.Security.Claims.ClaimsPrincipal for the specified user, as an asynchronous operation.

Declaration
public virtual async Task<ClaimsPrincipal> CreateImpersonatedUserPrincipalAsync(TUser user, params string[] actClaimTypesToInclude)
Parameters
TUser user

The user to create a System.Security.Claims.ClaimsPrincipal for.
String[] actClaimTypesToInclude

The types of claims to include in the act claim.
Returns
System.Threading.Tasks.Task<System.Security.Claims.ClaimsPrincipal>

The task object representing the asynchronous operation, containing the System.Security.Claims.ClaimsPrincipal for the specified user.

CreateImpersonatorUserPrincipalAsync()

Creates a full System.Security.Claims.ClaimsPrincipal for the user that is impersonating, as an asynchronous operation.

Declaration
public virtual async Task<ClaimsPrincipal> CreateImpersonatorUserPrincipalAsync()
Returns
System.Threading.Tasks.Task<System.Security.Claims.ClaimsPrincipal>

The task object representing the asynchronous operation, containing the System.Security.Claims.ClaimsPrincipal for the impersonating user.

ExternalLoginSignInAsync(ExternalLoginInfo, Boolean)

Signs in a user via a previously registered third party login, as an asynchronous operation.

Declaration
public virtual async Task<SignInResult> ExternalLoginSignInAsync(ExternalLoginInfo loginInfo, bool isPersistent)
Parameters
Microsoft.AspNetCore.Identity.ExternalLoginInfo loginInfo

Login information, source and externally sourced principal.
Boolean isPersistent

Flag indicating whether the sign-in cookie should persist after the browser is closed.
Returns
System.Threading.Tasks.Task<SignInResult>

The task object representing the asynchronous operation containing the for the sign-in attempt.

ExternalLoginSignInAsync(Boolean)

Signs in a user via a previously registered third party login, as an asynchronous operation.

Declaration
public virtual async Task<SignInResult> ExternalLoginSignInAsync(bool isPersistent)
Parameters
Boolean isPersistent

Flag indicating whether the sign-in cookie should persist after the browser is closed.
Returns
System.Threading.Tasks.Task<SignInResult>

The task object representing the asynchronous operation containing the for the sign-in attempt.

ExternalLoginSignInAsync(String, String, Boolean)

Declaration
public override async Task<SignInResult> ExternalLoginSignInAsync(string loginProvider, string providerKey, bool isPersistent)
Parameters
String loginProvider

String providerKey

Boolean isPersistent

Returns
System.Threading.Tasks.Task<SignInResult>

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.ExternalLoginSignInAsync(System.String, System.String, System.Boolean)

FindUserToAutoLinkAsync(ExternalLoginInfo, TemporaryUserLoginInfo)

Tries to find a user that can be automatically linked based on the Microsoft.AspNetCore.Identity.ExternalLoginInfo.

Declaration
protected virtual async Task<TUser> FindUserToAutoLinkAsync(ExternalLoginInfo info, TemporaryUserLoginInfo temporaryUser)
Parameters
Microsoft.AspNetCore.Identity.ExternalLoginInfo info

The Microsoft.AspNetCore.Identity.ExternalLoginInfo which values can be used to find a user.
TemporaryUserLoginInfo temporaryUser

Optionally information about a temporary user that has started a sign-in flow. This can be null and that should not cause any exceptions.
Returns
System.Threading.Tasks.Task<TUser>

A TUser if a user is found, otherwise null.

GetExternalLoginInfoAsync(String)

Declaration
public override async Task<ExternalLoginInfo> GetExternalLoginInfoAsync(string expectedXsrf = null)
Parameters
String expectedXsrf

Returns
System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.ExternalLoginInfo>

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.GetExternalLoginInfoAsync(System.String)

GetSavedUserNameAsync()

Gets a saved user name (if any), as an asynchronous operation.

Declaration
public virtual Task<string> GetSavedUserNameAsync()
Returns
System.Threading.Tasks.Task<String>

The task object representing the asynchronous operation containing the user name.

GetTemporaryUserAsync()

Gets the temporary user, as an asynchronous operation.

Declaration
public async Task<TUser> GetTemporaryUserAsync()
Returns
System.Threading.Tasks.Task<TUser>

The task object representing the asynchronous operation containing the TUser for the sign-in attempt, if any is available.

GetTemporaryUserInfoAsync()

Gets the temporary user info, as an asynchronous operation.

Declaration
public Task<TemporaryUserLoginInfo> GetTemporaryUserInfoAsync()
Returns
System.Threading.Tasks.Task<TemporaryUserLoginInfo>

The task object representing the asynchronous operation containing the for the sign-in attempt.

GetUserNameCookieAsync()

Gets the cookie value of the UserNameScheme cookie.

Declaration
protected Task<string> GetUserNameCookieAsync()
Returns
System.Threading.Tasks.Task<String>

The task object representing the asynchronous operation containing the cookie value.

ImpersonateSignInAsync(TUser, String[])

The currently signed in user impersonates the user.

Declaration
public virtual async Task<ClaimsPrincipal> ImpersonateSignInAsync(TUser user, params string[] actClaimTypesToInclude)
Parameters
TUser user

The user to impersonate.
String[] actClaimTypesToInclude

The types of claims to include in the act claim.
Returns
System.Threading.Tasks.Task<System.Security.Claims.ClaimsPrincipal>

The task object representing the asynchronous operation, containing the System.Security.Claims.ClaimsPrincipal for the impersonated user.

ImpersonateSignInAsync(String, Boolean, String[])

The currently signed in user impersonates the user matching userId.

Declaration
public virtual async Task<ClaimsPrincipal> ImpersonateSignInAsync(string userId, bool ignoreTenant, params string[] actClaimTypesToInclude)
Parameters
String userId

The unique identifier of the user to impersonate.
Boolean ignoreTenant

true to search for userId without tenant restrections.
String[] actClaimTypesToInclude

The types of claims to include in the act claim.
Returns
System.Threading.Tasks.Task<System.Security.Claims.ClaimsPrincipal>

The task object representing the asynchronous operation, containing the System.Security.Claims.ClaimsPrincipal for the impersonated user.

ImpersonateSignOutAsync()

Signs the current impersonated user out of the application.

Declaration
public virtual async Task<ClaimsPrincipal> ImpersonateSignOutAsync()
Returns
System.Threading.Tasks.Task<System.Security.Claims.ClaimsPrincipal>

The task object representing the asynchronous operation, containing the System.Security.Claims.ClaimsPrincipal of the signed in impersonator.

InvitedUserSignInAsync(String, String)

Attempts to sign in the invited user as an asynchronous operation.

Declaration
public virtual async Task<SignInResult> InvitedUserSignInAsync(string userId, string code)
Parameters
String userId

The user id to sign in.
String code

The code created with the invitation.
Returns
System.Threading.Tasks.Task<SignInResult>

The task object representing the asynchronous operation containing the for the sign-in attempt.

IsPasswordToOld(DateTimeOffset)

Returns a flag indicating whether the specified password change date is to old or not.

Declaration
protected virtual bool IsPasswordToOld(DateTimeOffset passwordLastChanged)
Parameters
System.DateTimeOffset passwordLastChanged

The date and time, in UTC, when the user last changed password.
Returns
Boolean

A flag indicating whether the specified password change date is to old or not.

IsValidPhoneNumber(String)

Validates a phone number and using the default phone number country code that is configurered the current users tenant.

Declaration
public bool IsValidPhoneNumber(string phoneNumber)
Parameters
String phoneNumber

The phone number to validate.
Returns
Boolean

True if the phone number is valid, otherwise false.

MustChangePassword(TUser)

Returns a flag indicating whether the specified user must change password or not.

Declaration
protected virtual async Task<bool> MustChangePassword(TUser user)
Parameters
TUser user

The user whose password status should be returned.
Returns
System.Threading.Tasks.Task<Boolean>

A flag indicating whether the specified user must change password or not.

OneTimePasswordSignInAsync(TUser)

Signs in the specified user, verified with a one-time password, as an asynchronous operation.

Declaration
public virtual async Task<SignInResult> OneTimePasswordSignInAsync(TUser user)
Parameters
TUser user

The user to sign in.
Returns
System.Threading.Tasks.Task<SignInResult>

The task object representing the asynchronous operation containing the result for the sign-in attempt.

OneTimePasswordSignInAsync(String)

Signs in the user with specified userId, verified with a one-time password, as an asynchronous operation.

Declaration
public virtual async Task<SignInResult> OneTimePasswordSignInAsync(string userId)
Parameters
String userId

The unique identifier of the user that has been verified with one-time password.
Returns
System.Threading.Tasks.Task<SignInResult>

The task object representing the asynchronous operation containing the for the sign-in attempt.

PasswordSignInAsync(TUser, String, Boolean, Boolean)

Declaration
public override async Task<SignInResult> PasswordSignInAsync(TUser user, string password, bool isPersistent, bool lockoutOnFailure)
Parameters
TUser user

String password

Boolean isPersistent

Boolean lockoutOnFailure

Returns
System.Threading.Tasks.Task<SignInResult>

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.PasswordSignInAsync(TUser, System.String, System.Boolean, System.Boolean)

PostSignInCheck(TUser)

Used to ensure that we have the required information about the user.

Declaration
protected async Task<SignInResult> PostSignInCheck(TUser user)
Parameters
TUser user

The TUser to check.
Returns
System.Threading.Tasks.Task<SignInResult>

The System.Threading.Tasks.Task object representing the asynchronous operation containing the SignInResult for the sign-in attempt.

PublishSignInFailed(SignInResult, TUser)

Audits a sign-in, if auditing is used.

Declaration
protected virtual async Task PublishSignInFailed(SignInResult result, TUser user)
Parameters
SignInResult result

The SignInResult to audit.
TUser user

The user to audit the failure for.
Returns
System.Threading.Tasks.Task

The task object representing the asynchronous operation for the auditing.

ReconfigureTenantIdentityOptions(Nullable<Guid>)

Reconfigures the TenantIdentityOptions for the tenantId.

Declaration
public virtual Task<bool> ReconfigureTenantIdentityOptions(Guid? tenantId)
Parameters
System.Nullable<System.Guid> tenantId

The tenant to reconfigure the TenantIdentityOptions for.
Returns
System.Threading.Tasks.Task<Boolean>

True if TenantIdentityOptions has been reconfigured, otherwise false.

RefreshSignInAsync(TUser)

Declaration
public override async Task RefreshSignInAsync(TUser user)
Parameters
TUser user

Returns
System.Threading.Tasks.Task

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.RefreshSignInAsync(TUser)

RequiresConfirmation(TUser)

Checks if the user is required to confirm any information (aka email or phone number).

Declaration
protected async Task<SignInResult> RequiresConfirmation(TUser user)
Parameters
TUser user

The TUser to check.
Returns
System.Threading.Tasks.Task<SignInResult>

The System.Threading.Tasks.Task object representing the asynchronous operation containing the SignInResult for the sign-in attempt.

ResetLockout(TUser)

Shortcutted to not do anything. This is handled from the UserSignedIn event instead.

Declaration
protected override Task ResetLockout(TUser user)
Parameters
TUser user

The user to sign-in.
Returns
System.Threading.Tasks.Task

A System.Threading.Tasks.Task.CompletedTask.
Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.ResetLockout(TUser)

SaveTemporaryTenantAsync(TUser)

Declaration
protected virtual async Task SaveTemporaryTenantAsync(TUser user)
Parameters
TUser user

Returns
System.Threading.Tasks.Task

SaveTemporaryUserInfoAsync(String, String)

Saves temporary user infor, as an asynchronous operation.

Declaration
public Task SaveTemporaryUserInfoAsync(string userId, string userName)
Parameters
String userId

The unique identity of the user.
String userName

The user name.
Returns
System.Threading.Tasks.Task

The task object representing the asynchronous operation.

SaveUserNameAsync(String)

Saves a user name in a cookie, as an asynchronous operation.

Declaration
public virtual Task SaveUserNameAsync(string userName)
Parameters
String userName

The user name to save.
Returns
System.Threading.Tasks.Task

The task object representing the asynchronous operation.

SaveUserNameCookieAsync(String)

Saves the supplied value in the UserNameScheme cookie.

Declaration
protected Task SaveUserNameCookieAsync(string cookieValue)
Parameters
String cookieValue

The value to save.
Returns
System.Threading.Tasks.Task

The task object representing the asynchronous operation.

SignInAsync(TUser, AuthenticationProperties, String)

Declaration
public override async Task SignInAsync(TUser user, AuthenticationProperties authenticationProperties, string authenticationMethod = null)
Parameters
TUser user

Microsoft.AspNetCore.Authentication.AuthenticationProperties authenticationProperties

String authenticationMethod

Returns
System.Threading.Tasks.Task

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.SignInAsync(TUser, Microsoft.AspNetCore.Authentication.AuthenticationProperties, System.String)

SignInOrTwoFactorAsync(TUser, Boolean, String, Boolean)

Declaration
protected override async Task<SignInResult> SignInOrTwoFactorAsync(TUser user, bool isPersistent, string loginProvider = null, bool bypassTwoFactor = false)
Parameters
TUser user

Boolean isPersistent

String loginProvider

Boolean bypassTwoFactor

Returns
System.Threading.Tasks.Task<SignInResult>

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.SignInOrTwoFactorAsync(TUser, System.Boolean, System.String, System.Boolean)

SignInWithClaimsAsync(TUser, AuthenticationProperties, IEnumerable<Claim>)

Signs in the specified user.

Declaration
public virtual async Task SignInWithClaimsAsync(TUser user, AuthenticationProperties authenticationProperties, IEnumerable<Claim> additionalClaims)
Parameters
TUser user

The user to sign-in.
Microsoft.AspNetCore.Authentication.AuthenticationProperties authenticationProperties

Properties applied to the login and authentication cookie.
IEnumerable<System.Security.Claims.Claim> additionalClaims

Additional claims that will be stored in the cookie.
Returns
System.Threading.Tasks.Task

The task object representing the asynchronous operation.

SignInWithClaimsAsync(TUser, Boolean, IEnumerable<Claim>)

Signs in the specified user.

Declaration
public virtual Task SignInWithClaimsAsync(TUser user, bool isPersistent, IEnumerable<Claim> additionalClaims)
Parameters
TUser user

The user to sign-in.
Boolean isPersistent

Flag indicating whether the sign-in cookie should persist after the browser is closed.
IEnumerable<System.Security.Claims.Claim> additionalClaims

Additional claims that will be stored in the cookie.
Returns
System.Threading.Tasks.Task

The task object representing the asynchronous operation.

SignOutAsync()

Declaration
public override async Task SignOutAsync()
Returns
System.Threading.Tasks.Task

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.SignOutAsync()

SyncExternalRoles(TUser)

Synchronizes the supplied user roles comming from an external service.

Declaration
protected async Task<ExternalRoleSynchronizationResult> SyncExternalRoles(TUser user)
Parameters
TUser user

The user to sync roles for.
Returns
System.Threading.Tasks.Task<ExternalRoleSynchronizationResult>

The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult of the operation.

TwoFactorAuthenticatorSignInAsync(String, Boolean, Boolean)

Declaration
public override Task<SignInResult> TwoFactorAuthenticatorSignInAsync(string code, bool isPersistent, bool rememberClient)
Parameters
String code

Boolean isPersistent

Boolean rememberClient

Returns
System.Threading.Tasks.Task<SignInResult>

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.TwoFactorAuthenticatorSignInAsync(System.String, System.Boolean, System.Boolean)

TwoFactorSignInAsync(String, String, Boolean, Boolean)

Declaration
public override async Task<SignInResult> TwoFactorSignInAsync(string provider, string code, bool isPersistent, bool rememberClient)
Parameters
String provider

String code

Boolean isPersistent

Boolean rememberClient

Returns
System.Threading.Tasks.Task<SignInResult>

Overrides
Microsoft.AspNetCore.Identity.SignInManager<TUser>.TwoFactorSignInAsync(System.String, System.String, System.Boolean, System.Boolean)

Extension Methods