Interface: AuthorizationCodeAuthConfig

Defined in: canton/authentication/types.ts:131

authorizationCode auth config (RFC 6749 §4.1 + PKCE RFC 7636).

Extends

• AuthConfigBase

Properties

audience?

optional audience?: string

Defined in: canton/authentication/types.ts:101

OAuth2 "audience" request parameter (Auth0-specific extension).

Identifies the API the issued access token should target (its JWT aud claim). Only honored by Auth0 (or servers emulating Auth0); Okta/Keycloak ignore it. Applicable to clientCredentials and authorizationCode only.

Inherited from

AuthConfigBase.audience

---

authUrl

authUrl: string

Defined in: canton/authentication/types.ts:134

OIDC authorization server base URL (e.g. https://auth.example.com).

---

callbackUrl?

optional callbackUrl?: string

Defined in: canton/authentication/types.ts:140

Local redirect URI. Defaults to http://localhost:8400/callback.

---

clientId

clientId: string

Defined in: canton/authentication/types.ts:136

OAuth2 client identifier.

---

openBrowser?

optional openBrowser?: boolean

Defined in: canton/authentication/types.ts:142

Open the browser automatically (default true).

---

scopes?

optional scopes?: string[]

Defined in: canton/authentication/types.ts:138

OAuth2 scopes. Defaults to ["openid", "daml_ledger_api"].

---

timeoutMs?

optional timeoutMs?: number

Defined in: canton/authentication/types.ts:144

Overall flow timeout in ms (default 120_000).

---

type

type: "authorizationCode"

Defined in: canton/authentication/types.ts:132

Auth scheme selector. Defaults to "static" when omitted (backward compatible).

Overrides

AuthConfigBase.type