PIpipeshub-ai
Connector OAuth

Get OAuth authorization URL

Changed on

Start the OAuth sign-in for a connector instance.<br><br> <b>Flow:</b><br>

<ol> <li>Call this endpoint to get <code>authorizationUrl</code> and <code>state</code></li> <li>A person opens the URL and gives consent at the provider</li> <li>The provider redirects to <code>{baseUrl}/{redirectUri}</code> with <code>code</code> and <code>state</code></li> <li>Pass both to <code>GET /connectors/oauth/callback</code> with a bearer token</li> </ol> The redirect URI is fixed when the connector is created (its <code>baseUrl</code>) and must be registered with the provider.
get/connectors/{connectorId}/oauth/authorize

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/connectors/{connectorId}/oauth/authorize
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: connector:write

Path parameters

connectorIdstring required

Connector instance ID

Query parameters

desktopstring

true when the sign-in starts in the desktop app: the state sent to the provider is marked so the web callback page hands code and state to the app over a pipeshub:// link instead of finishing the sign-in in the browser. Any other value is ignored.

Response

Provider consent URL

successboolean required
authorizationUrlstring required

Open in a browser to give consent

statestring required

Pass back with the provider's code to the callback

Changes