Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthClientOptions

Base AuthClient configuration.

The camelCased options are aliases of the snake_cased options, supporting both JSON API and JS conventions.

Hierarchy

Index

Properties

Properties

Optional credentials

credentials?: Credentials

Optional eagerRefreshThresholdMillis

eagerRefreshThresholdMillis?: number

The expiration threshold in milliseconds before forcing token refresh of unexpired tokens.

Optional forceRefreshOnFailure

forceRefreshOnFailure?: boolean

Whether to attempt to refresh tokens on status 401/403 responses even if an attempt is made to refresh the token preemptively based on the expiry_date.

projectId

projectId: undefined | null | string

project_id

project_id: undefined | null | string

quotaProjectId

quotaProjectId: undefined | string

quota_project_id

quota_project_id: undefined | string

Optional transporter

transporter?: Transporter | Gaxios

A Gaxios or Transporter instance to use for AuthClient requests.

Optional transporterOptions

transporterOptions?: GaxiosOptions

Provides default options to the transporter, such as agent or retryConfig.

universeDomain

universeDomain: undefined | string

universe_domain

universe_domain: undefined | string