MicrosoftIdentityApplicationOptions.xml

<Type Name="MicrosoftIdentityApplicationOptions" FullName="Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions">
  <TypeSignature Language="C#" Value="public class MicrosoftIdentityApplicationOptions : Microsoft.Identity.Abstractions.IdentityApplicationOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MicrosoftIdentityApplicationOptions extends Microsoft.Identity.Abstractions.IdentityApplicationOptions" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class MicrosoftIdentityApplicationOptions&#xA;Inherits IdentityApplicationOptions" />
  <TypeSignature Language="F#" Value="type MicrosoftIdentityApplicationOptions = class&#xA;    inherit IdentityApplicationOptions" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
    <AssemblyVersion>2.1.0.0</AssemblyVersion>
    <AssemblyVersion>3.1.0.0</AssemblyVersion>
    <AssemblyVersion>3.2.0.0</AssemblyVersion>
    <AssemblyVersion>3.2.1.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.1.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>5.1.0.0</AssemblyVersion>
    <AssemblyVersion>5.3.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.1.0.0</AssemblyVersion>
    <AssemblyVersion>7.2.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Identity.Abstractions.IdentityApplicationOptions</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Options for configuring authentication for a web app, web API, or daemon application, 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 MicrosoftIdentityApplicationOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AppHomeTenantId">
      <MemberSignature Language="C#" Value="public string? AppHomeTenantId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string AppHomeTenantId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.AppHomeTenantId" />
      <MemberSignature Language="VB.NET" Value="Public Property AppHomeTenantId As String" />
      <MemberSignature Language="F#" Value="member this.AppHomeTenantId : string with get, set" Usage="Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.AppHomeTenantId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Home tenant of the app in which the app can acquire a token to call a downstream API on behalf of itself.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Authority">
      <MemberSignature Language="C#" Value="public override string? Authority { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Authority" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.Authority" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Property Authority As String" />
      <MemberSignature Language="F#" Value="member this.Authority : string with get, set" Usage="Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.Authority" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the Authority to use when making OpenIdConnect calls. By default the authority is computed
            from the <see cref="P:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.Instance" /> and <see cref="P:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.TenantId" /> properties, by concatenating them, and appending "v2.0".
            If your authority is not an Azure AD authority, you can set it directly here.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AzureRegion">
      <MemberSignature Language="C#" Value="public string? AzureRegion { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string AzureRegion" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.AzureRegion" />
      <MemberSignature Language="VB.NET" Value="Public Property AzureRegion As String" />
      <MemberSignature Language="F#" Value="member this.AzureRegion : string with get, set" Usage="Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.AzureRegion" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Specifies the Azure region. See https://aka.ms/azure-region. To have
            the app attempt to detect the Azure region automatically,
            use "TryAutoDetect".
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ClientCapabilities">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;string&gt;? ClientCapabilities { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;string&gt; ClientCapabilities" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.ClientCapabilities" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientCapabilities As IEnumerable(Of String)" />
      <MemberSignature Language="F#" Value="member this.ClientCapabilities : seq&lt;string&gt; with get, set" Usage="Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.ClientCapabilities" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Specifies the capabilities of the client (for instance {"cp1", "cp2"}). This is
            useful to express that the Client is capable of handling claims challenge. If your application
            is CAE capable, it needs to express "cp1".
            </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.Abstractions.MicrosoftIdentityApplicationOptions.DefaultUserFlow" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property DefaultUserFlow As String" />
      <MemberSignature Language="F#" Value="member this.DefaultUserFlow : string" Usage="Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.DefaultUserFlow" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.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.Abstractions.MicrosoftIdentityApplicationOptions.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.Abstractions.MicrosoftIdentityApplicationOptions.Domain" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.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.Abstractions.MicrosoftIdentityApplicationOptions.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.Abstractions.MicrosoftIdentityApplicationOptions.EditProfilePolicyId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.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 string? ErrorPath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ErrorPath" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.ErrorPath" />
      <MemberSignature Language="VB.NET" Value="Public Property ErrorPath As String" />
      <MemberSignature Language="F#" Value="member this.ErrorPath : string with get, set" Usage="Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.ErrorPath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</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="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.Abstractions.MicrosoftIdentityApplicationOptions.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.Abstractions.MicrosoftIdentityApplicationOptions.Instance" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the Azure Active Directory instance, e.g. <c>"https://login.microsoftonline.com/"</c>.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResetPasswordPath">
      <MemberSignature Language="C#" Value="public string? ResetPasswordPath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ResetPasswordPath" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.ResetPasswordPath" />
      <MemberSignature Language="VB.NET" Value="Public Property ResetPasswordPath As String" />
      <MemberSignature Language="F#" Value="member this.ResetPasswordPath : string with get, set" Usage="Microsoft.Identity.Abstractions.MicrosoftIdentityApplicationOptions.ResetPasswordPath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Sets the ResetPassword route path (from the root of the web site).
            Defaults to /MicrosoftIdentity/Account/ResetPassword,
            which is the value used by Microsoft.Identity.Web.UI.
            If you override it, you need to provide your own controller/actions.
            </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.Abstractions.MicrosoftIdentityApplicationOptions.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.Abstractions.MicrosoftIdentityApplicationOptions.ResetPasswordPolicyId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.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.Abstractions.MicrosoftIdentityApplicationOptions.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.Abstractions.MicrosoftIdentityApplicationOptions.SendX5C" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.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 the app registration portal or using PowerShell/CLI). 
            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.Abstractions.MicrosoftIdentityApplicationOptions.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.Abstractions.MicrosoftIdentityApplicationOptions.SignUpSignInPolicyId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.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.Abstractions.MicrosoftIdentityApplicationOptions.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.Abstractions.MicrosoftIdentityApplicationOptions.TenantId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the tenant ID. If your application is multi-tenant, you can also use "common" if it supports
            both work and school, or personal accounts accounts, or "organizations" if your application supports only work 
            and school accounts. If your application is single tenant, set this property to the tenant ID or domain name.
            If your application works only for Microsoft personal accounts, use "consumers".
            </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.Abstractions.MicrosoftIdentityApplicationOptions.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.Abstractions.MicrosoftIdentityApplicationOptions.WithSpaAuthCode" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>7.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            If set to <c>true</c>, when the user signs-in in a web app, the application requests an auth code 
            for the frontend (single page application using MSAL.js for instance). This will allow the front end
            JavaScript code to bypass going to the authoriize endpoint (which requires reloading the page), by 
            directly redeeming the auth code to get access tokens to call APIs.
            See https://aka.ms/msal-net/hybrid-spa-sample for details. Only works for AAD, not B2C.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <c>false.</c>
      </Docs>
    </Member>
  </Members>
</Type>