Class MicrosoftEntraExternalIdLoginProvider

Namespace

Dynamicweb.ExternalAuthentication

Assembly

Dynamicweb.ExternalAuthentication.dll

Microsoft Entra External ID (CIAM) login provider Authority/metadata is hosted on {tenantSubdomain}.ciamlogin.com

[AddInName("Microsoft Entra External ID (CIAM)")]
[AddInDescription("Microsoft Entra External ID (CIAM) login provider.")]
public sealed class MicrosoftEntraExternalIdLoginProvider : BaseOAuthLoginProvider, IUpdateOpenIdConnectOptions

Inheritance

object

ConfigurableAddIn

ExternalLoginProvider

BaseOAuthLoginProvider

MicrosoftEntraExternalIdLoginProvider

Implements

IUpdateOpenIdConnectOptions

Inherited Members

BaseOAuthLoginProvider.RegisterProvider(AuthenticationBuilder)

ExternalLoginProvider.OnlyDoVerificationExternally

ExternalLoginProvider.NewUserGroups

ExternalLoginProvider.AssignGroupByEmailDomain

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

ClientId

[AddInParameterGroup("External credentials")]
[AddInLabel("Application (client) ID")]
[AddInParameter("ClientId")]
[AddInParameterEditor(typeof(TextParameterEditor), "required;info=The Application (client) ID from the App Registration in the External ID tenant.")]
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.")]
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 unique scheme id for this provider instance. Redirect URI must be https://yoursite.com/signin-{scheme} (e.g. https://yoursite.com/signin-ciam).")]
public override string ProviderScheme { get; set; }

Property Value

string

TenantId

[AddInParameterGroup("Tenant")]
[AddInLabel("Tenant ID")]
[AddInParameter("TenantId")]
[AddInParameterEditor(typeof(TextParameterEditor), "required;info=The Directory (tenant) ID (GUID) of the External ID tenant. Used in the authority path: https://{tenantSubdomain}.ciamlogin.com/{tenantId}/v2.0")]
public string? TenantId { get; set; }

Property Value

string

TenantSubdomain

[AddInParameterGroup("Tenant")]
[AddInLabel("Tenant subdomain")]
[AddInParameter("TenantSubdomain")]
[AddInParameterEditor(typeof(TextParameterEditor), "required;info=The CIAM tenant subdomain used in the login host. Example: contoso (for https://contoso.ciamlogin.com/...).")]
public string? TenantSubdomain { get; set; }

Property Value

string