DownstreamWebApiOptions Class

Reference

Definition

Namespace:: Microsoft.Identity.Web

Assembly:: Microsoft.Identity.Web.dll

Package:: Microsoft.Identity.Web v3.3.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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 : Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions, ICloneable

type DownstreamWebApiOptions = class
    inherit MicrosoftIdentityAuthenticationBaseOptions
    interface ICloneable

Public Class DownstreamWebApiOptions
Inherits MicrosoftIdentityAuthenticationBaseOptions
Implements ICloneable

Inheritance: Object

MicrosoftIdentityAuthenticationBaseOptions
DownstreamWebApiOptions

Implements: ICloneable

Constructors

DownstreamWebApiOptions()

Properties

AuthenticationScheme	Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API. (Inherited from MicrosoftIdentityAuthenticationBaseOptions)
BaseUrl	Base URL for the called downstream web API. For instance `"https://graph.microsoft.com/beta/".`.
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.
HttpMethod	HTTP method used to call this downstream web API (by default Get).
IsProofOfPossessionRequest	Modifies the token acquisition request so that the acquired token is a Proof of Possession token (PoP), rather than a Bearer token. PoP tokens are similar to Bearer tokens, but are bound to the HTTP request and to a cryptographic key, which MSAL can manage. See https://aka.ms/msal-net-pop. Set to true to enable PoP tokens automatically. (Inherited from MicrosoftIdentityAuthenticationBaseOptions)
RelativePath	Path relative to the BaseUrl (for instance "me").
Scopes	Space separated scopes required to call the downstream web API. For instance "user.read mail.read". (Inherited from MicrosoftIdentityAuthenticationBaseOptions)
Tenant	[Optional] tenant ID. This is used for specific scenarios where the application needs to call a downstream web API on behalf of a user in several tenants. It would mostly be used from code, not from the configuration. (Inherited from MicrosoftIdentityAuthenticationBaseOptions)
TokenAcquisitionOptions	Options passed-in to create the token acquisition object which calls into MSAL .NET. (Inherited from MicrosoftIdentityAuthenticationBaseOptions)
UserFlow	[Optional]. User flow (in the case of a B2C downstream web API). If not specified, the B2C downstream web API will be called with the default user flow from DefaultUserFlow. (Inherited from MicrosoftIdentityAuthenticationBaseOptions)

Methods

Clone()	Clone the options (to be able to override them).
GetApiUrl()	Return the downstream web API URL.
GetScopes()	Returns the scopes. (Inherited from MicrosoftIdentityAuthenticationBaseOptions)

Explicit Interface Implementations

ICloneable.Clone()

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

Applies to

Dela via