Permissio API
Placeholder specification. This file ships with the docs site so
the dev preview can render the API reference before the real
Permissio OpenAPI document has been synced. The authoritative spec
is fetched from PERMISSIO_OPENAPI_URL
(default: https://api.permissio.us/openapi/public.yaml) by
pnpm openapi:sync and overwrites this file in place.
The placeholder is kept loosely aligned with the real conventions
documented by the Permissio API team — single host, bearer-only
authentication, flat error envelope, limit/offset pagination,
envelope/signer terminology — so the generated reference does not
actively mislead integrators in the meantime.
Authentication
- HTTP: Bearer Auth
Bearer authentication. Pass your secret API key as
Authorization: Bearer sk_test_… (sandbox) or
Authorization: Bearer sk_live_… (production). There is no
X-API-Key or other header form; bearer is the only accepted
scheme.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | opaque |