Skip to main content
Version: 1.12.0

Interface: ClientCredentialsAuthConfig

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

clientCredentials auth config (RFC 6749 §4.4).

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:119

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


clientId

clientId: string

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

OAuth2 client identifier.


clientSecret

clientSecret: string

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

OAuth2 client secret (machine-to-machine).


scopes?

optional scopes?: string[]

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

OAuth2 scopes. Defaults to ["daml_ledger_api"].


type

type: "clientCredentials"

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

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

Overrides

AuthConfigBase.type