Application

Get Application Configuration

Changed on

Retrieve application configuration information for this user

get/appconfig

Request

  • Base URL
    //basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1 (relative, and the document’s source URL is not known)
  • Auth
    API key in header Authorization

Response

Ok

isFIRequestsEnabledboolean required

Indicates whether creation of FI requests is enabled for this user

isInvestorSsnRequiredboolean required

Indicates whether user account SSO is required or not

isCreateAccountsEnabledboolean required

Indicates whether user account creation is enabled (will be true only for RW investors)

isDeleteAccountsEnabledboolean required

Indicates whether user account deletion is enabled (will be true only for RW investors)

isEditAccountsEnabledboolean required

Indicates whether user account editing is enabled (will be true for RW and CW investors)

isDeleteCredentialsEnabledboolean required

Indicates whether user credential with no accounts deletion is enabled (will be true only for RW investors)

isEditSelfEnabledboolean required

Indicates whether the user editing of themselves is enabled

isLoginEditableboolean required

Indicates whether login can be edited (will be false for SSO users)

isReloginEnabledboolean required

Indicates whether the user should be prompted for re-login when the session times out (will be false during SSO sessions)

isLogoutLinkShownboolean required

Indicates whether logout/exit link should be shown (incorporates SSO and vendor setting)

isCUI2SelectDiscoAccountsEnabledboolean required

Indicates whether adding choice of accounts is enabled

isCUI2OnDemandDiscoEnabledboolean required

Indicates whether incremental account discovery is enabled

loginURLstring

The absolute login URL. Null if no vendor-specific login URL set.

exitURLstring required

Exit URL to navigate to when exiting the app

logoURLstring required

The absolute URL of the vendor-specific logo. Null if there is no vendor-specific logo.

sessionTimeoutURLstring required

URL to navigate to in event of session timeout

uiConfigURLstring

The absolute URL of the vendor specific UI configuration file. Null if no vendor-specific UI configuration file found.

overrideCSSURLstring

The absolute URL of the vendor specific CSS file. Null if no vendor-specific CSS file found.

i18nURLstring

The absolute URL of the vendor specific internationalization folder. Null if no vendor-specific internationalization folder found.

logoutLinkType'logout' | 'exit' required

Either 'logout' or 'exit' depending on whether this is an SSO session

passwordRequirementsstring required

Password requirements string in HTML format

recaptchaSiteKeystring required

The reCAPTCHA site key

isUserAgreementRequiredboolean required

Indicates whether the user agreement is required

userAgreementHtmlURLstring

URL to HTML version of the user agreement

userAgreementPdfURLstring

URL to PDF version of the user agreement

privacyPdfURLstring

URL to PDF version of the privacy policy

gtmTrackingIdstring

Google Tag Manager tracking id

isAccountSummaryByAccountTypesEnabledboolean required

Indicates whether the account summary/account types view is enabled

defaultAccountSummaryViewstring

"ACCOUNT_TYPES" or "INSTITUTIONS" or null if neither view is enabled

isReadOnlyboolean required

Indicates whether the session is a read only session for this user

isAccountSummaryNetWorthEnabledboolean required

Indicates whether net worth details should be included in account summary component

Example response

{
  "isFIRequestsEnabled": true,
  "isInvestorSsnRequired": true,
  "isCreateAccountsEnabled": true,
  "isDeleteAccountsEnabled": true,
  "isEditAccountsEnabled": true,
  "isDeleteCredentialsEnabled": true,
  "isEditSelfEnabled": true,
  "isLoginEditable": true,
  "isReloginEnabled": true,
  "isLogoutLinkShown": true,
  "isCUI2SelectDiscoAccountsEnabled": true,
  "isCUI2OnDemandDiscoEnabled": true,
  "loginURL": "https://www.byallaccounts.net/BAAWebAppCUI2/login",
  "exitURL": "https://www.byallaccounts.net/BAAWebApp/BAALogin.html",
  "logoURL": "https://www.byallaccounts.net/WebPortfolio/vendorResources/Default/medium/logo.png",
  "sessionTimeoutURL": "https://www.byallaccounts.net/BAAWebApp/BAALogin.html",
  "uiConfigURL": "https://www.byallaccounts.net/WebPortfolio/vendorResources/ABCDEFGH/ui-config.json",
  "overrideCSSURL": "https://www.byallaccounts.net/WebPortfolio/vendorResources/ABCDEFGH/override.css",
  "i18nURL": "https://www.byallaccounts.net/WebPortfolio/vendorResources/ABCDEFGH/i18n",
  "logoutLinkType": "logout",
  "passwordRequirements": "example not provided",
  "recaptchaSiteKey": "example not provided",
  "isUserAgreementRequired": true,
  "userAgreementHtmlURL": "/WPDemo/vendorResources/Default/wpUserAgreement.html",
  "userAgreementPdfURL": "https://www.byallaccounts.net/WPDemo/vendorResources/Default/wpUserAgreement.pdf",
  "privacyPdfURL": "https://www.byallaccounts.net/WebPortfolio/vendorResources/Default/wpPrivacy.pdf",
  "productLicenseList": [
    {
      "product": "CUI2_CE"
    }
  ],
  "fiLogoList": [
    {
      "fiName": "Chase",
      "financialInstitutionId": 12484,
      "logoURL": "http://www.byallaccounts.net/WebPortfolio/vendorResources/Default/assets/fi/logos/ChaseOnlineLogo.PNG"
    }
  ],
  "gtmTrackingId": "example not provided",
  "isAccountSummaryByAccountTypesEnabled": true,
  "defaultAccountSummaryView": "ACCOUNT_TYPES",
  "isReadOnly": true,
  "isAccountSummaryNetWorthEnabled": true
}

Changes