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 absolute URI the user-agent will be redirected to following flow completion. It will either carry the response type, or the appropriate error in case of failure. Any specified state string will also be included.
This parameter 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 |
An opaque value used to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client.
|
prompt string |
Specify whether the flow should explicitly prompt the user for reauthentication or not.
|
|
This applies to the Login with session flow where a session cookie is provided.
|
|
|
In a Social Login (SLO) flow, the session management is partially delegated to the target OIDC provider (OP) and hence, prompt is handled by the OP and we redirect to the OP because of this.
|
-
none: Require that no user interaction take place.
This is typically used to silently check for existing authentication and/or consent.
|
|
If no value for prompt is specified, none is the default value for non-orchestrated flows. For orchestrated flows, if no value for prompt is specified, users are redirected to the defined Login URL with their orchestration token.
|
-
login: The flow should prompt the user for reauthentication. The existing session is invalidated and the user is redirected to the redirect_uri or client-configured login URL (if no redirect_uri is specified).
-
consent: The flow should prompt for consent, otherwise an error must be returned to the client (consent_required).
|
nonce string |
String value used to associate a client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified to the ID Token. Sufficient entropy must be present in the nonce values used to prevent attackers from guessing values. See Section 15.5.2 of OpenID Connect for more implementation details.
|
persistent boolean |
When persistent is true, the session duration configured in the ReachFive Console () applies.
If persistent is not set or is false, the default session duration of 1 day applies.
|
popupMode boolean |
Whether or not to use popup mode.
|
|
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 basic user profile information when they sign in. Automatically adds profile, email, phone and openid to the requested scope.
|
accessToken string |
Access token of the current user. 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 with 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.
|
|
returnProviderToken boolean |
Boolean that specifies whether you should return the provider access token.
If set to true, you retrieve the provider and provider access token as part of the authentication result.
|