Skip to main content

AuthenticateOptions

@authgear/capacitor

@authgear/capacitor / AuthenticateOptions

Interface: AuthenticateOptions

Auth UI authorization options

Properties​

authenticationFlowGroup?​

optional authenticationFlowGroup: string

Authentication flow group

colorScheme?​

optional colorScheme: ColorScheme

Override the color scheme

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".

page?​

optional page: string

Initial page to open. Valid values are 'login' and 'signup'.

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

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.

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.