dev.cocore.devicePair.confirm Documentation (EN)

main procedure

Approve or deny a pending device-pairing attempt, identified by the `userCode` the device displayed. Called from the verification UI by a signed-in user. Approving requires the provider `session` to grant to the device.

Input

Encodingapplication/json

decision string Required

No description available.

session unknown Optional

Provider session to grant to the device; required when `decision` is `approve`.

userCode string Required

The code the device displayed (case-insensitive).

Output

Encodingapplication/json

ok boolean Required

No description available.

status string Required

No description available.

Errors

InvalidRequest Missing `userCode`, an invalid `decision`, or `approve` without a `session`.

NotFound No pairing attempt matches the `userCode`.

Conflict The pairing attempt could not be approved in its current state.

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)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "userCode",
        "decision"
      ],
      "properties": {
        "session": {
          "type": "unknown",
          "description": "Provider session to grant to the device; required when `decision` is `approve`."
        },
        "decision": {
          "enum": [
            "approve",
            "deny"
          ],
          "type": "string"
        },
        "userCode": {
          "type": "string",
          "description": "The code the device displayed (case-insensitive)."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidRequest",
      "description": "Missing `userCode`, an invalid `decision`, or `approve` without a `session`."
    },
    {
      "name": "NotFound",
      "description": "No pairing attempt matches the `userCode`."
    },
    {
      "name": "Conflict",
      "description": "The pairing attempt could not be approved in its current state."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "ok",
        "status"
      ],
      "properties": {
        "ok": {
          "type": "boolean"
        },
        "status": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Approve or deny a pending device-pairing attempt, identified by the `userCode` the device displayed. Called from the verification UI by a signed-in user. Approving requires the provider `session` to grant to the device."
}