Skip to main content

generateSamlResponseForInvestmentsSso

Used to enable SSO from a customer's First Dollar account to their investment partner (e.g. TD Ameritrade) account. It returns an encoded SAML response that can be used as a bearer token to log in to the partner. Note we mark this as a mutation instead of a query because underlying state is changed; a very limited number of these tokens should be generated in any particular time period.

The following errors are possible: INVALID_STATE: Returned if the authenticated user doesn't own the investment account identified in the GenerateSAMLResponseForInvestmentsSSOInput, or if that account is not open.

generateSamlResponseForInvestmentsSso(
  input: GenerateSamlResponseForInvestmentsSsoInput!
): GenerateSamlResponseForInvestmentsSsoPayload!

Arguments​

generateSamlResponseForInvestmentsSso.input ● GenerateSamlResponseForInvestmentsSsoInput! non-null input​

Type​

GenerateSamlResponseForInvestmentsSsoPayload object​

Response containing a signed SAML value that an investments partner will use to perform SSO and account linking.