Interface GetAuthorizationUrlOptions

Options for the authorization URL

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

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 {
    acrValues?: string;
    authorizationDetails?: AuthorizationDetail[];
    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?: "none" | "login" | "consent" | "select_account";
    query?: Record<string, string>;
    realmPath?: string;
    redirectUri: string;
    responseMode?: "pi.flow" | "query" | "fragment" | "form_post";
    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? authorizationDetails? callbackFactory? clientId display? errorParams? login? loginHint? middleware? nonce? oauthThreshold? platformHeader? prefix? prompt? query? realmPath? redirectUri responseMode? responseType scope serverConfig? state? successParams? tokenStore? tree? type? uiLocales? verifier?

Properties

OptionalacrValues

acrValues?: string

OptionalauthorizationDetails

authorizationDetails?: AuthorizationDetail[]

Authorization details for Rich Authorization Requests (RAR)

OptionalcallbackFactory

callbackFactory?: JourneyCallbackFactory

clientId

clientId: string

Optionaldisplay

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

OptionalerrorParams

errorParams?: string[]

Optionallogin

login?: "redirect" | "embedded"

OptionalloginHint

loginHint?: string

Optionalmiddleware

middleware?: LegacyRequestMiddleware[]

Optionalnonce

nonce?: string

OptionaloauthThreshold

oauthThreshold?: number

OptionalplatformHeader

platformHeader?: boolean

Optionalprefix

prefix?: string

Optionalprompt

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

Optionalquery

query?: Record<string, string>

OptionalrealmPath

realmPath?: string

redirectUri

redirectUri: string

OptionalresponseMode

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

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

OptionaluiLocales

uiLocales?: string

Optionalverifier

verifier?: string

Settings

Member Visibility

On This Page

Properties