Class AutoAuthCredentialExchanger

Automatically selects the appropriate credential exchanger based on the auth scheme. Ported from Python implementation.

Example

// Common case: a built-in exchanger handles the credential.
const exchanger = new AutoAuthCredentialExchanger();
const result = await exchanger.exchange({
  authScheme: serviceAccountScheme,
  authCredential: serviceAccountCredential,
});
// result.credential carries an OAuth token as a bearer token.

Example

// Use CustomAuthExchanger for OAuth2 instead of the built-in exchanger.
const exchanger = new AutoAuthCredentialExchanger({
  [AuthCredentialTypes.OAUTH2]: new CustomAuthExchanger(),
});

Implements

BaseCredentialExchanger

Constructors

constructor

new AutoAuthCredentialExchanger(
    customExchangers?: Partial<
        Record<AuthCredentialTypes, BaseCredentialExchanger>,
    >,
): AutoAuthCredentialExchanger
Parameters
- OptionalcustomExchangers: Partial<Record<AuthCredentialTypes, BaseCredentialExchanger>>
  Optional exchangers that add to or override the built-in ones. The key is the auth credential type; the value is the exchanger instance to use for that type.
Returns AutoAuthCredentialExchanger
- Defined in core/src/tools/openapi_tool/auth/credential_exchangers/auto_auth_credential_exchanger.ts:57

Methods

exchange

exchange(
params: { authCredential: AuthCredential; authScheme?: AuthScheme },
): Promise<ExchangeResult>
Exchange credential if needed.
Parameters
- params: { authCredential: AuthCredential; authScheme?: AuthScheme }
  - authCredential: AuthCredential
    The credential to exchange.
  - OptionalauthScheme?: AuthScheme
    The authentication scheme (optional, some exchangers don't need it).
Returns Promise<ExchangeResult>
The exchanged credential.

Throws
CredentialExchangeError: If credential exchange fails.
Implementation of BaseCredentialExchanger.exchange
- Defined in core/src/tools/openapi_tool/auth/credential_exchangers/auto_auth_credential_exchanger.ts:79
exchange(
params: { authCredential?: AuthCredential; authScheme?: AuthScheme },
): Promise<ExchangeResult | null>
Parameters
- params: { authCredential?: AuthCredential; authScheme?: AuthScheme }
Returns Promise<ExchangeResult | null>
Implementation of BaseCredentialExchanger.exchange
- Defined in core/src/tools/openapi_tool/auth/credential_exchangers/auto_auth_credential_exchanger.ts:83

Class AutoAuthCredentialExchanger

Example

Example

Implements

Constructors

constructor

Parameters

Returns AutoAuthCredentialExchanger

Methods

exchange

Parameters

authCredential: AuthCredential

OptionalauthScheme?: AuthScheme

Returns Promise<ExchangeResult>

Throws

Parameters

Returns Promise<ExchangeResult | null>

`Optional`authScheme?: AuthScheme