Share via


ILongRunningWebApi Interface

Definition

Methods for long-running or background processes in web APIs.

public interface ILongRunningWebApi
type ILongRunningWebApi = interface
Public Interface ILongRunningWebApi
Derived

Methods

AcquireTokenInLongRunningProcess(IEnumerable<String>, String)

Retrieves an access token from the cache using the provided cache key that can be used to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See Long-running OBO in MSAL.NET. Use <seealso cref="M:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)"></seealso> to stop the long running process and remove the associated tokens from the cache.

InitiateLongRunningProcessInWebApi(IEnumerable<String>, String, String)

Acquires an access token for this web API from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See Long-running OBO in MSAL.NET. Pass an access token (not an ID token) which was used to call this confidential client application in the userToken parameter. Use <seealso cref="M:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)"></seealso> to stop the long running process and remove the associated tokens from the cache.

Extension Methods

StopLongRunningProcessInWebApiAsync(ILongRunningWebApi, String, CancellationToken)

Stops an in-progress long-running on-behalf-of session by removing the tokens associated with the provided cache key. See Long-running OBO in MSAL.NET.

Applies to