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
codeThe code challenge for PKCE flow.
⚠️ Only set this if you are exchanging the code on your backend. If you are exchanging the code on the frontend, the SDK handles this for you.
We only support SHA256 as code challenge method, therefore please ensure the code_challenge was generated using the SHA256 hash algorithm.
Optional
emailEmail address to pre-fill the email field in login or sign up or form.
Set the default value via MtLinkSdk.init
Optional
forceForce existing user session to logout and call authorize with a clean state.
false
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
redirectOAuth redirection URI, see here for more details.
Set the default value via MtLinkSdk.init
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