Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChallengeCallbackOptions

Package version

Options sent to the challenge callbacks

Hierarchy

  • ChallengeCallbackOptions

Index

Properties

Optional claims

claims: undefined | string

Additional claims to be included in the token. For more information on format and content: the claims parameter specification.

getToken

getToken: (scopes: string | string[], options: GetTokenOptions) => Promise<AccessToken | null>

Function that retrieves either a cached token or a new token.

Type declaration

    • (scopes: string | string[], options: GetTokenOptions): Promise<AccessToken | null>
    • Parameters

      • scopes: string | string[]
      • options: GetTokenOptions

      Returns Promise<AccessToken | null>

Optional previousToken

previousToken: AccessToken

Copy of the last token used, if any.

request

request: PipelineRequest

Request that the policy is trying to fulfill.

scopes

scopes: string | string[]

The scopes for which the bearer token applies.

setAuthorizationHeader

setAuthorizationHeader: (token: string) => void

Function that allows easily assigning a token to the request.

Type declaration

    • (token: string): void
    • Parameters

      • token: string

      Returns void

Generated using TypeDoc