Class RegisterOptions

Options for controling registration of new users.

Inheritance
Object
RegisterOptions
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.UI
Assembly: IRM.AspNetCore.Identity.UI.dll
Syntax
public class RegisterOptions

Properties

AllowedAuthenticationSchemes

Gets a collection of authentication schemes that are allowed to be used during registration. An empty collection will allow all registered authentication schemes.

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

Remarks

The allowed authentication schemes can be limited also with tenant settings.

DataProtectionAgreement

Gets or sets an UrlOptions for data protection taht the user must accept.

Declaration
public UrlOptions DataProtectionAgreement { get; set; }
Property Value
UrlOptions

RegisterInOrganisations

Gets or sets if registration in an organisation is allowed. Defaults to false.

Declaration
public bool RegisterInOrganisations { get; set; }
Property Value
Boolean

Remarks

Registration in organisation is only allowed in existing organisations with trusted domains matching the user's email domain. If RegisterNewOrganisation is true the user can create a new organisation and register in that. This requires that the organisation does not exists.

If both RegisterInPrivatePersons and RegisterInOrganisations is true, the user can be required to choose in which tenant to create the account.

RegisterInPrivatePersons

Gets or sets if registration as a private person is allowed. Defaults to false.

Declaration
public bool RegisterInPrivatePersons { get; set; }
Property Value
Boolean

RegisterNewOrganisation

Gets or sets if a user is allowed to create a new organisation during registration.

Declaration
public bool RegisterNewOrganisation { get; set; }
Property Value
Boolean

RequireName

Gets or sets if name is required when registering. Defailts to Required.

Declaration
public RegisterNameOption RequireName { get; set; }
Property Value
RegisterNameOption

ShowAgreement

Gets if an agreement text should be displayed for the user or not.

Declaration
public bool ShowAgreement { get; }
Property Value
Boolean

UserAgreement

Gets or sets an UrlOptions for user agreements that the user must accept.

Declaration
public UrlOptions UserAgreement { get; set; }
Property Value
UrlOptions

Methods

GetAgreementText()

Gets the agreement text to display for a user that register for an account.

Declaration
public virtual string GetAgreementText()
Returns
String

The agreement text to display for a user that register for an account.