Back to docs index

VIS-specific OAuth Parameters

In addition to the standard Authorize endpoint OAuth parameters, you can include extra parameters in the authentication request. For example here we add the app_name and allow_sign_up parameters:

https://identity.dhamma.org/oauth/authorize?allow_sign_up=true&app_name=custom+app+name&client_id=XXX&locale=en&redirect_uri=YYY&response_type=code&scope=default&state=ZZZ

These parameters’ default values can be customized per application in the application edit page in the VIS UI.

Param	Description	Examples	Default Value
allow_generic_oldstudent*	Allow sign in with the oldstudent/behappy credentials	true, false	false
allow_sign_in_with_apple	Allow the user to sign in with their Apple account	true, false	true
allow_sign_in_with_google	Allow the user to sign in with their Google account	true, false	true
allow_sign_in_with_office365	Allow the user to sign in with their Office365 account (@dhamma.org email)	true, false	true
allow_sign_up	Allow user to sign up before sign in (public websites)	true, false	true
app_name	Override your app name	My App, Mon Application
back_button	Display a button to cancel login and go back to your app	true, false	false
back_button_text	Text of the back button	Go back to the form
back_button_url	URL to get back to	https://my.app/form
cancel_mfa_link_text	Text of the cancel link on the TOTP page. The link will be displayed only if cancel_mfa_link_url is set.	Click here to cancel your request	Cancel
cancel_mfa_link_url	URL of the cancel link on the TOTP page	https://my.app/return
confirm_identity	Prompt user to reenter their password even if they are signed in	true, false	false
extra_agreement_title	Add title to the agreement users acknowledge upon sign up	My App agreement
extra_agreement_text	Add text to the agreement users acknowledge upon sign up	My App will use your data for ..._
iframe	so iframe layout is used	true, false	false
locale	locale to use for VIS screen	en, fr, ko...	en
login_message	A message to display on the login page	Some message
login_title	Main title for the login page	Sign in to prefill your form
mfa_message	Optional text displayed on the TOTP page	This action requires a two-steps login
require_mfa	Prompt user to enter a TOTP. Ignored when the user has not set up TOTP yet and has a require_mfa_from_date value in the future.	true, false	false

*: when the parameter allow_generic_oldstudent is set to true then the parameter require_mfa is ignored as it does not make sense in a context where it's allowed to sign in with the generic old student credentials.