Skip to main content

beginIntegrationOauth

Begin an OAuth Authorization Code flow for an integration that supports it. Returns the URL the brand should be redirected to in order to grant consent. The integration class implements #begin_oauth, which stashes a server-side state token that the matching callback controller resolves back to this integration on redirect.

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 an OAuth flow
beginIntegrationOauth(
  input: BeginIntegrationOauthInput!
): BeginIntegrationOauthPayload

Arguments​

beginIntegrationOauth.input ● BeginIntegrationOauthInput! non-null input common​

Parameters for BeginIntegrationOauth

Type​

BeginIntegrationOauthPayload object common​

Autogenerated return type of BeginIntegrationOauth.