Module

auth

Classes

Auth

Type Definitions

Object

# FlowResult

Properties:
Name Type Description
idToken string

The raw OIDC ID token returned by the authorization server.

refreshToken string | undefined

The refresh token, if the IdP issued one.

user Object

Decoded payload of the ID token (claims such as sub, email, tenantId).

View Source auth.js, line 40

Object

# ServiceKey

Properties:
Name Type Attributes Default Description
client_id string

OAuth 2.0 client identifier.

client_secret string

OAuth 2.0 client secret.

token_uri string

Token endpoint URL (e.g. https://auth.example.com/token).

auth_uri string <optional>

Authorization endpoint URL, required for beginFlow.

jwks_uri string <optional>

JWKS endpoint URL, required for verify.

issuer string <optional>

Expected issuer claim, required for verify.

cloud_stack string <optional>

Override the base domain used to resolve service URLs (e.g. example.com). When omitted the SDK derives the base domain from issuer.

ssl boolean <optional>
true

Set to false to use plain HTTP (local dev only).

View Source auth.js, line 27