Approve, deny or inspect a device code

POST /v1/me/device/approve

• Operation ID: respondDeviceAuthorization
• Tags: Device authorization
• Base URL: http://localhost:8787

The signed-in user enters the user_code shown on the device. action defaults to approve; deny rejects the request; info returns the requesting client's IP, user agent and location without changing state so the UI can confirm it. Codes are case-insensitive and the dash is optional. Limited to 5 requests per minute per user.

Workflow: Integration guide.

Authentication: Platform user Bearer JWT. Acts only on the caller's own data.

Rate limit: 5 requests per 60s per user.

Authentication

• Auth: Platform user Bearer JWT (Authorization: Bearer <access_token>).

Rate limit

5 requests per 60 seconds per user. Exceeding it returns 429.

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
user_code	string	yes	Min length: 1. Max length: 32
action	string	no	One of: "approve", "deny", "info". Default: "approve"

Responses

200

{ success: true } for approve/deny; request details for info.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object | object (DeviceAuthorizationInfo)

Field	Type	Required	Description
(variant 1).success	boolean	yes	One of: true
(variant 2).ip	string | null	yes	-
(variant 2).user_agent	string | null	yes	-
(variant 2).location	string | null	yes	-
(variant 2).user_data	object | null	yes	Opaque data the device supplied when requesting the code.
(variant 2).created_at	string<date-time>	yes	-
(variant 2).expires_at	string<date-time>	yes	-

Errors

400

Request validation failed. invalid_code: unknown, expired or already-answered user code.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody) | object (ErrorBody)

Field	Type	Required	Description
(variant 1).success	boolean	yes	One of: false
(variant 1).error	object	yes	-
(variant 1).error.name	string	yes	One of: "ZodError"
(variant 1).error.issues	object[]	yes	-
(variant 1).error.issues[].code	string	yes	-
(variant 1).error.issues[].path	(string | number)[]	yes	-
(variant 1).error.issues[].message	string	yes	-
(variant 2).error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
(variant 2).details	any	no	Optional structured context. For 403 it is { perm }.

Request validation

{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

Application error

{
  "error": "invalid_code"
}

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

429

Rate limit exceeded (rate_limited).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "rate_limited"
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

503

Maintenance can refuse this write before authentication (degraded blocks session start and checkout; lockdown blocks other public/user writes).

• Header x-request-id: Request identifier; quote it when reporting an error.
• Header Retry-After: Maintenance retry delay in seconds; present for panic_mode. Example: 30. Content type: application/json

Schema: object (MaintenanceErrorBody)

Field	Type	Required	Description
error	string	yes	One of: "panic_mode"
level	string	yes	One of: "degraded", "lockdown"
reason	string | null	yes	-

Maintenance lockdown

{
  "error": "panic_mode",
  "level": "lockdown",
  "reason": "Scheduled maintenance"
}

Examples

curl

curl -X POST 'http://localhost:8787/v1/me/device/approve' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"user_code":"example","action":"approve"}'

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/me/device/approve", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "user_code": "example",
    "action": "approve"
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();