v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB

AuthConnector

Initiate connector consent

Start the OAuth consent flow for a connector, returning (or redirecting to) the provider URL.

get/auth/connectors/{connector_id}/consent

Path parameters

connector_idinteger required

ID of the connector to consent to.

Query parameters

return_urlstring nullable

URL to return the user to after consent.

redirectboolean

If true, return 302 redirect instead of JSON

cookie_namestring nullable

Response

Successful Response

consent_urlstring required

URL to redirect the user to for granting consent.

Example response

{
  "consent_url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?...",
  "connector": {
    "id": 3,
    "name": "OneDrive",
    "provider": "microsoft",
    "caps": [
      "files.read"
    ],
    "scopes": [
      "Files.Read.All",
      "offline_access"
    ]
  }
}