Class UserManagerSettingsStore

The settings with defaults applied of the UserManager.

See

UserManagerSettings

Hierarchy (view full)

OidcClientSettingsStore
- UserManagerSettingsStore

Index

Constructors

constructor

Properties

accessTokenExpiringNotificationTimeInSeconds acr_values authority automaticSilentRenew checkSessionIntervalInSeconds client_authentication client_id client_secret disablePKCE display dpop extraHeaders extraQueryParams extraTokenParams fetchRequestCredentials filterProtocolClaims iframeNotifyParentOrigin iframeScriptOrigin includeIdTokenInSilentRenew includeIdTokenInSilentSignout loadUserInfo max_age mergeClaimsStrategy metadata metadataSeed metadataUrl monitorAnonymousSession monitorSession omitScopeWhenRequesting popup_post_logout_redirect_uri popup_redirect_uri popupWindowFeatures popupWindowTarget post_logout_redirect_uri prompt query_status_response_type redirect_uri redirectMethod redirectTarget refreshTokenAllowedScope requestTimeoutInSeconds resource response_mode response_type revokeTokenAdditionalContentTypes? revokeTokensOnSignout revokeTokenTypes scope signingKeys silent_redirect_uri silentRequestTimeoutInSeconds staleStateAgeInSeconds stateStore stopCheckSessionOnError ui_locales userStore validateSubOnSilentRenew

Constructors

constructor

new UserManagerSettingsStore(args): UserManagerSettingsStore
Parameters
- args: UserManagerSettings
Returns UserManagerSettingsStore
Overrides OidcClientSettingsStore.constructor
- Defined in src/UserManagerSettings.ts:125

Properties

`Readonly`accessTokenExpiringNotificationTimeInSeconds

accessTokenExpiringNotificationTimeInSeconds: number

`Readonly`acr_values

acr_values: undefined | string

`Readonly`authority

authority: string

`Readonly`automaticSilentRenew

automaticSilentRenew: boolean

`Readonly`checkSessionIntervalInSeconds

checkSessionIntervalInSeconds: number

`Readonly`client_authentication

client_authentication: "client_secret_post" | "client_secret_basic"

`Readonly`client_id

client_id: string

`Readonly`client_secret

client_secret: undefined | string

`Readonly`disablePKCE

disablePKCE: boolean

`Readonly`display

display: undefined | string

`Readonly`dpop

dpop: undefined | DPoPSettings

`Readonly`extraHeaders

extraHeaders: Record<string, ExtraHeader>

`Readonly`extraQueryParams

extraQueryParams: Record<string, string | number | boolean>

`Readonly`extraTokenParams

extraTokenParams: Record<string, unknown>

`Readonly`fetchRequestCredentials

fetchRequestCredentials: RequestCredentials

`Readonly`filterProtocolClaims

filterProtocolClaims: boolean | string[]

`Readonly`iframeNotifyParentOrigin

iframeNotifyParentOrigin: undefined | string

`Readonly`iframeScriptOrigin

iframeScriptOrigin: undefined | string

`Readonly`includeIdTokenInSilentRenew

includeIdTokenInSilentRenew: boolean

`Readonly`includeIdTokenInSilentSignout

includeIdTokenInSilentSignout: boolean

`Readonly`loadUserInfo

loadUserInfo: boolean

`Readonly`max_age

max_age: undefined | number

`Readonly`mergeClaimsStrategy

mergeClaimsStrategy: {
array: "replace" | "merge";
}

`Readonly`metadata

metadata: undefined | Partial<OidcMetadata>

`Readonly`metadataSeed

metadataSeed: undefined | Partial<OidcMetadata>

`Readonly`metadataUrl

metadataUrl: string

`Readonly`monitorAnonymousSession

monitorAnonymousSession: boolean

`Readonly`monitorSession

monitorSession: boolean

`Readonly`omitScopeWhenRequesting

omitScopeWhenRequesting: boolean

`Readonly`popup_post_logout_redirect_uri

popup_post_logout_redirect_uri: undefined | string

`Readonly`popup_redirect_uri

popup_redirect_uri: string

`Readonly`popupWindowFeatures

popupWindowFeatures: PopupWindowFeatures

`Readonly`popupWindowTarget

popupWindowTarget: string

`Readonly`post_logout_redirect_uri

post_logout_redirect_uri: undefined | string

`Readonly`prompt

prompt: undefined | string

`Readonly`query_status_response_type

query_status_response_type: string

`Readonly`redirect_uri

redirect_uri: string

`Readonly`redirectMethod

redirectMethod: "replace" | "assign"

`Readonly`redirectTarget

redirectTarget: "top" | "self"

`Readonly`refreshTokenAllowedScope

refreshTokenAllowedScope: undefined | string

`Readonly`requestTimeoutInSeconds

requestTimeoutInSeconds: undefined | number

`Readonly`resource

resource: undefined | string | string[]

`Readonly`response_mode

response_mode: undefined | "query" | "fragment"

`Readonly`response_type

response_type: string

`Optional` `Readonly`revokeTokenAdditionalContentTypes

revokeTokenAdditionalContentTypes?: string[]

`Readonly`revokeTokensOnSignout

revokeTokensOnSignout: boolean

`Readonly`revokeTokenTypes

revokeTokenTypes: ("access_token" | "refresh_token")[]

`Readonly`scope

scope: string

`Readonly`signingKeys

signingKeys: undefined | SigningKey[]

`Readonly`silent_redirect_uri

silent_redirect_uri: string

`Readonly`silentRequestTimeoutInSeconds

silentRequestTimeoutInSeconds: number

`Readonly`staleStateAgeInSeconds

staleStateAgeInSeconds: number

`Readonly`stateStore

stateStore: StateStore

`Readonly`stopCheckSessionOnError

stopCheckSessionOnError: boolean

`Readonly`ui_locales

ui_locales: undefined | string

`Readonly`userStore

userStore: WebStorageStateStore

`Readonly`validateSubOnSilentRenew

validateSubOnSilentRenew: boolean

Class UserManagerSettingsStore

See

Hierarchy (view full)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns UserManagerSettingsStore

Properties

ReadonlyaccessTokenExpiringNotificationTimeInSeconds

Readonlyacr_values

Readonlyauthority

ReadonlyautomaticSilentRenew

ReadonlycheckSessionIntervalInSeconds

Readonlyclient_authentication

Readonlyclient_id

Readonlyclient_secret

ReadonlydisablePKCE

Readonlydisplay

Readonlydpop

ReadonlyextraHeaders

ReadonlyextraQueryParams

ReadonlyextraTokenParams

ReadonlyfetchRequestCredentials

ReadonlyfilterProtocolClaims

ReadonlyiframeNotifyParentOrigin

ReadonlyiframeScriptOrigin

ReadonlyincludeIdTokenInSilentRenew

ReadonlyincludeIdTokenInSilentSignout

ReadonlyloadUserInfo

Readonlymax_age

ReadonlymergeClaimsStrategy

Readonlymetadata

ReadonlymetadataSeed

ReadonlymetadataUrl

ReadonlymonitorAnonymousSession

ReadonlymonitorSession

ReadonlyomitScopeWhenRequesting

Readonlypopup_post_logout_redirect_uri

Readonlypopup_redirect_uri

ReadonlypopupWindowFeatures

ReadonlypopupWindowTarget

Readonlypost_logout_redirect_uri

Readonlyprompt

Readonlyquery_status_response_type

Readonlyredirect_uri

ReadonlyredirectMethod

ReadonlyredirectTarget

ReadonlyrefreshTokenAllowedScope

ReadonlyrequestTimeoutInSeconds

Readonlyresource

Readonlyresponse_mode

Readonlyresponse_type

Optional ReadonlyrevokeTokenAdditionalContentTypes

ReadonlyrevokeTokensOnSignout

ReadonlyrevokeTokenTypes

Readonlyscope

ReadonlysigningKeys

Readonlysilent_redirect_uri

ReadonlysilentRequestTimeoutInSeconds

ReadonlystaleStateAgeInSeconds

ReadonlystateStore

ReadonlystopCheckSessionOnError

Readonlyui_locales

ReadonlyuserStore

ReadonlyvalidateSubOnSilentRenew

Settings

On This Page

`Readonly`accessTokenExpiringNotificationTimeInSeconds

`Readonly`acr_values

`Readonly`authority

`Readonly`automaticSilentRenew

`Readonly`checkSessionIntervalInSeconds

`Readonly`client_authentication

`Readonly`client_id

`Readonly`client_secret

`Readonly`disablePKCE

`Readonly`display

`Readonly`dpop

`Readonly`extraHeaders

`Readonly`extraQueryParams

`Readonly`extraTokenParams

`Readonly`fetchRequestCredentials

`Readonly`filterProtocolClaims

`Readonly`iframeNotifyParentOrigin

`Readonly`iframeScriptOrigin

`Readonly`includeIdTokenInSilentRenew

`Readonly`includeIdTokenInSilentSignout

`Readonly`loadUserInfo

`Readonly`max_age

`Readonly`mergeClaimsStrategy

`Readonly`metadata

`Readonly`metadataSeed

`Readonly`metadataUrl

`Readonly`monitorAnonymousSession

`Readonly`monitorSession

`Readonly`omitScopeWhenRequesting

`Readonly`popup_post_logout_redirect_uri

`Readonly`popup_redirect_uri

`Readonly`popupWindowFeatures

`Readonly`popupWindowTarget

`Readonly`post_logout_redirect_uri

`Readonly`prompt

`Readonly`query_status_response_type

`Readonly`redirect_uri

`Readonly`redirectMethod

`Readonly`redirectTarget

`Readonly`refreshTokenAllowedScope

`Readonly`requestTimeoutInSeconds

`Readonly`resource

`Readonly`response_mode

`Readonly`response_type

`Optional` `Readonly`revokeTokenAdditionalContentTypes

`Readonly`revokeTokensOnSignout

`Readonly`revokeTokenTypes

`Readonly`scope

`Readonly`signingKeys

`Readonly`silent_redirect_uri

`Readonly`silentRequestTimeoutInSeconds

`Readonly`staleStateAgeInSeconds

`Readonly`stateStore

`Readonly`stopCheckSessionOnError

`Readonly`ui_locales

`Readonly`userStore

`Readonly`validateSubOnSilentRenew