Example Next.js Resource Server API

v0.5.3OpenAPI 3.1.0

Demo API of the SchemaVaults example resource server. Every operation is declared with @schemavaults/openapi-operations; this document and the /docs pages are generated from those declarations.

Server: https://example-nextjs-resource-server.schemavaults.com; (This resource server)
Spec: /api/openapi.json

Authentication

How to present credentials to this API. Each operation lists which of these it accepts.

SchemaVaults access token (Bearer)schemavaults-access-tokenhttp
Authorization: Bearer <JWT>
Access token issued by the SchemaVaults auth server for this API server.
Missing credentials answer with WWW-Authenticate: Bearer realm="schemavaults"
SchemaVaults access token (cookie)schemavaults-access-token-cookieapiKey
cookie "access_token_<api_server_id>"
First-party access token cookie set by the SchemaVaults auth flow.

Demo

Unauthenticated operations showing validation and the error envelope

Method	Path	Summary	Access
GET	/api/health Liveness probe	Liveness probe	Public
POST	/api/echo Echo a message	Echo a message	Public

Account

Operations available to any signed-in SchemaVaults user

Method	Path	Summary	Access
POST	/api/ping Authenticated ping	Authenticated ping	Authenticated
GET	/api/whoami Who am I	Who am I	Authenticated
GET	/api/me/email My email address	My email address	Authenticatedscope:email

Admin

Operations restricted to platform administrators

Method	Path	Summary	Access
GET	/api/admin/ping Administrator ping	Administrator ping	Admin

Organizations

Operations gated on organization membership

Method	Path	Summary	Access
GET	/api/organizations/{organization_id}/greeting Organization greeting	Organization greeting	Authenticatedorg member