Options for the authorization URL

The client ID of the application

The redirect URI of the application

The response type of the authorization request

The scope of the authorization request

interface GetAuthorizationUrlOptions {
    acrValues?: string;
    callbackFactory?: JourneyCallbackFactory;
    clientId: string;
    display?: "page" | "popup" | "touch" | "wap";
    errorParams?: string[];
    login?: "redirect" | "embedded";
    loginHint?: string;
    middleware?: LegacyRequestMiddleware[];
    nonce?: string;
    oauthThreshold?: number;
    platformHeader?: boolean;
    prefix?: string;
    prompt?: "login" | "none" | "consent" | "select_account";
    query?: Record<string, string>;
    realmPath?: string;
    redirectUri?: string;
    responseMode?: ResponseMode;
    responseType: ResponseType;
    scope: string;
    serverConfig?: ServerConfig;
    state?: string;
    successParams?: string[];
    tokenStore?: CustomStorageObject | "sessionStorage" | "localStorage";
    tree?: string;
    type?: string;
    uiLocales?: string;
    verifier?: string;
}

Hierarchy (View Summary)

Properties

acrValues?: string
callbackFactory?: JourneyCallbackFactory
clientId: string

These three properties clientid, scope, responseType are required when using this type, which are not required when defining LegacyConfigOptions.

display?: "page" | "popup" | "touch" | "wap"
errorParams?: string[]
login?: "redirect" | "embedded"
loginHint?: string
nonce?: string
oauthThreshold?: number
platformHeader?: boolean
prefix?: string
prompt?: "login" | "none" | "consent" | "select_account"
query?: Record<string, string>
realmPath?: string
redirectUri?: string
responseMode?: ResponseMode
responseType: ResponseType
scope: string
serverConfig?: ServerConfig
state?: string
successParams?: string[]
tokenStore?: CustomStorageObject | "sessionStorage" | "localStorage"
tree?: string
type?: string
uiLocales?: string
verifier?: string