Class MicrosoftEntraLoginProvider

Namespace

Dynamicweb.ExternalAuthentication

Assembly

Dynamicweb.ExternalAuthentication.dll

Microsoft Entra login provider

[AddInName("Microsoft Entra")]
[AddInDescription("Microsoft Entra login provider.")]
public sealed class MicrosoftEntraLoginProvider : BaseOAuthLoginProvider, IUpdateOpenIdConnectOptions, IParameterVisibility

Inheritance

object

ConfigurableAddIn

ExternalLoginProvider

BaseOAuthLoginProvider

MicrosoftEntraLoginProvider

Implements

IUpdateOpenIdConnectOptions

IParameterVisibility

Inherited Members

BaseOAuthLoginProvider.RegisterProvider(AuthenticationBuilder)

ExternalLoginProvider.OnlyDoVerificationExternally

ExternalLoginProvider.NewUserGroups

ExternalLoginProvider.CreateInstance(string, string)

ExternalLoginProvider.CreateInstance<T>(string)

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AcceptAllTenants

[AddInParameterGroup("Tenant configuration")]
[AddInLabel("Accept all tenants")]
[AddInParameter("AcceptAllTenants")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool AcceptAllTenants { get; set; }

Property Value

bool

AllowedTenants

[AddInParameterGroup("Tenant configuration")]
[AddInLabel("Allowed Tenants")]
[AddInParameter("AllowedTenants")]
[AddInParameterEditor(typeof(TextParameterEditor), "")]
public string? AllowedTenants { get; set; }

Property Value

string

ClientId

[AddInParameterGroup("External credentials")]
[AddInLabel("Application (client) ID")]
[AddInParameter("ClientId")]
[AddInParameterEditor(typeof(TextParameterEditor), "required;info=The Application (Client) ID from App registrations overview in Microsoft Entra admin center")]
public string? ClientId { get; set; }

Property Value

string

ClientSecret

[AddInParameterGroup("External credentials")]
[AddInLabel("Client secret (Value)")]
[AddInParameter("ClientSecret")]
[AddInParameterEditor(typeof(TextParameterEditor), "required;info=A valid client secret value from Certificates & secrets list in Microsoft Entra admin center")]
public string? ClientSecret { get; set; }

Property Value

string

ErrorPage

Sets the page to show authentication error. Use it when the authentication provider is used in the frontend.

[AddInParameterGroup("Frontend")]
[AddInLabel("Authentication error page")]
[AddInParameter("ErrorPage")]
[AddInParameterEditor(typeof(PageSelectEditor), "info=The page the user will be redirected to if authentication fails")]
public override string? ErrorPage { get; set; }

Property Value

string

ProviderScheme

The name of the provider authentication scheme.

[AddInParameterGroup("External credentials")]
[AddInLabel("Authentication scheme")]
[AddInParameter("ProviderScheme")]
[AddInParameterEditor(typeof(TextParameterEditor), "required;info=A string ID that can be anything you define, but must be unique for each setup of Entra provider in Dynamicweb. In Microsoft Entra admin center, the redirect Uri under Authentication must be set as https://yoursite.com/signin-{scheme} - e.g. https://yoursite.com/signin-msentra  - and must be https")]
public override string ProviderScheme { get; set; }

Property Value

string

SupportMultiTenant

[AddInParameterGroup("Tenant configuration")]
[AddInLabel("Support multi-tenant")]
[AddInParameter("SupportMultiTenant")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "info=When checked you should either supply a list of allowed tenants or check 'Accept all tenants'")]
public bool SupportMultiTenant { get; set; }

Property Value

bool

Tenant

[AddInParameterGroup("Tenant configuration")]
[AddInLabel("Directory (tenant) ID")]
[AddInParameter("Tenant")]
[AddInParameterEditor(typeof(TextParameterEditor), "info=The Directory (tenant) ID from App registrations overview in Microsoft Entra admin center, for example e3563f52-33b0-49cb-89a5-7c10db9335c9 or mycompany.onmicrosoft.com. Use this field if 'Support multi-tenant' is not enabled.")]
public string? Tenant { get; set; }

Property Value

string

Methods

GetHiddenParameterNames(string, object?)

public IEnumerable<string> GetHiddenParameterNames(string parameterName, object? parameterValue)

Parameters

parameterName string

parameterValue object

Returns

IEnumerable<string>