Interface OidcConfig

Configuration for creating an OIDC client instance.

interface OidcConfig {
    acrValues?: string;
    callbackFactory?: JourneyCallbackFactory;
    clientId: string;
    display?: AuthDisplayValue;
    log?: LogLevel;
    loginHint?: string;
    middleware?: LegacyRequestMiddleware[];
    nonce?: string;
    oauthThreshold?: number;
    par?: boolean;
    platformHeader?: boolean;
    prefix?: string;
    prompt?: AuthPromptValue;
    query?: Record<string, string>;
    realmPath?: string;
    redirectUri: string;
    responseType?: ResponseType;
    scope: string;
    serverConfig: { timeout?: number; wellknown: string };
    signOutRedirectUri?: string;
    tokenStore?: CustomStorageObject | "sessionStorage" | "localStorage";
    tree?: string;
    type?: string;
    uiLocales?: string;
}

Hierarchy (View Summary)

Properties

acrValues? callbackFactory? clientId display? log? loginHint? middleware? nonce? oauthThreshold? par? platformHeader? prefix? prompt? query? realmPath? redirectUri responseType? scope serverConfig signOutRedirectUri? tokenStore? tree? type? uiLocales?

Properties

OptionalacrValues

acrValues?: string

OptionalcallbackFactory

callbackFactory?: JourneyCallbackFactory

clientId

clientId: string

Optionaldisplay

display?: AuthDisplayValue

Optionallog

log?: LogLevel

OptionalloginHint

loginHint?: string

Optionalmiddleware

middleware?: LegacyRequestMiddleware[]

Optionalnonce

nonce?: string

OptionaloauthThreshold

oauthThreshold?: number

Optionalpar

par?: boolean

Use Pushed Authorization Requests (PAR) for the authorization flow.

OptionalplatformHeader

platformHeader?: boolean

Optionalprefix

prefix?: string

Optionalprompt

prompt?: AuthPromptValue

Optionalquery

query?: Record<string, string>

OptionalrealmPath

realmPath?: string

redirectUri

redirectUri: string

OptionalresponseType

responseType?: ResponseType

scope

scope: string

serverConfig

serverConfig: { timeout?: number; wellknown: string }

OptionalsignOutRedirectUri

signOutRedirectUri?: string

URI to redirect to after logout; maps to post_logout_redirect_uri in the end-session request.

OptionaltokenStore

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

Optionaltree

tree?: string

Optionaltype

type?: string

OptionaluiLocales

uiLocales?: string

Settings

Member Visibility

On This Page

Properties