Credential Authentication

Submit a new request for authentication

Changed on

Initiate the authentication operation for the credential specified by 'credentialId'. This operation does not require any payload nor does it return one. On success (200) the Location header will contain the temporary location to use to poll for status.

post/credentials/{credentialId}/authenticate

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

Path parameters

credentialIdinteger required

The identifier of the credential for which to initiate authentication.

Query parameters

allowUserInputboolean

True if In-Session Activation Code (ISAC) prompts should be allowed.

startOauthboolean

True indicates that OAuth should be initiated if this is an OAuth credential. The setting has no effect for non-OAuth credentials.

Request body

oauthRedirectURLstring

URL for BAA to redirect to after the Oauth process has fully completed. If not provided, then no redirect is issued (instead a self-closing HTML page is returned from the OauthCallbackHandler)

oauthRedirectTypestring

Type of redirect: 'client' for a JavaScript client-side redirect and 'server' for a 302 redirect. Not case-sensitive. If type is not included or not a recognized type, 'client' is used.

Example request

{
  "oauthRedirectURL": "https://www.morningstar.com/",
  "oauthRedirectType": "client"
}

Response

Ok

Changes