Edit

Share via

AcquireAccessTokenParams interface

  • Reference
Package:
@ms-fabric/workload-client

Properties

additionalScopesToConsent

Additional scopes to consent when asking for a token, when passing this, the user will be presented with a consent for the scopes passed. This should be used when failing to perform OBO flows in the workload's Backend.
claimsForConditionalAccessPolicy

claims that are returned as a part of msalUiRequiredException in case the token exchange failed due to conditional access policy. If defined, the user will be presented with a window to perform an action according to the conditional access policy configured.
promptFullConsent

If true, the user will be presented with a full consent of the static dependencies of the workload's application as configured in Entra Id (and additionalScopesToConsent parameter will be ignored). This should only be true when needed to avoid presenting the user with consents redundantly.

Property Details

additionalScopesToConsent

Additional scopes to consent when asking for a token, when passing this, the user will be presented with a consent for the scopes passed. This should be used when failing to perform OBO flows in the workload's Backend.

additionalScopesToConsent?: string[]

Property Value

string[]

claimsForConditionalAccessPolicy

claims that are returned as a part of msalUiRequiredException in case the token exchange failed due to conditional access policy. If defined, the user will be presented with a window to perform an action according to the conditional access policy configured.

claimsForConditionalAccessPolicy?: string

Property Value

string

promptFullConsent

If true, the user will be presented with a full consent of the static dependencies of the workload's application as configured in Entra Id (and additionalScopesToConsent parameter will be ignored). This should only be true when needed to avoid presenting the user with consents redundantly.

promptFullConsent?: boolean

Property Value

boolean