AuthorizationHeaderProviderOptions.xml

<Type Name="AuthorizationHeaderProviderOptions" FullName="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions">
  <TypeSignature Language="C#" Value="public class AuthorizationHeaderProviderOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AuthorizationHeaderProviderOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class AuthorizationHeaderProviderOptions" />
  <TypeSignature Language="F#" Value="type AuthorizationHeaderProviderOptions = class" />
  <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>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Options passed-in to call downstream web APIs. To call Microsoft Graph, see rather
            <c>MicrosoftGraphOptions</c> in the <c>Microsoft.Identity.Web.MicrosoftGraph</c> assembly.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public AuthorizationHeaderProviderOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Default constructor.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public AuthorizationHeaderProviderOptions (Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions other);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions other) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.#ctor(Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (other As AuthorizationHeaderProviderOptions)" />
      <MemberSignature Language="F#" Value="new Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions : Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions -&gt; Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" Usage="new Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions other" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="other" Type="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" />
      </Parameters>
      <Docs>
        <param name="other">Options to copy from.</param>
        <summary>
            Copy constructor for <see cref="T:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" /></summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="other" /> is <c>null</c>.</exception>
      </Docs>
    </Member>
    <Member MemberName="AcquireTokenOptions">
      <MemberSignature Language="C#" Value="public Microsoft.Identity.Abstractions.AcquireTokenOptions AcquireTokenOptions { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Identity.Abstractions.AcquireTokenOptions AcquireTokenOptions" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.AcquireTokenOptions" />
      <MemberSignature Language="VB.NET" Value="Public Property AcquireTokenOptions As AcquireTokenOptions" />
      <MemberSignature Language="F#" Value="member this.AcquireTokenOptions : Microsoft.Identity.Abstractions.AcquireTokenOptions with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.AcquireTokenOptions" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Abstractions.AcquireTokenOptions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Options related to token acquisition.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BaseUrl">
      <MemberSignature Language="C#" Value="public string? BaseUrl { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string BaseUrl" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.BaseUrl" />
      <MemberSignature Language="VB.NET" Value="Public Property BaseUrl As String" />
      <MemberSignature Language="F#" Value="member this.BaseUrl : string with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.BaseUrl" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Base URL for the called downstream web API. For instance <c>"https://graph.microsoft.com/beta/"</c>.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Clone">
      <MemberSignature Language="C#" Value="public Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions Clone ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions Clone() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.Clone" />
      <MemberSignature Language="VB.NET" Value="Public Function Clone () As AuthorizationHeaderProviderOptions" />
      <MemberSignature Language="F#" Value="member this.Clone : unit -&gt; Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" Usage="authorizationHeaderProviderOptions.Clone " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Clone the options (to be able to override them).
            </summary>
        <returns>A clone of the options.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CloneInternal">
      <MemberSignature Language="C#" Value="protected virtual Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions CloneInternal ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions CloneInternal() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.CloneInternal" />
      <MemberSignature Language="VB.NET" Value="Protected Overridable Function CloneInternal () As AuthorizationHeaderProviderOptions" />
      <MemberSignature Language="F#" Value="abstract member CloneInternal : unit -&gt; Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions&#xA;override this.CloneInternal : unit -&gt; Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" Usage="authorizationHeaderProviderOptions.CloneInternal " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Clone the options (to be able to override them).
            </summary>
        <returns>A clone of the options.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CustomizeHttpRequestMessage">
      <MemberSignature Language="C#" Value="public Action&lt;System.Net.Http.HttpRequestMessage&gt;? CustomizeHttpRequestMessage { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Action`1&lt;class System.Net.Http.HttpRequestMessage&gt; CustomizeHttpRequestMessage" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.CustomizeHttpRequestMessage" />
      <MemberSignature Language="VB.NET" Value="Public Property CustomizeHttpRequestMessage As Action(Of HttpRequestMessage)" />
      <MemberSignature Language="F#" Value="member this.CustomizeHttpRequestMessage : Action&lt;System.Net.Http.HttpRequestMessage&gt; with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.CustomizeHttpRequestMessage" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Action&lt;System.Net.Http.HttpRequestMessage&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Provides an opportunity for the caller app to customize the HttpRequestMessage. For example,
            to customize the headers. This is called after the message was formed, including
            the Authorization header, and just before the message is sent.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetApiUrl">
      <MemberSignature Language="C#" Value="public string GetApiUrl ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetApiUrl() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.GetApiUrl" />
      <MemberSignature Language="VB.NET" Value="Public Function GetApiUrl () As String" />
      <MemberSignature Language="F#" Value="member this.GetApiUrl : unit -&gt; string" Usage="authorizationHeaderProviderOptions.GetApiUrl " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Return the downstream web API URL.
            </summary>
        <returns>URL of the downstream web API.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HttpMethod">
      <MemberSignature Language="C#" Value="public string HttpMethod { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string HttpMethod" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.HttpMethod" />
      <MemberSignature Language="VB.NET" Value="Public Property HttpMethod As String" />
      <MemberSignature Language="F#" Value="member this.HttpMethod : string with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.HttpMethod" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.DefaultValue("Get")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.DefaultValue("Get")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            HTTP method used to call this downstream web API (by default Get).
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ProtocolScheme">
      <MemberSignature Language="C#" Value="public string ProtocolScheme { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ProtocolScheme" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.ProtocolScheme" />
      <MemberSignature Language="VB.NET" Value="Public Property ProtocolScheme As String" />
      <MemberSignature Language="F#" Value="member this.ProtocolScheme : string with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.ProtocolScheme" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.DefaultValue("Bearer")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.DefaultValue("Bearer")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Name of the protocol scheme used to create the authorization header. By default: "Bearer".
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RelativePath">
      <MemberSignature Language="C#" Value="public string RelativePath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string RelativePath" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.RelativePath" />
      <MemberSignature Language="VB.NET" Value="Public Property RelativePath As String" />
      <MemberSignature Language="F#" Value="member this.RelativePath : string with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.RelativePath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Path relative to the <see cref="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.BaseUrl" /> (for instance "me").
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RequestAppToken">
      <MemberSignature Language="C#" Value="public bool RequestAppToken { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool RequestAppToken" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.RequestAppToken" />
      <MemberSignature Language="VB.NET" Value="Public Property RequestAppToken As Boolean" />
      <MemberSignature Language="F#" Value="member this.RequestAppToken : bool with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.RequestAppToken" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Describes if the downstream API is called on behalf of the calling service itself
            (App token) or on behalf of a user processed by the service (user token).
            If <c>true</c>, the token is requested on behalf of the app. Otherwise, it on-behalf of the user.
            </summary>
        <value>To be added.</value>
        <remarks>This is especially usefull when the call to the downstream API is described
            by configuration.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>