v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
beta.connectors

Get the auth URL for a connector.

Get the OAuth2 authorization URL for a connector to initiate user authentication.

get/v1/connectors/{connector_id_or_name}/auth_url

Path parameters

string uuid required
OR
string required

Query parameters

app_return_urlstring nullable
method_type'oauth2' | 'bearer' | 'none' | 'github_app' | 'slack_app'

Auth method type to use for the authorization URL. Required when the connector supports multiple interactive auth methods; otherwise the sole method is selected automatically. Use this to pick a specific method (e.g. 'oauth2' vs 'github_app').

credentials_namestring nullable
github_installation_linkboolean

Only valid with method_type=oauth2. When true, returns a GitHub App installation URL (https://github.com/apps/<slug>/installations/new) if the connector has the proper configuration The Github application needs to have 'Request user authorization (OAuth) during installation' enabled to perform the proper auth loop.

Only valid with method_type=oauth2. When true, returns a GitHub App installation URL (https://github.com/apps/<slug>/installations/new) if the connector has the proper configuration The Github application needs to have 'Request user authorization (OAuth) during installation' enabled to perform the proper auth loop.

Response

Successful Response

auth_urlstring required
ttlinteger required