WorkOS OpenAPI Specification

This repository contains the OpenAPI specification for the WorkOS API.

Overview

The WorkOS API provides a comprehensive platform for enterprise-ready features including:

• User Management - Authentication, identity, and user lifecycle management
• Organization Management - Multi-tenancy and organization-level configurations
• Directory Sync - Automated user provisioning with SCIM and directory providers
• Single Sign-On (SSO) - SAML and OIDC identity provider integrations
• Audit Logs - Comprehensive event logging and exports
• API Keys - Programmatic access management
• Authorization - Role-based access control (RBAC) and permissions

Specification

• OpenAPI Version: 3.1.1
• Format: YAML
• File: spec/open-api-spec.yaml

Generating Postman Collections

This repository includes scripts to generate Postman collections from the OpenAPI specification. See the scripts/postman folder for more information.

Support

• WorkOS Documentation
• API Reference
• Support

License

This OpenAPI specification is available under the MIT License.