Class EnhancedAuthConfig

Enhanced auth configuration with credential handling This extends the basic AuthConfig with raw and exchanged credentials

Index

Constructors

constructor

new EnhancedAuthConfig(config): EnhancedAuthConfig
Constructor for EnhancedAuthConfig
Parameters
- config: {
      authScheme: AuthScheme;
      rawAuthCredential?: AuthCredential;
      exchangedAuthCredential?: AuthCredential;
      credentialKey?: string;
      context?: Record<string, any>;
  }
  - authScheme: AuthScheme
  - OptionalrawAuthCredential?: AuthCredential
  - OptionalexchangedAuthCredential?: AuthCredential
  - OptionalcredentialKey?: string
  - Optionalcontext?: Record<string, any>
Returns EnhancedAuthConfig
- Defined in packages/adk/src/auth/auth-tool.ts:40

Properties

authScheme

authScheme: AuthScheme

The authentication scheme

`Optional`rawAuthCredential

rawAuthCredential?: AuthCredential

Raw auth credential used to collect credentials Used in auth schemes that need to exchange credentials (e.g. OAuth2, OIDC)

`Optional`exchangedAuthCredential

exchangedAuthCredential?: AuthCredential

Exchanged auth credential after processing Filled by ADK and client working together

`Optional`credentialKey

credentialKey?: string

User-specified key for credential storage and retrieval

`Optional`context

context?: Record<string, any>

Additional context properties

Methods

getCredentialKey

getCredentialKey(): string
Gets the credential key for storage

Returns string
- Defined in packages/adk/src/auth/auth-tool.ts:71

Class EnhancedAuthConfig

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

authScheme: AuthScheme

`Optional`rawAuthCredential?: AuthCredential

`Optional`exchangedAuthCredential?: AuthCredential

`Optional`credentialKey?: string

`Optional`context?: Record<string, any>

Returns EnhancedAuthConfig

Properties

authScheme

`Optional`rawAuthCredential

`Optional`exchangedAuthCredential

`Optional`credentialKey

`Optional`context

Methods

getCredentialKey

Returns string

Settings

On This Page

Class EnhancedAuthConfig

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

authScheme: AuthScheme

OptionalrawAuthCredential?: AuthCredential

OptionalexchangedAuthCredential?: AuthCredential

OptionalcredentialKey?: string

Optionalcontext?: Record<string, any>

Returns EnhancedAuthConfig

Properties

authScheme

OptionalrawAuthCredential

OptionalexchangedAuthCredential

OptionalcredentialKey

Optionalcontext

Methods

getCredentialKey

Returns string

Settings

On This Page

`Optional`rawAuthCredential?: AuthCredential

`Optional`exchangedAuthCredential?: AuthCredential

`Optional`credentialKey?: string

`Optional`context?: Record<string, any>

`Optional`rawAuthCredential

`Optional`exchangedAuthCredential

`Optional`credentialKey

`Optional`context