Class DownstreamWebApiOptions

Namespace

Microsoft.Identity.Web

Assembly

Microsoft.Identity.Web.dll

Options passed-in to call downstream web APIs. To call Microsoft Graph, see rather MicrosoftGraphOptions in the Microsoft.Identity.Web.MicrosoftGraph assembly.

public class DownstreamWebApiOptions : MicrosoftIdentityAuthenticationBaseOptions, ICloneable

Inheritance

object

MicrosoftIdentityAuthenticationBaseOptions

DownstreamWebApiOptions

Implements

ICloneable

Inherited Members

MicrosoftIdentityAuthenticationBaseOptions.GetScopes()

MicrosoftIdentityAuthenticationBaseOptions.Scopes

MicrosoftIdentityAuthenticationBaseOptions.Tenant

MicrosoftIdentityAuthenticationBaseOptions.UserFlow

MicrosoftIdentityAuthenticationBaseOptions.IsProofOfPossessionRequest

MicrosoftIdentityAuthenticationBaseOptions.TokenAcquisitionOptions

MicrosoftIdentityAuthenticationBaseOptions.AuthenticationScheme

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DownstreamWebApiOptions()

public DownstreamWebApiOptions()

Properties

BaseUrl

Base URL for the called downstream web API. For instance "https://graph.microsoft.com/beta/"..

public string BaseUrl { get; set; }

Property Value

string

CustomizeHttpRequestMessage

Provides an opportunity 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.

public Action<HttpRequestMessage>? CustomizeHttpRequestMessage { get; set; }

Property Value

Action<HttpRequestMessage>

HttpMethod

HTTP method used to call this downstream web API (by default Get).

public HttpMethod HttpMethod { get; set; }

Property Value

HttpMethod

RelativePath

Path relative to the BaseUrl (for instance "me").

public string RelativePath { get; set; }

Property Value

string

Methods

Clone()

Clone the options (to be able to override them).

public DownstreamWebApiOptions Clone()

Returns

DownstreamWebApiOptions

A clone of the options.

GetApiUrl()

Return the downstream web API URL.

public string GetApiUrl()

Returns

string

URL of the downstream web API.