Interface IPlusAuthClientOptions

interface IPlusAuthClientOptions {
    acr_values?: string;
    audience?: string;
    authStore?: StateStore<any>;
    autoSilentRenew?: boolean;
    checkSession?: boolean;
    checkSessionInterval?: number;
    claims?: Record<string, any>;
    claims_locales?: string;
    client_id: string;
    client_secret?: string;
    clockSkew?: number;
    code_challenge?: string;
    code_challenge_method?: string;
    code_verifier?: string;
    currentTimeInMillis?: () => number;
    display?: string;
    endpoints?: IEndpointConfiguration;
    extraLogoutParams?: { [key: string]: string };
    extraParams?: { [key: string]: any };
    fragment?: string;
    httpClient?: (options: RequestOptions) => Promise<any>;
    id_token_hint?: string;
    idTokenValidator?: (idToken: string) => Promise<boolean>;
    issuer: string;
    login_hint?: string;
    nonce?: string;
    nonceLength?: number;
    post_logout_redirect_uri?: string;
    prompt?: string;
    redirect_uri?: string;
    registration?: string;
    requestUserInfo?: boolean;
    response_mode?: string;
    response_type?: string;
    scope?: string;
    secondsToRefreshAccessTokenBeforeExp?: number;
    silent_redirect_uri?: string;
    silentRequestTimeout?: number;
    state?: string;
    stateLength?: number;
    stateStore?: StateStore<any>;
    ui_locales?: string;
    useRefreshToken?: boolean;
    web_message_target?: string;
    web_message_uri?: string;
}

Hierarchy

Properties

acr_values? audience? authStore? autoSilentRenew? checkSession? checkSessionInterval? claims? claims_locales? client_id client_secret? clockSkew? code_challenge? code_challenge_method? code_verifier? currentTimeInMillis? display? endpoints? extraLogoutParams? extraParams? fragment? httpClient? id_token_hint? idTokenValidator? issuer login_hint? nonce? nonceLength? post_logout_redirect_uri? prompt? redirect_uri? registration? requestUserInfo? response_mode? response_type? scope? secondsToRefreshAccessTokenBeforeExp? silent_redirect_uri? silentRequestTimeout? state? stateLength? stateStore? ui_locales? useRefreshToken? web_message_target? web_message_uri?

Properties

Optionalacr_values

acr_values?: string

Optionalaudience

audience?: string

OptionalauthStore

authStore?: StateStore<any>

OptionalautoSilentRenew

autoSilentRenew?: boolean

Enable/disable automatic access token renewal. If enabled, access tokens will be refreshed by using silent login in an iframe before they expire.

Also see secondsToRefreshAccessTokenBeforeExp

OptionalcheckSession

checkSession?: boolean

Enable/Disable session monitoring.

OptionalcheckSessionInterval

checkSessionInterval?: number

Session checking interval in milliseconds. Defaults to 2000

Optionalclaims

claims?: Record<string, any>

Optionalclaims_locales

claims_locales?: string

client_id

client_id: string

Optionalclient_secret

client_secret?: string

OptionalclockSkew

clockSkew?: number

The amount of clock skew tolerated for time comparisons between the Authorization server and client in seconds.

Optionalcode_challenge

code_challenge?: string

Optionalcode_challenge_method

code_challenge_method?: string

Optionalcode_verifier

code_verifier?: string

OptionalcurrentTimeInMillis

currentTimeInMillis?: () => number

Custom current time function to be used for time related operations. If client clock is far ahead or far before from authorization server's time, token validations will fail. If any Network Time Protocol service used, use this method to provide current time to the library.

Optionaldisplay

display?: string

Optionalendpoints

endpoints?: IEndpointConfiguration

OptionalextraLogoutParams

extraLogoutParams?: { [key: string]: string }

OptionalextraParams

extraParams?: { [key: string]: any }

Optionalfragment

fragment?: string

OptionalhttpClient

httpClient?: (options: RequestOptions) => Promise<any>

Optionalid_token_hint

id_token_hint?: string

OptionalidTokenValidator

idTokenValidator?: (idToken: string) => Promise<boolean>

Additional id token validator. By default only payload fields validated. If you need additional validations, like signature validation, you should implement and provide it with this option.

Type declaration

    • (idToken: string): Promise<boolean>

    • Parameters

      • idToken: string

        raw id token string

      Returns Promise<boolean>

issuer

issuer: string

Optionallogin_hint

login_hint?: string

Optionalnonce

nonce?: string

OptionalnonceLength

nonceLength?: number

Generated nonce length. Defaults to 10

Default

10

Optionalpost_logout_redirect_uri

post_logout_redirect_uri?: string

Optionalprompt

prompt?: string

Optionalredirect_uri

redirect_uri?: string

Optionalregistration

registration?: string

OptionalrequestUserInfo

requestUserInfo?: boolean

Fetch user profile by using UserInfo Request after successful authorization. Usually this wouldn't not be necessary if id token is received.

Optionalresponse_mode

response_mode?: string

Optionalresponse_type

response_type?: string

Optionalscope

scope?: string

OptionalsecondsToRefreshAccessTokenBeforeExp

secondsToRefreshAccessTokenBeforeExp?: number

The number of seconds before an access token is to expire to renew it automatically. Related to autoSilentRenew

Optionalsilent_redirect_uri

silent_redirect_uri?: string

OptionalsilentRequestTimeout

silentRequestTimeout?: number

Number of seconds to wait for the silent renew to return before assuming it has failed or timed out (default: 10). Related to autoSilentRenew

Optionalstate

state?: string

OptionalstateLength

stateLength?: number

Generated state length. Defaults to 10

Default

10

OptionalstateStore

stateStore?: StateStore<any>

Custom state store. See StateStore

Optionalui_locales

ui_locales?: string

OptionaluseRefreshToken

useRefreshToken?: boolean

If true, refresh tokens will be used for renewing access token. If false, authorization request will be performed silently in an iframe.

Optionalweb_message_target

web_message_target?: string

Optionalweb_message_uri

web_message_uri?: string

Settings

Member Visibility

On This Page

Properties