0 Fork 0

Files

T

John O'Keefe ae9588f1c6 docs(auth,devices): Beam WO5 batch 3 — 15 endpoints backfilled, registry pinned

Beam backfilled auth core (login/register/refresh/logout/profile) and devices
core (list/update/delete/shelf CRUD/sidecar/register flow) with frontmatter,
provenance, and labeled examples. All claimed shapes verified against
handlers: AuthResponse {access_token, refresh_token omitempty, token_type,
expires_in, user}, update device {device_updated, device}, shelf wrappers,
DeviceAuthStatusResponse.

Claude registry verification: 15 entries pinned by type (LoginRequest,
RegisterRequest, AuthResponse, RefreshTokenRequest/Response, UserProfile,
DeviceListResponse, DeviceUpdateRequest, AddToShelfRequest, SidecarConfig,
DeviceRegistrationRequest/Response, DeviceAuthStatusRequest/Response).
Removed revoke_device.md — name-only duplicate of delete_device.md (same
DELETE /api/devices/:id route; was the last audit-orphan doc).

Gate catches this round (subtle Go serialization facts, now pinned in docs):
- uuid.UUID arrays never serialize as omitted: register/status response
  ALWAYS carries device_id (all-zeros while pending) despite omitempty
- update device request binds device_name, not name
- register response includes device_id alongside registration_id
- list devices response is a {devices, total} wrapper

2026-10-24 15:48:18 -04:00

2.0 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
POST	/api/auth/register	none	authentication

Register User

Create a new user account.

Endpoint: POST /api/auth/register Auth: Not required Content-Type: application/json or application/x-www-form-urlencoded

Request Body

Field	Type	Required	Description
email	string	Yes	User's email address
username	string	Yes	Desired username (3-50 chars)
password	string	Yes	Password (min 8 chars, must meet complexity requirements)
first_name	string	No	User's first name
last_name	string	No	User's last name

Example Request

{
  "email": "user@example.com",
  "username": "john",
  "password": "SecureP@ss123!",
  "first_name": "John",
  "last_name": "Doe"
}

Response (201 Created)

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 604800,
  "user": {
    "id": "uuid-here",
    "email": "user@example.com",
    "username": "john",
    "first_name": "John",
    "last_name": "Doe",
    "role": "user"
  }
}

Set-Cookie Header:

Set-Cookie: token=eyJhbG...; Max-Age=604800; Path=/; HttpOnly

Session Duration: 7 days (604800 seconds)

First User: The first user registered automatically becomes an admin.

Error Responses

Code	Description
400	Invalid email format, weak password, or missing fields
409	Email or username already exists

2.0 KiB Raw Blame History