Class TenantSignInOptions

Represents sign-in options for a tenant.

Inheritance
Object
TenantSignInOptions
Inherited Members
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 TenantSignInOptions

Properties

AllowAllAuthenticationSchemes

Gets if all authentication schemes are allowed or not.

Declaration
[JsonIgnore]
public bool AllowAllAuthenticationSchemes { get; }
Property Value
Boolean

AllowedAuthenticationSchemes

Gets or sets a list of authentication schemes that this tenant allows. Allows all schemes when set to null or an empty collection.

Declaration
public List<string> AllowedAuthenticationSchemes { get; set; }
Property Value
List<String>

AuthenticationSchemes

Gets a collection of custom tenant settings for pre-configured authentication schemes.

Declaration
public List<IdentityAuthenticationScheme> AuthenticationSchemes { get; set; }
Property Value
List<IdentityAuthenticationScheme>

RequireConfirmedEmail

Gets or sets a flag indicating whether a confirmed email address is required to sign in.

Declaration
public bool? RequireConfirmedEmail { get; set; }
Property Value
System.Nullable<Boolean>

True if a user must have a confirmed email address before they can sign in, otherwise false.

RequireConfirmedPhoneNumber

Gets or sets a flag indicating whether a confirmed telephone number is required to sign in.

Declaration
public bool? RequireConfirmedPhoneNumber { get; set; }
Property Value
System.Nullable<Boolean>

True if a user must have a confirmed telephone number before they can sign in, otherwise false.

TenantAuthenticationSchemes

Gets a collection of custom tenant settings for tenant specific authentication schemes.

Declaration
public List<IdentityAuthenticationScheme> TenantAuthenticationSchemes { get; set; }
Property Value
List<IdentityAuthenticationScheme>

Methods

AddAllowedScheme(String, IEnumerable<AuthenticationScheme>)

Adds allowed schemes.

Declaration
public bool AddAllowedScheme(string schemeName, IEnumerable<AuthenticationScheme> allSchemes)
Parameters
String schemeName

The name of the scheme to allow.
IEnumerable<Microsoft.AspNetCore.Authentication.AuthenticationScheme> allSchemes

A collection of all Microsoft.AspNetCore.Authentication.AuthenticationScheme.
Returns
Boolean

true if any schemes was added to the allowed scheme collection; otherwise false.

GetAllowedTenantAuthenticationSchemes()

Gets a collection of the allowed TenantAuthenticationSchemes.

Declaration
public IEnumerable<IdentityAuthenticationScheme> GetAllowedTenantAuthenticationSchemes()
Returns
IEnumerable<IdentityAuthenticationScheme>

GetAuthenticationScheme(String)

Gets the IdentityAuthenticationScheme if configured.

Declaration
public IdentityAuthenticationScheme GetAuthenticationScheme(string schemeName)
Parameters
String schemeName

The name of the scheme.
Returns
IdentityAuthenticationScheme

The IdentityAuthenticationScheme if configured.

GetRemovedSchemeNames()

Gets the name of schemes that have been removed.

Declaration
public IList<string> GetRemovedSchemeNames()
Returns
System.Collections.Generic.IList<String>

IsForAutoProvision(String)

Gets if schemeName should be used to auto-provision new users.

Declaration
public bool IsForAutoProvision(string schemeName)
Parameters
String schemeName

The name of the scheme.
Returns
Boolean

true if the scheme should be used to auto-provision new users; otherwise false.

IsSchemeAllowed(String)

Gets if schemeName is allowed.

Declaration
public bool IsSchemeAllowed(string schemeName)
Parameters
String schemeName

The name of the scheme.
Returns
Boolean

true if the scheme is allowed; otherwise false.

RemoveAllowedScheme(String, IEnumerable<AuthenticationScheme>)

Removes the specified schemeName from the AllowedAuthenticationSchemes.

Declaration
public bool RemoveAllowedScheme(string schemeName, IEnumerable<AuthenticationScheme> allSchemes)
Parameters
String schemeName

The name of the scheme to not allow anymore.
IEnumerable<Microsoft.AspNetCore.Authentication.AuthenticationScheme> allSchemes

A collection of all Microsoft.AspNetCore.Authentication.AuthenticationScheme.
Returns
Boolean

true if any schemes was removed from the allowed scheme collection; otherwise false.

RemoveAuthenticationScheme(String)

Removes the authentication scheme with the specified schemeName.

Declaration
public void RemoveAuthenticationScheme(string schemeName)
Parameters
String schemeName

The name of the scheme to remove.