Edit

Share via


AuthClientAPI interface

Extends

AuthClientAPI$1

Methods

acquireFrontendAccessToken(AcquireFrontendAccessTokenParams)

Gets an AAD token for the scopes provided in the request.

Inherited Methods

acquireAccessToken(AcquireAccessTokenParams)

Gets an AAD token for the audience provided by the workload.

Method Details

acquireFrontendAccessToken(AcquireFrontendAccessTokenParams)

Gets an AAD token for the scopes provided in the request.

function acquireFrontendAccessToken(params: AcquireFrontendAccessTokenParams): Promise<AccessToken>

Parameters

params
AcquireFrontendAccessTokenParams

AcquireFrontendAccessTokenParams contains:

  1. scopes.

Returns

Promise<AccessToken>

A promise which resolves when the AAD token is fetched.

Inherited Method Details

acquireAccessToken(AcquireAccessTokenParams)

Gets an AAD token for the audience provided by the workload.

function acquireAccessToken(params: AcquireAccessTokenParams): Promise<AccessToken>

Parameters

params
AcquireAccessTokenParams

AcquireAccessTokenParams contains:

  1. additionalScopesToConsent.
  2. claimsForConditionalAccessPolicy. This is used when working with OBO flows. To understand how to work with this parameter, please see https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-on-behalf-of-flow#error-response-example

Returns

Promise<AccessToken>

A promise which resolves when the AAD token is fetched.

Inherited From AuthClientAPI$1.acquireAccessToken