Skip to main content
POST
Confirm a desktop pairing

Authorizations

Authorization
string
header
required

User session JWT (Bearer ). Must be paired with the X-Team-ID request header on team-scoped endpoints so the server knows which team's resources to operate on.

Headers

X-Team-ID
string<uuid>
required

UUID of the team to scope the request to. Required on all team-scoped JWT endpoints because a user may belong to multiple teams.

Example:

"019abc12-4567-7890-abcd-ef1234567891"

Body

application/json
user_code
string
required

The user-typed code (case-insensitive, dash/space tolerated).

device_name
string

Optional display name shown in Settings → Access for this device row. Falls back to "Desktop (paired YYYY-MM-DD)".

Maximum string length: 100
Example:

"Mac Studio - YuHung"

Response

Pairing confirmed; the desktop's next poll will receive the credential.