it's alive!

Author: gjtorikian

.github/workflows/sync-postman.yml

@@ -0,0 +1,32 @@
+name: Sync Postman Collection
+
+on:
+  # push:
+  #   branches: [main]
+  #   paths:
+  #     - 'spec/open-api-spec.yaml'
+  #     - 'scripts/postman/**'
+  workflow_dispatch:
+
+concurrency:
+  group: postman-sync
+  cancel-in-progress: true
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          node-version: '24'
+          cache: 'npm'
+
+      - run: npm ci
+
+      - name: Generate and upload Postman collection
+        run: npx tsx scripts/postman/generate-and-upload.ts
+        env:
+          POSTMAN_API_KEY: ${{ secrets.POSTMAN_API_KEY }}
+          POSTMAN_COLLECTION_UID: ${{ secrets.POSTMAN_COLLECTION_UID }}

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+*.local.json

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "[github-actions-workflow]": {
+        "editor.defaultFormatter": "redhat.vscode-yaml"
+    },
+    "[markdown]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[json]": {
+        "editor.defaultFormatter": "vscode.json-language-features"
+    }
+}

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 WorkOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,35 @@
-# openapi-spec
+# WorkOS OpenAPI Specification
+
+This repository contains the [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification) for the [WorkOS API](https://workos.com/docs/reference).
+
+## 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`](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](https://workos.com/docs)
+- [API Reference](https://workos.com/docs/reference)
+- [Support](https://workos.com/support)
+
+## License
+
+This OpenAPI specification is available under the [MIT License](LICENSE).