Skip to main content

connectIntegrationWithCredentials

Connects an existing integration using a username/password credential pair. The integration class exchanges the credentials for an access token (and any refresh material) and persists the resulting tokens encrypted on the integration record. Username and password are NOT persisted.

Use this mutation when the WMS exposes a /auth/token-style endpoint that accepts username + password and returns a token pair.

Authentication Requirements​

  • Header Authorization must be provided
  • Header X-Company-Id must be provided

Possible Errors​

  • Integration not found in the requesting company
  • Integration of the given type does not support credential exchange
  • Upstream auth failure (bad credentials, MFA, rate limit) — surfaces as Error::Authentication with HTTP 401
connectIntegrationWithCredentials(
  input: ConnectIntegrationWithCredentialsInput!
): Integration!

Arguments​

connectIntegrationWithCredentials.input ● ConnectIntegrationWithCredentialsInput! non-null input common​

Parameters for ConnectIntegrationWithCredentials

Type​

Integration object integrations​