Interface GetAuthorizationUrlOptions

Options used when requesting the authorization URL.

interface GetAuthorizationUrlOptions {
    responseType: ResponseType;
    callbackFactory?: FRCallbackFactory;
    clientId?: string;
    middleware?: RequestMiddleware[];
    realmPath?: string;
    redirectUri?: string;
    scope?: string;
    serverConfig?: ServerConfig;
    tokenStore?: TokenStoreObject | "sessionStorage" | "localStorage";
    tree?: string;
    type?: string;
    oauthThreshold?: number;
    logLevel?: LogLevel;
    logger?: LoggerFunctions<((...msgs: unknown[]) => void), ((...msgs: unknown[]) => void), ((...msgs: unknown[]) => void), ((...msgs: unknown[]) => void)>;
    platformHeader?: boolean;
    prefix?: string;
    state?: string;
    verifier?: string;
    query?: StringDict<string>;
    prompt?: "none" | "login" | "consent";
}

Hierarchy (view full)

Properties

responseType callbackFactory? clientId? middleware? realmPath? redirectUri? scope? serverConfig? tokenStore? tree? type? oauthThreshold? logLevel? logger? platformHeader? prefix? state? verifier? query? prompt?

Properties

responseType

responseType: ResponseType

OptionalcallbackFactory

callbackFactory?: FRCallbackFactory

OptionalclientId

clientId?: string

Optionalmiddleware

middleware?: RequestMiddleware[]

OptionalrealmPath

realmPath?: string

OptionalredirectUri

redirectUri?: string

Optionalscope

scope?: string

OptionalserverConfig

serverConfig?: ServerConfig

OptionaltokenStore

tokenStore?: TokenStoreObject | "sessionStorage" | "localStorage"

Optionaltree

tree?: string

Optionaltype

type?: string

OptionaloauthThreshold

oauthThreshold?: number

OptionallogLevel

logLevel?: LogLevel

Optionallogger

logger?: LoggerFunctions<((...msgs: unknown[]) => void), ((...msgs: unknown[]) => void), ((...msgs: unknown[]) => void), ((...msgs: unknown[]) => void)>

OptionalplatformHeader

platformHeader?: boolean

Optionalprefix

prefix?: string

Optionalstate

state?: string

Optionalverifier

verifier?: string

Optionalquery

query?: StringDict<string>

Optionalprompt

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

Settings

Member Visibility

On This Page

Properties