API Reference
Tinyauth provides a full REST API for OAuth2 and OpenID Connect operations.
Interactive API Documentation
Section titled “Interactive API Documentation”For a complete, interactive API reference with request/response examples and a built-in API client, visit the Interactive API Docs.
The interactive documentation is powered by Scalar and includes:
- All available API endpoints grouped by tags
- Request/response schemas with examples
- Built-in API client for testing endpoints
- Authentication support (Bearer JWT)
API Endpoint Groups
Section titled “API Endpoint Groups”| Tag | Description |
|---|---|
| Auth | User authentication (login, register, password management) |
| User | User profile and account management |
| Consent | OAuth consent management |
| Terms | Terms of service management |
| OAuth Connect | Third-party OAuth provider connections |
| OpenID | OpenID Connect protocol endpoints (authorize, token, userinfo, JWKS) |
| Health | Server health check |
OpenAPI Specification
Section titled “OpenAPI Specification”The raw OpenAPI 3.1 specification is available as a JSON file:
- Static spec:
/openapi.json(bundled at build time) - Live UI (when running the server with
openapi.enabled: true):GET /api/docs - Live spec (when running the server with
openapi.enabled: true):GET /api/docs/json