ReauthenticateOptions

@authgear/web

---

@authgear/web / ReauthenticateOptions

Interface: ReauthenticateOptions

Options for reauthentication

Properties

authenticationFlowGroup?

optional authenticationFlowGroup: string

Authentication flow group

---

maxAge?

optional maxAge: number

OIDC max_age

---

redirectURI

redirectURI: string

The value should be a valid Redirect URI to which the response will be sent after authentication. You must also add a Redirect URI in Authgear Poral via the Redirect URI section of your Authgear Application.

---

state?

optional state: string

OAuth 2.0 state value.

---

uiLocales?

optional uiLocales: string[]

UI locale tags. You can use this parameter to set the display language for Auth UI.

First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)

For example, to change the language for Auth UI to Hong Kong, set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.

---

xState?

optional xState: string

Custom state. Use this parameter to provide parameters from the client application to Custom UI. The string in xState can be accessed by the Custom UI.

Ignore this parameter if default AuthUI is used.