@authgear/web / AuthenticateOptions
Interface: AuthenticateOptions
Auth UI authorization options
Table of contents
Properties
Properties
authenticationFlowGroup
• Optional authenticationFlowGroup: string
Authentication flow group
Defined in
packages/authgear-web/index.d.ts:444
oauthProviderAlias
• Optional oauthProviderAlias: string
Auto-redirect the user to the OAuth provider. You can set the value for each OAuth provider in Authgear portal via Authentication > Social / Enterprise Login.
For example, to auto-redirect your users to sign in with Google, first, set the alias for Sign in with Google to "google" in Authgear portal, then set oauthProviderAlias to "google".
Defined in
packages/authgear-web/index.d.ts:440
page
• Optional page: string
Initial page to open. Valid values are 'login' and 'signup'.
Defined in
packages/authgear-web/index.d.ts:432
prompt
• Optional prompt: PromptOption | PromptOption[]
OIDC prompt parameter.
Prompt parameter will be used for Authgear authorization, it will also be forwarded to the underlying SSO providers.
For Authgear, currently, only login is supported. Other unsupported values will be ignored.
For the underlying SSO providers, some providers only support a single value rather than a list. The first supported value will be used for that case. e.g. Azure Active Directory
Defined in
packages/authgear-web/index.d.ts:419
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:396
state
• Optional state: string
OAuth 2.0 state value.
Defined in
packages/authgear-web/index.d.ts:400
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:428
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.
Defined in
packages/authgear-web/index.d.ts:406