MicrosoftIdentityOptions.xml

<Type Name="MicrosoftIdentityOptions" FullName="Microsoft.Identity.Web.MicrosoftIdentityOptions">
  <TypeSignature Language="C#" Value="public class MicrosoftIdentityOptions : Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MicrosoftIdentityOptions extends Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Identity.Web.MicrosoftIdentityOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class MicrosoftIdentityOptions&#xA;Inherits OpenIdConnectOptions" />
  <TypeSignature Language="F#" Value="type MicrosoftIdentityOptions = class&#xA;    inherit OpenIdConnectOptions" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
    <AssemblyVersion>2.6.1.0</AssemblyVersion>
    <AssemblyVersion>2.7.0.0</AssemblyVersion>
    <AssemblyVersion>2.8.0.0</AssemblyVersion>
    <AssemblyVersion>2.9.0.0</AssemblyVersion>
    <AssemblyVersion>2.10.0.0</AssemblyVersion>
    <AssemblyVersion>2.11.0.0</AssemblyVersion>
    <AssemblyVersion>2.11.1.0</AssemblyVersion>
    <AssemblyVersion>2.12.4.0</AssemblyVersion>
    <AssemblyVersion>2.13.0.0</AssemblyVersion>
    <AssemblyVersion>2.13.1.0</AssemblyVersion>
    <AssemblyVersion>2.13.2.0</AssemblyVersion>
    <AssemblyVersion>2.13.3.0</AssemblyVersion>
    <AssemblyVersion>2.13.4.0</AssemblyVersion>
    <AssemblyVersion>2.14.0.0</AssemblyVersion>
    <AssemblyVersion>2.15.1.0</AssemblyVersion>
    <AssemblyVersion>2.15.2.0</AssemblyVersion>
    <AssemblyVersion>2.15.3.0</AssemblyVersion>
    <AssemblyVersion>2.15.5.0</AssemblyVersion>
    <AssemblyVersion>2.16.0.0</AssemblyVersion>
    <AssemblyVersion>2.16.1.0</AssemblyVersion>
    <AssemblyVersion>2.17.0.0</AssemblyVersion>
    <AssemblyVersion>2.17.1.0</AssemblyVersion>
    <AssemblyVersion>2.17.2.0</AssemblyVersion>
    <AssemblyVersion>2.17.3.0</AssemblyVersion>
    <AssemblyVersion>2.17.4.0</AssemblyVersion>
    <AssemblyVersion>2.17.5.0</AssemblyVersion>
    <AssemblyVersion>2.18.1.0</AssemblyVersion>
    <AssemblyVersion>2.18.2.0</AssemblyVersion>
    <AssemblyVersion>2.19.0.0</AssemblyVersion>
    <AssemblyVersion>2.19.1.0</AssemblyVersion>
    <AssemblyVersion>2.20.0.0</AssemblyVersion>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>3.0.1.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Options for configuring authentication using Azure Active Directory. It has both AAD and B2C configuration attributes.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MicrosoftIdentityOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.MicrosoftIdentityOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AllowWebApiToBeAuthorizedByACL">
      <MemberSignature Language="C#" Value="public bool AllowWebApiToBeAuthorizedByACL { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool AllowWebApiToBeAuthorizedByACL" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.AllowWebApiToBeAuthorizedByACL" />
      <MemberSignature Language="VB.NET" Value="Public Property AllowWebApiToBeAuthorizedByACL As Boolean" />
      <MemberSignature Language="F#" Value="member this.AllowWebApiToBeAuthorizedByACL : bool with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.AllowWebApiToBeAuthorizedByACL" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Daemon applications can validate a token based on roles, or using the ACL-based authorization
            pattern to control tokens without a roles claim. If using ACL-based authorization,
            Microsoft Identity Web will not throw if roles or scopes are not in the Claims.
            For details see https://aka.ms/ms-identity-web/daemon-ACL.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <c>false.</c>
      </Docs>
    </Member>
    <Member MemberName="ClientCertificates">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Identity.Web.CertificateDescription&gt;? ClientCertificates { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Identity.Web.CertificateDescription&gt; ClientCertificates" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.ClientCertificates" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientCertificates As IEnumerable(Of CertificateDescription)" />
      <MemberSignature Language="F#" Value="member this.ClientCertificates : seq&lt;Microsoft.Identity.Web.CertificateDescription&gt; with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.ClientCertificates" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Identity.Web.CertificateDescription&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Description of the certificates used to prove the identity of the web app or web API.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <example> An example in the appsetting.json:
            <code>
            "ClientCertificates": [
              {
                "SourceType": "StoreWithDistinguishedName",
                 "CertificateStorePath": "CurrentUser/My",
                 "CertificateDistinguishedName": "CN=WebAppCallingWebApiCert"
                }
               ]
              </code>
              See also https://aka.ms/ms-id-web-certificates.
              </example>
      </Docs>
    </Member>
    <Member MemberName="ClientCredentials">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Identity.Abstractions.CredentialDescription&gt;? ClientCredentials { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Identity.Abstractions.CredentialDescription&gt; ClientCredentials" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.ClientCredentials" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientCredentials As IEnumerable(Of CredentialDescription)" />
      <MemberSignature Language="F#" Value="member this.ClientCredentials : seq&lt;Microsoft.Identity.Abstractions.CredentialDescription&gt; with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.ClientCredentials" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Identity.Abstractions.CredentialDescription&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary />
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ClientCredentialsUsingManagedIdentity">
      <MemberSignature Language="C#" Value="public Microsoft.Identity.Web.CertificatelessOptions? ClientCredentialsUsingManagedIdentity { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Identity.Web.CertificatelessOptions ClientCredentialsUsingManagedIdentity" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.ClientCredentialsUsingManagedIdentity" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientCredentialsUsingManagedIdentity As CertificatelessOptions" />
      <MemberSignature Language="F#" Value="member this.ClientCredentialsUsingManagedIdentity : Microsoft.Identity.Web.CertificatelessOptions with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.ClientCredentialsUsingManagedIdentity" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Web.CertificatelessOptions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Options for configuring certificateless
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DefaultUserFlow">
      <MemberSignature Language="C#" Value="public string? DefaultUserFlow { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string DefaultUserFlow" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.DefaultUserFlow" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property DefaultUserFlow As String" />
      <MemberSignature Language="F#" Value="member this.DefaultUserFlow : string" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.DefaultUserFlow" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the default user flow (which is signUpsignIn).
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Domain">
      <MemberSignature Language="C#" Value="public string? Domain { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Domain" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.Domain" />
      <MemberSignature Language="VB.NET" Value="Public Property Domain As String" />
      <MemberSignature Language="F#" Value="member this.Domain : string with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.Domain" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the domain of the Azure Active Directory tenant, e.g. contoso.onmicrosoft.com.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EditProfilePolicyId">
      <MemberSignature Language="C#" Value="public string? EditProfilePolicyId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string EditProfilePolicyId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.EditProfilePolicyId" />
      <MemberSignature Language="VB.NET" Value="Public Property EditProfilePolicyId As String" />
      <MemberSignature Language="F#" Value="member this.EditProfilePolicyId : string with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.EditProfilePolicyId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the edit profile user flow name for B2C, e.g. b2c_1_edit_profile.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ErrorPath">
      <MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Http.PathString? ErrorPath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Microsoft.AspNetCore.Http.PathString&gt; ErrorPath" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.ErrorPath" />
      <MemberSignature Language="VB.NET" Value="Public Property ErrorPath As Nullable(Of PathString)" />
      <MemberSignature Language="F#" Value="member this.ErrorPath : Nullable&lt;Microsoft.AspNetCore.Http.PathString&gt; with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.ErrorPath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Microsoft.AspNetCore.Http.PathString&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Sets the Error route path.
            Defaults to the value /MicrosoftIdentity/Account/Error,
            which is the value used by Microsoft.Identity.Web.UI.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ExtraQueryParameters">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary&lt;string,string&gt;? ExtraQueryParameters { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, string&gt; ExtraQueryParameters" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.ExtraQueryParameters" />
      <MemberSignature Language="VB.NET" Value="Public Property ExtraQueryParameters As IDictionary(Of String, String)" />
      <MemberSignature Language="F#" Value="member this.ExtraQueryParameters : System.Collections.Generic.IDictionary&lt;string, string&gt; with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.ExtraQueryParameters" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Sets query parameters for the query string in the HTTP request to the IdP.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Instance">
      <MemberSignature Language="C#" Value="public string Instance { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Instance" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.Instance" />
      <MemberSignature Language="VB.NET" Value="Public Property Instance As String" />
      <MemberSignature Language="F#" Value="member this.Instance : string with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.Instance" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the Azure Active Directory instance, e.g. "https://login.microsoftonline.com".
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LegacyCacheCompatibilityEnabled">
      <MemberSignature Language="C#" Value="public bool LegacyCacheCompatibilityEnabled { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool LegacyCacheCompatibilityEnabled" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.LegacyCacheCompatibilityEnabled" />
      <MemberSignature Language="VB.NET" Value="Public Property LegacyCacheCompatibilityEnabled As Boolean" />
      <MemberSignature Language="F#" Value="member this.LegacyCacheCompatibilityEnabled : bool with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.LegacyCacheCompatibilityEnabled" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Enables legacy ADAL cache serialization and deserialization.
            Performance improvements when working with MSAL only apps.
            Set to true if you have a shared cache with ADAL apps.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <c>false.</c>
      </Docs>
    </Member>
    <Member MemberName="ResetPasswordPath">
      <MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Http.PathString? ResetPasswordPath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Microsoft.AspNetCore.Http.PathString&gt; ResetPasswordPath" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.ResetPasswordPath" />
      <MemberSignature Language="VB.NET" Value="Public Property ResetPasswordPath As Nullable(Of PathString)" />
      <MemberSignature Language="F#" Value="member this.ResetPasswordPath : Nullable&lt;Microsoft.AspNetCore.Http.PathString&gt; with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.ResetPasswordPath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Microsoft.AspNetCore.Http.PathString&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Sets the ResetPassword route path.
            Defaults to /MicrosoftIdentity/Account/ResetPassword,
            which is the value used by Microsoft.Identity.Web.UI.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResetPasswordPolicyId">
      <MemberSignature Language="C#" Value="public string? ResetPasswordPolicyId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ResetPasswordPolicyId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.ResetPasswordPolicyId" />
      <MemberSignature Language="VB.NET" Value="Public Property ResetPasswordPolicyId As String" />
      <MemberSignature Language="F#" Value="member this.ResetPasswordPolicyId : string with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.ResetPasswordPolicyId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the reset password user flow name for B2C, e.g. B2C_1_password_reset.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SendX5C">
      <MemberSignature Language="C#" Value="public bool SendX5C { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool SendX5C" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.SendX5C" />
      <MemberSignature Language="VB.NET" Value="Public Property SendX5C As Boolean" />
      <MemberSignature Language="F#" Value="member this.SendX5C : bool with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.SendX5C" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Specifies if the x5c claim (public key of the certificate) should be sent to the STS.
            Sending the x5c enables application developers to achieve easy certificate rollover in Azure AD:
            this method will send the public certificate to Azure AD along with the token request,
            so that Azure AD can use it to validate the subject name based on a trusted issuer policy.
            This saves the application admin from the need to explicitly manage the certificate rollover
            (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <c>false.</c>
      </Docs>
    </Member>
    <Member MemberName="SignUpSignInPolicyId">
      <MemberSignature Language="C#" Value="public string? SignUpSignInPolicyId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string SignUpSignInPolicyId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.SignUpSignInPolicyId" />
      <MemberSignature Language="VB.NET" Value="Public Property SignUpSignInPolicyId As String" />
      <MemberSignature Language="F#" Value="member this.SignUpSignInPolicyId : string with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.SignUpSignInPolicyId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the sign up or sign in user flow name for B2C, e.g. b2c_1_susi.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TenantId">
      <MemberSignature Language="C#" Value="public string? TenantId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TenantId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.TenantId" />
      <MemberSignature Language="VB.NET" Value="Public Property TenantId As String" />
      <MemberSignature Language="F#" Value="member this.TenantId : string with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.TenantId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the tenant ID.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TokenDecryptionCertificates">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Identity.Web.CertificateDescription&gt;? TokenDecryptionCertificates { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Identity.Web.CertificateDescription&gt; TokenDecryptionCertificates" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.TokenDecryptionCertificates" />
      <MemberSignature Language="VB.NET" Value="Public Property TokenDecryptionCertificates As IEnumerable(Of CertificateDescription)" />
      <MemberSignature Language="F#" Value="member this.TokenDecryptionCertificates : seq&lt;Microsoft.Identity.Web.CertificateDescription&gt; with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.TokenDecryptionCertificates" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Identity.Web.CertificateDescription&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Description of the certificates used to decrypt an encrypted token in a web API.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <example> An example in the appsetting.json:
            <code>
            "TokenDecryptionCertificates": [
              {
                "SourceType": "StoreWithDistinguishedName",
                 "CertificateStorePath": "CurrentUser/My",
                 "CertificateDistinguishedName": "CN=WebAppCallingWebApiCert"
                }
               ]
              </code>
              See also https://aka.ms/ms-id-web-certificates.
              </example>
      </Docs>
    </Member>
    <Member MemberName="TokenDecryptionCredentials">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Identity.Abstractions.CredentialDescription&gt;? TokenDecryptionCredentials { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Identity.Abstractions.CredentialDescription&gt; TokenDecryptionCredentials" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.TokenDecryptionCredentials" />
      <MemberSignature Language="VB.NET" Value="Public Property TokenDecryptionCredentials As IEnumerable(Of CredentialDescription)" />
      <MemberSignature Language="F#" Value="member this.TokenDecryptionCredentials : seq&lt;Microsoft.Identity.Abstractions.CredentialDescription&gt; with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.TokenDecryptionCredentials" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Identity.Abstractions.CredentialDescription&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary />
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UserAssignedManagedIdentityClientId">
      <MemberSignature Language="C#" Value="public string? UserAssignedManagedIdentityClientId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string UserAssignedManagedIdentityClientId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.UserAssignedManagedIdentityClientId" />
      <MemberSignature Language="VB.NET" Value="Public Property UserAssignedManagedIdentityClientId As String" />
      <MemberSignature Language="F#" Value="member this.UserAssignedManagedIdentityClientId : string with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.UserAssignedManagedIdentityClientId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Used, when deployed to Azure, to specify explicitly a user assigned managed identity.
            See https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-portal.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="WithSpaAuthCode">
      <MemberSignature Language="C#" Value="public bool WithSpaAuthCode { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool WithSpaAuthCode" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.WithSpaAuthCode" />
      <MemberSignature Language="VB.NET" Value="Public Property WithSpaAuthCode As Boolean" />
      <MemberSignature Language="F#" Value="member this.WithSpaAuthCode : bool with get, set" Usage="Microsoft.Identity.Web.MicrosoftIdentityOptions.WithSpaAuthCode" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web.TokenAcquisition</AssemblyName>
        <AssemblyVersion>3.0.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Requests an auth code for the frontend (SPA using MSAL.js for instance). 
            See https://aka.ms/msal-net/spa-auth-code for details.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <c>false.</c>
      </Docs>
    </Member>
  </Members>
</Type>