ConfidentialClientApplication.InitiateLongRunningProcessInWebApi Method
Definition
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.
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.
public Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable<string> scopes, string userToken, ref string longRunningProcessSessionKey);abstract member InitiateLongRunningProcessInWebApi : seq<string> * string * string -> Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder
override this.InitiateLongRunningProcessInWebApi : seq<string> * string * string -> Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilderPublic Function InitiateLongRunningProcessInWebApi (scopes As IEnumerable(Of String), userToken As String, ByRef longRunningProcessSessionKey As String) As AcquireTokenOnBehalfOfParameterBuilderParameters
- scopes
- IEnumerable<String>
Scopes requested to access a protected API.
- userToken
- String
A JSON Web Token which was used to call this web API and contains the credential information about the user on behalf of whom to get a token.
- longRunningProcessSessionKey
- String
Key by which to look up the token in the cache.
If null, it will be set to the assertion hash of the userToken by default.
Returns
A builder enabling you to add other parameters before executing the token request.