Skip to main content

initiateInvestmentsSsoLinkage

Records the intent to link an investment account and HSA via SSO. This operation is idempotent and has the following behavior:

  1. If sso link state is NOT_LINKED, updates the state to PENDING.
  2. If sso link state is PENDING or LINKED, makes no change.

SSO Linkage will transition from PENDING to LINKED based on a scheduled, nightly workflow, at which time we receive updates from the Investment Gateway that indicate which accounts are now linked (among other facts).

The following errors are possible: FORBIDDEN: Returned if the authenticated user doesn't own the investment account identified in the InitiateSSOLinkageInput.

initiateInvestmentsSsoLinkage(
  input: InitiateInvestmentsSsoLinkageInput!
): InitiateInvestmentsSsoLinkagePayload!

Arguments​

initiateInvestmentsSsoLinkage.input ● InitiateInvestmentsSsoLinkageInput! non-null input​

Type​

InitiateInvestmentsSsoLinkagePayload object​

Wrapper type returning updated investment account information after initiating SSO linkage.