Files
bookhoard/docs/developer/api/authentication/refresh_token.md
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

51 lines
1.1 KiB
Markdown

---
method: POST
path: /api/auth/refresh
auth: none
area: authentication
---
<!-- source: internal/handlers/refresh_token.go:36 AuthHandler.RefreshAccessToken -->
# Refresh Token
Obtain a new JWT access token using a refresh token.
**Endpoint**: `POST /api/auth/refresh`
**Auth**: Not required (uses refresh token)
**Content-Type**: `application/json`
## Request Body
| Field | Type | Required | Description |
| ------------- | ------ | -------- | -------------------------- |
| refresh_token | string | Yes | Valid refresh token (UUID) |
### Example Request
```json example-request
{
"refresh_token": "d4f5g6h7..."
}
```
## Response (200 OK)
```json example-response
{
"access_token": "new-jwt-token",
"token_type": "Bearer",
"expires_in": 604800
}
```
**Session Duration**: 7 days (604800 seconds)
The new access token is valid for 7 days from the time of refresh.
## Error Responses
| Code | Description |
| ---- | --------------------------------------- |
| 401 | Invalid or expired refresh token |
| 400 | Missing refresh token or invalid format |