IDownstreamWebApi Interface

  • Reference

Definition

Namespace:
Microsoft.Identity.Web
Assembly:
Microsoft.Identity.Web.dll
Package:
Microsoft.Identity.Web v1.15.2

Interface used to call a downstream web API, for instance from controllers.

public interface IDownstreamWebApi
type IDownstreamWebApi = interface
Public Interface IDownstreamWebApi
Derived

Methods

CallWebApiForAppAsync(String, Action<DownstreamWebApiOptions>, StringContent)

Calls the downstream web API for the app, with the required scopes.
CallWebApiForAppAsync(String, String, Action<DownstreamWebApiOptions>, StringContent)

Calls the downstream web API for the app, with the required scopes.
CallWebApiForUserAsync(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(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, Action<DownstreamWebApiOptions>, ClaimsPrincipal)

Calls a downstream web API consuming JSON with some data and returns data.
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)

Call a web API endpoint with an HttpGet, and return strongly typed data.
GetForUserAsync<TInput>(IDownstreamWebApi, String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)

Call a web API with a strongly typed input, with an HttpGet.
GetForUserAsync<TOutput>(IDownstreamWebApi, String, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)

Get a strongly typed response from the web API.
PostForUserAsync<TOutput,TInput>(IDownstreamWebApi, String, String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)

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)

Calls the web API endpoint with an HttpPut, providing strongly typed input data.
PutForUserAsync<TOutput,TInput>(IDownstreamWebApi, String, String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal, String)

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

Applies to