Interface: AuthClientOptions

Defined in: auth-server-ts/src/config.ts:51

Plain-data options for AuthClient. Everything except authServerUrl is optional; defaults mirror the auth-server’s own defaults.

Field-for-field map to PHP’s Vendidit\AuthServer\Config.

Properties

accessSecret?

optional accessSecret?: string

Defined in: auth-server-ts/src/config.ts:67

Shared HS256 secret. Must match the auth-server’s JWT_ACCESS_SECRET.

accessSecretPrevious?

optional accessSecretPrevious?: string

Defined in: auth-server-ts/src/config.ts:71

Rotation slot — the PREVIOUS secret while a new one is rolling in. Validator falls back to it ONLY on signature mismatch.

apiPrefix?

optional apiPrefix?: string

Defined in: auth-server-ts/src/config.ts:56

Path appended after the base URL. Default /api/v1.

appCode?

optional appCode?: string

Defined in: auth-server-ts/src/config.ts:59

App-code propagated as X-App-Code and the app_code body field on login/register.

authServerUrl?

optional authServerUrl?: string

Defined in: auth-server-ts/src/config.ts:53

Auth-server base URL (no API prefix). e.g. http://localhost:8080.

checkRevocation?

optional checkRevocation?: boolean

Defined in: auth-server-ts/src/config.ts:85

Read auth:blacklist:{jti} on every validation. Default true.

checkTokenVersion?

optional checkTokenVersion?: boolean

Defined in: auth-server-ts/src/config.ts:88

Read auth:user_tv:{user_id} to honour logout-all. Default true.

devUserId?

optional devUserId?: string

Defined in: auth-server-ts/src/config.ts:106

Dev synthetic-user id (framework adapters may consume this when enabled === false). Default dev-user.

enabled?

optional enabled?: boolean

Defined in: auth-server-ts/src/config.ts:102

Master switch. When false, methods that would issue a network request throw OfflineModeException. Default true.

httpTimeoutSeconds?

optional httpTimeoutSeconds?: number

Defined in: auth-server-ts/src/config.ts:62

Per-request timeout (seconds). Default 10.

jwtAudience?

optional jwtAudience?: string

Defined in: auth-server-ts/src/config.ts:77

Expected aud claim. Default ven-platform.

jwtIssuer?

optional jwtIssuer?: string

Defined in: auth-server-ts/src/config.ts:74

Expected iss claim. Default ven-auth.

jwtLeewaySeconds?

optional jwtLeewaySeconds?: number

Defined in: auth-server-ts/src/config.ts:80

Skew tolerance (seconds). Default 30 — matches the Go server’s parserLeeway.

ssoCallbackUrl?

optional ssoCallbackUrl?: string

Defined in: auth-server-ts/src/config.ts:93

This app’s SSO callback URL.

ssoPkceEnabled?

optional ssoPkceEnabled?: boolean

Defined in: auth-server-ts/src/config.ts:96

Always-on PKCE for SSO. Default true.