Create a Connect authorization request

APIs & SDKs

POSThttps://api.vercel.com/v1/connect/authorize/{connector}

Create an authorization request for a connector and return the URL and verifier details needed to complete the flow.

https://api.vercel.com/v1/connect/authorize/{connector}

const response = await fetch('https://api.vercel.com/v1/connect/authorize/connector', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "subject": {
      "type": "app"
    },
    "installationId": "example_id",
    "audience": [],
    "scopes": [],
    "resources": [],
    "authorizationDetails": [
      {
        "type": "string"
      }
    ],
    "validityBufferMs": "123",
    "returnUrl": "https://example.com",
    "webhook": "string",
    "prompt": "string",
    "deviceCode": "true",
    "expiresInMs": "123",
    "additionalParams": "value"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "connector": {
    "displayName": "Example Name",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "service": "string",
    "serviceName": "Example Name",
    "type": "string",
    "uid": "example_id"
  },
  "deviceCode": "string",
  "expiresAt": "123",
  "request": "string",
  "url": "https://example.com",
  "verifier": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

connectorstringRequired

Body

application/json

subjectobjectOptional5 variants

installationIdstringOptional

audiencearrayOptional

scopesarrayOptional

resourcesarrayOptional

authorizationDetailsarrayOptional

validityBufferMsnumberOptional

returnUrlstringOptional

webhookstringOptional

promptstringOptional

deviceCodebooleanOptional

expiresInMsnumberOptional

additionalParamsobjectOptional

Response

200Success

connectorobjectRequired

deviceCodestringOptional

expiresAtnumberRequired

requeststringRequired

urlstringRequired

verifierstringRequired

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

409Error

410Error

422Error

Cross-link map: Create a Connect authorization request (/docs/rest-api/connect/create-a-connect-authorization-request)

From the Vercel docs graph (built 2026-10-05T05:39:47.698Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Get a Connect token — POST /v1/connect/token/{connector} — Get an access token for a connector identified by the path parameter and scoped to
Delete a connector — DELETE /v1/connect/connectors/{connector} — Delete a connector, its project connections, and its installation records.
Get a connector project connection — GET /v1/connect/connectors/{connector}/projects/{projectId} — Get the configuration that connects a connector to a proje
Create or update a connector project connection — POST /v1/connect/connectors/{connector}/projects/{projectId} — Connect a connector to a project, or replace the environm
List connectors for a project — GET /v2/connect/projects/{projectId}/connectors — List the connectors connected to a project and the environments where

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/connect/authorize/{connector}

const response = await fetch('https://api.vercel.com/v1/connect/authorize/connector', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "subject": {
      "type": "app"
    },
    "installationId": "example_id",
    "audience": [],
    "scopes": [],
    "resources": [],
    "authorizationDetails": [
      {
        "type": "string"
      }
    ],
    "validityBufferMs": "123",
    "returnUrl": "https://example.com",
    "webhook": "string",
    "prompt": "string",
    "deviceCode": "true",
    "expiresInMs": "123",
    "additionalParams": "value"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "connector": {
    "displayName": "Example Name",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "service": "string",
    "serviceName": "Example Name",
    "type": "string",
    "uid": "example_id"
  },
  "deviceCode": "string",
  "expiresAt": "123",
  "request": "string",
  "url": "https://example.com",
  "verifier": "string"
}

OpenAPI Specification