Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChainedTokenCredential

Package version

Enables multiple TokenCredential implementations to be tried in order until one of the getToken methods returns an access token.

Hierarchy

Implements

  • any

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates an instance of ChainedTokenCredential using the given credentials.

    Parameters

    • Rest ...sources: TokenCredential[]

      TokenCredential implementations to be tried in order.

      Example usage:

      const firstCredential = new ClientSecretCredential(tenantId, clientId, clientSecret);
const secondCredential = new ClientSecretCredential(tenantId, anotherClientId, anotherSecret);
const credentialChain = new ChainedTokenCredential(firstCredential, secondCredential);

    Returns ChainedTokenCredential

Properties

Protected UnavailableMessage

UnavailableMessage: string = "ChainedTokenCredential => failed to retrieve a token from the included credentials"

The message to use when the chained token fails to get a token

Methods

getToken

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

  • Returns the first access token returned by one of the chained TokenCredential implementations. Throws an AggregateAuthenticationError when one or more credentials throws an AuthenticationError and no credentials have returned an access token.

    This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.

    Parameters

    • scopes: string | string[]

      The list of scopes for which the token will have access.

    • Optional options: GetTokenOptions

      The options used to configure any requests this TokenCredential implementation might make.

    Returns Promise<AccessToken>

Generated using TypeDoc