Interface OidcConfig

Configuration for creating an OIDC client instance.

interface OidcConfig {
    acrValues?: string;
    callbackFactory?: JourneyCallbackFactory;
    clientId: string;
    display?: "page" | "popup" | "touch" | "wap";
    log?: LogLevel;
    loginHint?: string;
    middleware?: LegacyRequestMiddleware[];
    nonce?: string;
    oauthThreshold?: number;
    par?: boolean;
    platformHeader?: boolean;
    prefix?: string;
    prompt?: "none" | "login" | "consent" | "select_account";
    query?: Record<string, string>;
    realmPath?: string;
    redirectUri: string;
    responseType?: ResponseType;
    scope: string;
    serverConfig: { timeout?: number; wellknown: string };
    signOutRedirectUri?: string;
    state?: 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? state? tokenStore? tree? type? uiLocales?

Properties

OptionalacrValues

acrValues?: string

Space-separated Authentication Context Class Reference values requested for the authentication.

OptionalcallbackFactory

callbackFactory?: JourneyCallbackFactory

clientId

clientId: string

Optionaldisplay

display?: "page" | "popup" | "touch" | "wap"

Controls the display mode for the authorization UI.

Optionallog

log?: LogLevel

Log level for the client logger when initialized from a unified JSON config.

OptionalloginHint

loginHint?: string

Pre-fill the login_hint parameter in the authorization request.

Optionalmiddleware

middleware?: LegacyRequestMiddleware[]

Optionalnonce

nonce?: string

String value used to associate a client session with an ID token and mitigate replay attacks.

OptionaloauthThreshold

oauthThreshold?: number

Optionalpar

par?: boolean

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

OptionalplatformHeader

platformHeader?: boolean

Optionalprefix

prefix?: string

Optionalprompt

prompt?: "none" | "login" | "consent" | "select_account"

Specifies whether the authorization server should prompt the user for re-authentication or consent.

Optionalquery

query?: Record<string, string>

Additional query parameters to append to the authorization URL.

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.

Optionalstate

state?: string

Opaque value used to maintain state between the request and callback.

OptionaltokenStore

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

Optionaltree

tree?: string

Optionaltype

type?: string

OptionaluiLocales

uiLocales?: string

Space-separated BCP47 language tag values indicating the preferred display language for the UI.

Settings

Member Visibility

On This Page

Properties