Passport API Reference Overview

Server-to-server API for managing Passport namespaces, resource groups, secret references, resource endpoints, and endpoint secret bindings.

Authentication. Every request must carry a WorkOS organization API key as Authorization: Bearer sk_.... The key is validated by passport-service against WorkOS; a valid org-scoped key has full admin-equivalent access within that organization (team = organization_id).

Response envelope. Success responses are { "data": ... } (list endpoints add "pagination"). Error responses are { "error": { "code", "message", "details"? } }.

Pagination. List endpoints accept limit (1–100, default 50) and an opaque cursor. pagination.nextCursor is null on the last page.

Rate limiting. Each key is limited per minute; 429 responses carry Retry-After and RateLimit-* headers.

Versioning. The URI version is /public/v1. When a version is scheduled for retirement, responses include Deprecation / Sunset headers.