API Reference

---

API Reference / EnableAutoTokenManagementOptions

Interface: EnableAutoTokenManagementOptions

Defined in: src/auth/TokenManager.ts:6

Properties

clientId

clientId: string

Defined in: src/auth/TokenManager.ts:7

---

pin

pin: string

Defined in: src/auth/TokenManager.ts:8

---

totpSecret?

optional totpSecret?: string

Defined in: src/auth/TokenManager.ts:14

Base32 TOTP secret. Either this or totpProvider is required — supply totpProvider instead when the code comes from a hardware token or an external MFA service rather than a stored secret.

---

totpProvider?

optional totpProvider?: () => string | Promise<string>

Defined in: src/auth/TokenManager.ts:16

Returns a current 6-digit code. Takes precedence over totpSecret.

Returns

string | Promise<string>

---

renewBeforeMs?

optional renewBeforeMs?: number

Defined in: src/auth/TokenManager.ts:18

How long before expiry to renew. Defaults to 5 minutes.

---

onToken?

optional onToken?: (token) => void

Defined in: src/auth/TokenManager.ts:20

Called after every successful generate or renew.

Parameters

token

TokenResponse

Returns

void