Class BasicAuthCredential

Basic authentication credential

Hierarchy (view full)

AuthCredential
- BasicAuthCredential

Index

Constructors

Properties

type username password

Methods

canRefresh refresh getToken getHeaders

Constructors

constructor

new BasicAuthCredential(username, password): BasicAuthCredential
Constructor for BasicAuthCredential
Parameters
- username: string
- password: string
Returns BasicAuthCredential
Overrides AuthCredential.constructor
- Defined in packages/adk/src/auth/auth-credential.ts:111

Properties

type

type: AuthCredentialType

Type of credential

username

username: string

The username

password

password: string

The password

Methods

canRefresh

canRefresh(): boolean
Whether the token can be refreshed

Returns boolean
Inherited from AuthCredential.canRefresh
- Defined in packages/adk/src/auth/auth-credential.ts:44

refresh

refresh(): Promise<void>
Refreshes the token

Returns Promise<void>
Inherited from AuthCredential.refresh
- Defined in packages/adk/src/auth/auth-credential.ts:51

getToken

getToken(): string
Gets the encoded basic auth token

Returns string
Overrides AuthCredential.getToken
- Defined in packages/adk/src/auth/auth-credential.ts:120

getHeaders

getHeaders(): Record<string, string>
Gets headers for HTTP requests

Returns Record<string, string>
Overrides AuthCredential.getHeaders
- Defined in packages/adk/src/auth/auth-credential.ts:127