Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
Sruthi Keerthi Rangavajhula (from Dev Box) committed Jun 18, 2024
1 parent 88f6c97 commit 6f84321
Showing 1 changed file with 7 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,18 @@ Task<string> CreateAuthorizationHeaderForAppAsync(
/// </summary>
/// <param name="scopes">The scopes for which to request the authorization header.
/// Provide a single scope if the header needs to be created on behalf of an application.</param>
/// <param name="options">Options containing information about the API to be called and token acquisition settings.
/// If not provided, the header will be for a bearer token.</param>
/// <param name="subject">The claims principal representing the authenticated user or entity making the request.
/// Typically provided in a web API or web app context; not usually needed in daemon applications.</param>
/// <param name="options">The <see cref="AuthorizationHeaderProviderOptions"/> containing information about the API
/// to be called and token acquisition settings. If not provided, the header will be for a bearer token.</param>
/// <param name="claimsPrincipal">Inbound authentication elements. In a web API, this is usually the result of the
/// validation of a token. In a web app, this would be information about the signed-in user. This is not useful in
/// daemon applications. In Microsoft.Identity.Web you rarely need to provide this parameter as it's inferred from the
/// context.</param>
/// <param name="cancellationToken">A token to cancel the operation.</param>
/// <returns>A string containing the authorization header, such as "Bearer token" or "PoP token".</returns>
Task<string> CreateAuthorizationHeaderAsync(
IEnumerable<string> scopes,
AuthorizationHeaderProviderOptions? options = null,
ClaimsPrincipal? subject = null,
ClaimsPrincipal? claimsPrincipal = null,
CancellationToken cancellationToken = default);
}
}

0 comments on commit 6f84321

Please sign in to comment.