DownstreamWebApiOptions Class

Definition

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
type DownstreamWebApiOptions = class
Public Class DownstreamWebApiOptions
Inheritance
DownstreamWebApiOptions

Constructors

DownstreamWebApiOptions()

Properties

BaseUrl

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

HttpMethod

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

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".

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.

TokenAcquisitionOptions

Options passed-in to create the token acquisition object which calls into MSAL .NET.

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.

Methods

Clone()

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

GetApiUrl()

Return the downstream web API URL.

GetScopes()

Returns the scopes.

Applies to