PromoteOptions
@authgear/web / PromoteOptions
Interface: PromoteOptions
Auth UI anonymous user promotion options
Table of contents
Properties
Properties
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.
Defined in
packages/authgear-web/index.d.ts:405
responseType
• Optional responseType: "code" | "none"
OAuth response type
Defined in
packages/authgear-web/index.d.ts:426
state
• Optional state: string
OAuth 2.0 state value.
Defined in
packages/authgear-web/index.d.ts:409
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.
Defined in
packages/authgear-web/index.d.ts:422
xState
• Optional xState: string
Custom state.
Defined in
packages/authgear-web/index.d.ts:413