Interface JourneyClientConfig

Configuration for creating a journey client instance.

Extends AsyncLegacyConfigOptions so that the same config object can be shared across journey-client, davinci-client, and oidc-client. Properties like clientId, scope, and redirectUri are accepted but not used by journey-client — a warning is logged when they are provided.

Example

const config: JourneyClientConfig = {
  serverConfig: {
    wellknown: 'https://am.example.com/am/oauth2/alpha/.well-known/openid-configuration',
  },
};
interface JourneyClientConfig {
    callbackFactory?: JourneyCallbackFactory;
    clientId?: string;
    middleware?: LegacyRequestMiddleware[];
    oauthThreshold?: number;
    platformHeader?: boolean;
    prefix?: string;
    realmPath?: string;
    redirectUri?: string;
    scope?: string;
    serverConfig: JourneyServerConfig;
    tokenStore?: CustomStorageObject | "sessionStorage" | "localStorage";
    tree?: string;
    type?: string;
}

Hierarchy (View Summary)

Properties

callbackFactory? clientId? middleware? oauthThreshold? platformHeader? prefix? realmPath? redirectUri? scope? serverConfig tokenStore? tree? type?

Properties

OptionalcallbackFactory

callbackFactory?: JourneyCallbackFactory

OptionalclientId

clientId?: string

Optionalmiddleware

middleware?: LegacyRequestMiddleware[]

OptionaloauthThreshold

oauthThreshold?: number

OptionalplatformHeader

platformHeader?: boolean

Optionalprefix

prefix?: string

OptionalrealmPath

realmPath?: string

OptionalredirectUri

redirectUri?: string

Optionalscope

scope?: string

serverConfig

serverConfig: JourneyServerConfig

OptionaltokenStore

tokenStore?: CustomStorageObject | "sessionStorage" | "localStorage"

Optionaltree

tree?: string

Optionaltype

type?: string

Settings

Member Visibility

On This Page

Properties