Table of Contents

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, IParameterOptions
Inheritance
MicrosoftEntraLoginProvider
Implements
Inherited Members

Properties

AcceptAllTenants

[AddInParameterGroup("Tenant configuration")]
[AddInLabel("Accept all tenants")]
[AddInParameter("AcceptAllTenants")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "info=Accept tokens from any tenant without issuer validation. Required for the Consumers authority mode.")]
public bool AcceptAllTenants { get; set; }

Property Value

bool

AllowedTenants

[AddInParameterGroup("Tenant configuration")]
[AddInLabel("Allowed Tenants")]
[AddInParameter("AllowedTenants")]
[AddInParameterEditor(typeof(TextParameterEditor), "info=Comma-separated tenant IDs (GUIDs) to allow. Active when Support multi-tenant is on and Accept all tenants is off. e.g. e3563f52-33b0-49cb-89a5-7c10db9335c9, 9a8b7c6d-1234-5678-abcd-ef0123456789")]
public string? AllowedTenants { get; set; }

Property Value

string

AuthorityMode

[AddInParameterGroup("Tenant configuration")]
[AddInLabel("Authority mode")]
[AddInParameter("AuthorityMode")]
[AddInParameterEditor(typeof(DropDownParameterEditor), "none=true;reloadOnChange=true;info=Controls which Microsoft accounts can sign in. Leave unset to auto-detect from the Tenant field.")]
public string? AuthorityMode { get; set; }

Property Value

string

ClientId

[AddInParameterGroup("External credentials")]
[AddInLabel("Application (client) ID")]
[AddInParameter("ClientId")]
[AddInParameterEditor(typeof(TextParameterEditor), "required;info=Found in 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=Found under Certificates & secrets 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=Page shown to the user when 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=Unique ID for this provider. The redirect URI in Entra admin center (Authentication) must be set to https://yoursite.com/signin-{scheme}. e.g. msentra")]
public override string ProviderScheme { get; set; }

Property Value

string

SupportMultiTenant

[AddInParameterGroup("Tenant configuration")]
[AddInLabel("Support multi-tenant")]
[AddInParameter("SupportMultiTenant")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "info=Allow sign-in from multiple Entra directories. Requires either a list of allowed tenant IDs or 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=Directory (tenant) ID from App registrations in Microsoft Entra admin center. Required when Authority mode is Tenant. e.g. e3563f52-33b0-49cb-89a5-7c10db9335c9 or mycompany.onmicrosoft.com")]
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>
To top