Interface GetAuthorizationUrlOptions

Define the options for the authorization URL

Param: clientId

The client ID of the application

Param: redirectUri

The redirect URI of the application

Param: responseType

The response type of the authorization request

Param: scope

The scope of the authorization request

interface GetAuthorizationUrlOptions {
    callbackFactory?: JourneyCallbackFactory;
    clientId: string;
    errorParams?: string[];
    login?: "redirect" | "embedded";
    middleware?: LegacyRequestMiddleware[];
    oauthThreshold?: number;
    platformHeader?: boolean;
    prefix?: string;
    prompt?: "none" | "login" | "consent";
    query?: Record<string, string>;
    realmPath?: string;
    redirectUri: string;
    responseMode?: "fragment" | "form_post" | "pi.flow" | "query";
    responseType: ResponseType;
    scope: string;
    serverConfig?: ServerConfig;
    state?: string;
    successParams?: string[];
    tokenStore?: CustomStorageObject | "sessionStorage" | "localStorage";
    tree?: string;
    type?: string;
    verifier?: string;
}

Hierarchy (View Summary)

Properties

callbackFactory? clientId errorParams? login? middleware? oauthThreshold? platformHeader? prefix? prompt? query? realmPath? redirectUri responseMode? responseType scope serverConfig? state? successParams? tokenStore? tree? type? verifier?

Properties

OptionalcallbackFactory

callbackFactory?: JourneyCallbackFactory

clientId

clientId: string

These four properties clientid, scope, responseType and redirectUri are required when using this type, which are not required when defining Config.

OptionalerrorParams

errorParams?: string[]

Optionallogin

login?: "redirect" | "embedded"

Optionalmiddleware

middleware?: LegacyRequestMiddleware[]

OptionaloauthThreshold

oauthThreshold?: number

OptionalplatformHeader

platformHeader?: boolean

Optionalprefix

prefix?: string

Optionalprompt

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

Optionalquery

query?: Record<string, string>

OptionalrealmPath

realmPath?: string

redirectUri

redirectUri: string

OptionalresponseMode

responseMode?: "fragment" | "form_post" | "pi.flow" | "query"

responseType

responseType: ResponseType

scope

scope: string

OptionalserverConfig

serverConfig?: ServerConfig

Optionalstate

state?: string

OptionalsuccessParams

successParams?: string[]

OptionaltokenStore

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

Optionaltree

tree?: string

Optionaltype

type?: string

Optionalverifier

verifier?: string

Settings

Member Visibility

On This Page

Properties