allowForgotPassword boolean |
Boolean that specifies if the forgot password option is enabled.
|
If the allowLogin and allowSignup properties are set to false , the forgot password feature is enabled even if allowForgotPassword is set to false .
|
|
allowWebAuthnLogin boolean |
Boolean that specifies whether biometric login is enabled.
|
allowWebAuthnSignup boolean |
Boolean that specifies whether biometric signup is enabled.
|
allowLogin boolean |
Boolean that specifies whether login is enabled.
|
allowSignup boolean |
Boolean that specifies whether signup is enabled.
|
allowCustomIdentifier boolean |
Boolean that specifies whether an additional field for the custom identifier is shown.
|
auth object |
List of authentication options
responseType string |
The desired OAuth2 grant type. Use code to request an authorization code (recommended) or token for a token set (implicit grant, discouraged).
Defaults to code when redirectUri is provided, and to token otherwise. For messenger account linking, responseType should be set to messenger_code .
|
redirectUri string |
The URL where the user will be redirected back to after authentication.
This value is required with code response type and defaults to the current page with token response type. For messenger account linking, redirectUri should be set with the redirect_uri query param provided by Facebook on URL.
|
state string |
Persist data between user being directed to the authorization server and back again.
Use case: help mitigate CSRF attacks or indicating which app’s pages to redirect to after authorization. Could be Base64 encoded JSON object, JWT or nonce.
|
prompt string |
Specify whether the social provider should explicitly prompt the user for reauthentication or consent.
-
none : Require that no user interaction take place. This is typically used to silenty check for existing authentication and/or consent.
-
login : The social provider should prompt the user for reauthentication before consent, otherwise an error must be returned to the client (login_required ).
-
consent : The social provider should prompt for consent, otherwise an error must be returned to the client (consent_required ).
-
select_account : The social provider should prompt for user account selection, and if account selection is impossible, return an error (account_selection_required ).
|
nonce string |
String value used to associate a local session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified to the ID Token.
|
popupMode boolean |
Boolean that specifies whether to use popup mode or not.
Options
-
true = A popup window is opened to the social provider login page.
-
false = Instead of a popup window, the user is redirected (in the same window) to the social provider login page.
|
This mode is not recommended due to known bugs in Android or Firefox in iOS.
|
|
origin string |
Free text parameter describing the source of the login (only for reporting purposes).
|
scope string[] |
List of space-delimited, case-sensitive strings representing the requested scope.
Optional if the fetchBasicProfile option is set to true and the profile , email , phone and openid scope values are allowed in client configuration.
|
fetchBasicProfile boolean |
Fetch user’s basic profile information when they sign in. Adds profile , email , phone and openid to the requested scopes.
|
accessToken string |
Enables social login linking to an existing account with a fresh token (less than 5 minutes old).
|
providerScope string |
List of space-delimited, case-sensitive strings representing the requested scope at the social provider.
Defaults to the scope configured for the given provider in your ReachFive console.
|
Only for login with social provider.
|
|
requireRefreshToken boolean |
If set to true , an OAuth 2.0 Refresh Token will be present in the token response.
Fetch user basic profile information when they sign in. Adds profile , email , phone and openid to the requested scope.
|
Refresh Tokens are only available in confidential Clients (with a configured authentication method) or for public Clients that enforce PKCE in the authorization code grant. The Refresh Token option must also be selected.
|
|
|
canShowPassword boolean |
Whether or not to provide the display password in clear text option.
|
container HTMLElement id |
The DOM element or the id of a DOM element in which the widget should be embedded.
|
countryCode string |
Defaults to the predefined country code in your account settings or FR .
|
displaySafeErrorMessage boolean |
Whether or not to display a safe error message on password reset, given an invalid email address. This mode ensures not to leak email addresses registered to the platform.
|
i18n object |
Widget labels and error messages to override. Falls back to the default wordings in en , fr , es , it and nl .
|
For example, you might re-word the socialAccounts.linkNewAccount or change the way other wordings display to the user while leaving the remaining text on the widget intact.
|
|
initialScreen string |
The widget’s initial screen.
|
Possible values: login , login-with-web-authn , signup or forgot-password .
-
if allowLogin is set to true , it defaults to login .
-
if allowLogin is set to false and allowSignup is set to true , it defaults to signup .
-
if allowLogin is set to false and allowWebAuthnLogin is set to true , it defaults to login-with-web-authn .
-
otherwise, defaults to forgot-password .
|
|
onReady function |
Callback function called after the widget has been successfully loaded and rendered inside the container. The callback is called with the widget instance.
|
redirectUrl string |
The URL sent in the email to which the user is redirected. This URL must be whitelisted in the Allowed Callback URLs field of your ReachFive client settings.
|
returnToAfterEmailConfirmation string |
Returned in the redirectUrl as a query parameter, this parameter is used as the post-email confirmation URL.
|
returnToAfterPasswordReset string |
Returned in the redirectUrl as a query parameter, this parameter is used to redirect users to a specific URL after a password reset.
|
showLabels boolean |
Whether the signup form fields' labels are displayed on the login view.
|
showRememberMe boolean |
Whether the Remember me checkbox is displayed on the login view. Affects user session duration.
The account session duration configured in the ReachFive Console () applies when:
If the checkbox is visible and not selected by the user, the default session duration of 1 day applies.
|
signupFields string |
List of the signup fields to display in the form.
|
Defaults to ["given_name", "family_name", "email", "password", "password_confirmation"] .
|
A field is either a string representing the field’s key (predefined, custom field, or consent) or an object with attributes overriding the default field configuration.
-
Given name: given_name
-
Family name: family_name
-
Email address: email
-
Phone number: phone_number (both the international format and the national conventions of the account’s country are accepted if configured in your account settings)
-
Custom Identifier: custom_identifier (this is used to authenticate with something other than a username or password). For more, see the user profile model page.
-
Password: password
-
Password confirmation: password_confirmation
-
Gender: gender
-
Birthdate: birthdate
-
Custom field: custom_fields.<custom_field_key>
-
Consent: consents.<consent_key> or consents.<consent_key>.v<consent_version_id> (the Consents feature must be enabled)
|
All predefined fields are required.
|
You can pass a field as an object to override default values:
-
Assign defaultValue
-
Require field
-
Hide field
...
{
"key": "family_name",
"defaultValue": "Moreau", (1)
"required": true
}
...
1 |
Assign a defaultValue if so desired. |
...
{
"key": "field",
"defaultValue": true,
"required": true (1)
}
...
1 |
Explicitly require the field. |
...
{
"key": "given_name",
"defaultValue": "Kylian",
"type": "hidden" (1)
}
...
1 |
The "hidden" type hides a field while still having a value. In this case, the value of Kylian remains for given_name despite not appearing on the form. |
|
Be sure that any consent you may define in the signupFields property is not archived. If the consent is archived, this causes the widget to not display as well as throwing an error like so:
archived consent <name> cannot be displayed
If no version ID is set in a consent field’s path, the latest version of the consent will be displayed.
|
|
socialProviders string[] |
Lists the available social providers. This is an array of strings.
|
If you pass an empty array, social providers will not be displayed.
|
|
theme object |
The options to set up to customize the appearance of the widget.
primaryColor string |
The button and link default color.
|
borderRadius string |
The radius of the social login button and other input (in px).
|
This can be used to make inline and/or circle social login buttons.
|
|
socialButton object |
Social button theming options.
- Parameters
-
-
inline - Boolean that specifies if the buttons are inline (horizonally-aligned).
-
textVisible - Boolean that specifies if the text is visible.
-
fontWeight - Specifies the font-weight (such as normal , bold , or 900 ).
-
fontSize - Specifies the font-size.
-
lineHeight - Specifies the line-height.
-
paddingX - Specifies the padding for the x axis. (left and right)
-
paddingY - Specifies the padding for the y axis. (top and bottom)
-
borderRadius - Specifies the border-radius.
-
borderWidth - Specifies the border-width.
-
focusBoxShadow - Boolean that specifies if there is a box shadow on the button or not.
|
|
recaptcha_enabled boolean |
Boolean that specifies whether reCAPTCHA is enabled or not.
|
recaptcha_site_key string |
The SITE key that comes from your reCAPTCHA setup. This must be paired with the appropriate secret key that you received when setting up reCAPTCHA.
|