Class ChainedTokenCredential

Package version

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

Hierarchy

ChainedTokenCredential
- DefaultAzureCredential

Implements

TokenCredential

Index

Constructors

constructor

Methods

getToken

Constructors

constructor

new ChainedTokenCredential(...sources: TokenCredential[]): ChainedTokenCredential

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/credentials/chainedTokenCredential.ts:14
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

Methods

getToken

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

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/credentials/chainedTokenCredential.ts:42
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.

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 | null>

Generated using TypeDoc