Interface IPlusAuthClientOptions

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? idTokenValidator? id_token_hint? issuer login_hint? nonce? nonceLength? post_logout_redirect_uri? prompt? redirect_uri? registration? requestUserInfo? response_mode? response_type? scope? secondsToRefreshAccessTokenBeforeExp? silentRequestTimeout? silent_redirect_uri? state? stateLength? stateStore? ui_locales? useRefreshToken? web_message_target? web_message_uri?

Properties

Optional acr_values

acr_values?: string

Optional audience

audience?: string

Optional authStore

authStore?: StateStore<any>

Optional autoSilentRenew

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

Optional checkSession

checkSession?: boolean

Enable/Disable session monitoring.

Optional checkSessionInterval

checkSessionInterval?: number

Session checking interval in milliseconds. Defaults to 2000

Optional claims

claims?: Record<string, any>

Optional claims_locales

claims_locales?: string

client_id

client_id: string

Optional client_secret

client_secret?: string

Optional clockSkew

clockSkew?: number

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

Optional code_challenge

code_challenge?: string

Optional code_challenge_method

code_challenge_method?: string

Optional code_verifier

code_verifier?: string

Optional currentTimeInMillis

currentTimeInMillis?: (() => number)

Type declaration

    • (): 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.

      Returns number

Optional display

display?: string

Optional endpoints

endpoints?: IEndpointConfiguration

Optional extraLogoutParams

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

Type declaration

  • [key: string]: string

Optional extraParams

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

Type declaration

  • [key: string]: any

Optional fragment

fragment?: string

Optional httpClient

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

Type declaration

    • (options): Promise<any>

    • Parameters

      • options: RequestOptions

      Returns Promise<any>

Optional idTokenValidator

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

Type declaration

    • (idToken): 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.

      Parameters

      • idToken: string

        raw id token string

      Returns Promise<boolean>

Optional id_token_hint

id_token_hint?: string

issuer

issuer: string

Optional login_hint

login_hint?: string

Optional nonce

nonce?: string

Optional nonceLength

nonceLength?: number

Generated nonce length. Defaults to 10

Default

10

Optional post_logout_redirect_uri

post_logout_redirect_uri?: string

Optional prompt

prompt?: string

Optional redirect_uri

redirect_uri?: string

Optional registration

registration?: string

Optional requestUserInfo

requestUserInfo?: boolean

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

Optional response_mode

response_mode?: string

Optional response_type

response_type?: string

Optional scope

scope?: string

Optional secondsToRefreshAccessTokenBeforeExp

secondsToRefreshAccessTokenBeforeExp?: number

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

Optional silentRequestTimeout

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

Optional silent_redirect_uri

silent_redirect_uri?: string

Optional state

state?: string

Optional stateLength

stateLength?: number

Generated state length. Defaults to 10

Default

10

Optional stateStore

stateStore?: StateStore<any>

Custom state store. See StateStore

Optional ui_locales

ui_locales?: string

Optional useRefreshToken

useRefreshToken?: boolean

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

Optional web_message_target

web_message_target?: string

Optional web_message_uri

web_message_uri?: string

Settings

Member Visibility

Theme

On This Page