Interface AuthorizeOptions

Hierarchy

Properties

affiliateCode? authAction? authnMethod? backTo? codeChallenge? email? forceLogout? isNewTab? redirectUri? scopes? sdkPlatform? sdkVersion? showAuthToggle? showRememberMe? state?

Properties

Optional affiliateCode

affiliateCode?: string

An optional affiliate code for attributing user referrals.

If not provided, no affiliate attribution will be applied.

Optional authAction

authAction?: "login" | "signup"

Show the login or sign up screen when a session does not exist during an MtLinkSdk.authorize call.

Set default value via MtLinkSdk.init

Default Value

'login'

Optional authnMethod

authnMethod?: "passwordless" | "sso" | "credentials"

Use different authentication methods.

Optional backTo

backTo?: string

A redirection URL for redirecting a user back to in one of the following conditions:

  • User clicks on Back to [App Name] button in any Moneytree screen.
  • User refuses to give consent to access permission in the consent screen.
  • User logs out from Moneytree via an app with this client ID
  • User revokes consent from settings screen opened via an app with this client ID

⚠️ 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 codeChallenge

codeChallenge?: string

The 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 email

email?: string

Email address to pre-fill the email field in login or sign up or form.

Set the default value via MtLinkSdk.init

Optional forceLogout

forceLogout?: boolean

Force existing user session to logout and call authorize with a clean state.

Default Value

false

Optional isNewTab

isNewTab?: boolean

Call method and open/render in a new browser tab. By default all views open in the same tab.

Set default value via MtLinkSdk.init

Default Value

false

Optional redirectUri

redirectUri?: string

OAuth redirection URI, see here for more details.

Set the default value via MtLinkSdk.init

Optional scopes

scopes?: Scopes

Access scopes you're requesting. This can be a single scope, or an array of scopes.

Currently supported scopes are:

  • guest_read
  • accounts_read
  • points_read
  • point_transactions_read
  • transactions_read
  • transactions_write
  • expense_claims_read
  • categories_read
  • investment_accounts_read
  • investment_transactions_read
  • notifications_read
  • request_refresh
  • life_insurance_read

See the LINK Platform documentation for more details

Default Value

'guest_read', or set via MtLinkSdk.init

Optional sdkPlatform

sdkPlatform?: "ios" | "android" | "js"

Optional sdkVersion

sdkVersion?: string

Optional showAuthToggle

showAuthToggle?: boolean

If 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

Default Value

true

Optional showRememberMe

showRememberMe?: boolean

If 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

Default Value

true

Optional state

state?: string

The 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc