dev.cocore.devicePair.start Documentation (EN)

main procedure

Begin a device-pairing flow (OAuth 2.0 device-authorization style). Returns a `deviceId` plus a short human-typable `userCode` and the `verificationUri` where a signed-in user approves the pairing. The caller then polls `dev.cocore.devicePair.poll` until approval.

Output

Encodingapplication/json

deviceId string Required

No description available.

expiresInSecs integer Required

Seconds until this pairing attempt expires.

pollIntervalSecs integer Required

Minimum seconds between poll calls.

userCode string Required

Short code the user types at the verification URI.

verificationUri stringuri Required

A valid URI.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

View raw schema

{
  "type": "procedure",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "deviceId",
        "userCode",
        "verificationUri",
        "pollIntervalSecs",
        "expiresInSecs"
      ],
      "properties": {
        "deviceId": {
          "type": "string"
        },
        "userCode": {
          "type": "string",
          "description": "Short code the user types at the verification URI."
        },
        "expiresInSecs": {
          "type": "integer",
          "description": "Seconds until this pairing attempt expires."
        },
        "verificationUri": {
          "type": "string",
          "format": "uri"
        },
        "pollIntervalSecs": {
          "type": "integer",
          "description": "Minimum seconds between poll calls."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Begin a device-pairing flow (OAuth 2.0 device-authorization style). Returns a `deviceId` plus a short human-typable `userCode` and the `verificationUri` where a signed-in user approves the pairing. The caller then polls `dev.cocore.devicePair.poll` until approval."
}