DownstreamWebApi Class

Definition

Caution

Use DownstreamApi in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.

Implementation for the downstream web API.

[System.Obsolete("Use DownstreamApi in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)]
public class DownstreamWebApi : Microsoft.Identity.Web.IDownstreamWebApi
[<System.Obsolete("Use DownstreamApi in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)>]
type DownstreamWebApi = class
    interface IDownstreamWebApi
Public Class DownstreamWebApi
Implements IDownstreamWebApi
Inheritance
DownstreamWebApi
Attributes
Implements

Constructors

DownstreamWebApi(ITokenAcquisition, IOptionsMonitor<DownstreamWebApiOptions>, HttpClient, IOptionsMonitor<MicrosoftIdentityOptions>)

Constructor.

Methods

CallWebApiForAppAsync(String, String, Action<DownstreamWebApiOptions>, StringContent)

Calls the downstream web API for the app, with the required scopes.

CallWebApiForUserAsync(String, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, StringContent)

Calls the downstream web API for the user, based on a description of the downstream web API in the configuration.

CallWebApiForUserAsync<TInput,TOutput>(String, TInput, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal)

Calls a downstream web API consuming JSON with some data and returns data.

Extension Methods

CallWebApiForUserAsync<TOutput>(IDownstreamWebApi, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)
Obsolete.

Call a web API endpoint with an HttpGet, and return strongly typed data.

GetForUserAsync<TInput>(IDownstreamWebApi, String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)
Obsolete.

Call a web API with a strongly typed input, with an HttpGet.

GetForUserAsync<TOutput>(IDownstreamWebApi, String, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)
Obsolete.

Get a strongly typed response from the web API.

PostForUserAsync<TOutput,TInput>(IDownstreamWebApi, String, String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)
Obsolete.

Calls the web API with an HttpPost, providing strongly typed input and getting strongly typed output.

PutForUserAsync<TInput>(IDownstreamWebApi, String, String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)
Obsolete.

Calls the web API endpoint with an HttpPut, providing strongly typed input data.

PutForUserAsync<TOutput,TInput>(IDownstreamWebApi, String, String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)
Obsolete.

Calls the web API endpoint with an HttpPut, provinding strongly typed input data and getting back strongly typed data.

Applies to