Optional
auth'login'
Optional
authnUse different authentication methods.
Optional
backA redirection URL for redirecting a user back to in one of the following conditions:
Back to [App Name]
button in any Moneytree screen.⚠️ No Back to [App Name]
button will be shown if this value is not set, and any of the actions mentioned above will redirect the user back to the login screen by default.
Set the default value via MtLinkSdk.init
Optional
clientOptional
cobrandBrand Moneytree apps with client's branding. E.g: logo or theme.
This is an internal attribute. Please do not use it unless instructed by your integration representative.
Optional
emailEmail address to pre-fill the email field in login or sign up or form.
Set the default value via MtLinkSdk.init
Optional
isCall method and open/render in a new browser tab. By default all views open in the same tab.
Set default value via MtLinkSdk.init
false
Optional
localeForce Moneytree to load content in this specific locale.
A default value will be auto detected based on the user's language configuration and location if available. Check this spec for more information.
Currently supported values are:'en'
, 'en-AU'
, 'ja'
.
Optional
redirectOAuth redirection URI, see here for more details.
Set the default value via MtLinkSdk.init
Optional
samlSets the subject ID for SAML AuthnRequest.
Optional
scopesAccess scopes you're requesting. This can be a single scope, or an array of scopes.
Currently supported scopes are:
See the LINK Platform documentation for more details
'guest_read'
, or set via MtLinkSdk.init
Optional
sdkOptional
sdkOptional
showIf you wish to disable the Login to Sign up
form toggle button and vice-versa in the auth screen, set this to false
.
Set default value via MtLinkSdk.init
true
Optional
showIf you wish to disable the Stay logged in for 30 days
checkbox in the login screen, set this to false
.
Set default value via MtLinkSdk.init
true
Optional
stateThe state parameter for OAuth flows, see here for more details.
If you generate an identifier for the OAuth authorization on your server make sure to set this value explicitly so that you can use it to acquire the access token after the OAuth redirect occurs.
The default value is a randomly generated uuid, or set via MtLinkSdk.init
Generated using TypeDoc
Show the login or sign up screen when a session does not exist during an MtLinkSdk.authorize call.
Set default value via MtLinkSdk.init