Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClientOptions

General configuration properties needed for ObeliskClient setup and Keycloak instance setup.

Hierarchy

  • ClientOptions

Index

Properties

apiVersion

apiVersion: string

Api version of the Obelisk API

Optional authMode

authMode: "entitlement" | "uma"

Authorization mode, uma-based per resource or entitlement for all permissions. Defaults to entitlement

clientId

clientId: string

Id of your client (you should have received this)

Optional flow

flow: "implicit" | "standard"

Flow of authentication: 'implicit' (browser apps), 'standard' (server apps). Implicit flows have no access to refresh tokens and are better suited to 'one-off' tasks. Defaults to standard

host

host: string

Url of the server (not ending in slash)

realm

realm: string

Authentication Realm