@workos/openapi-spec 0.117.0 → 0.118.0

package/dist/open-api-spec.yaml

@@ -12760,6 +12760,129 @@ paths:
       summary: Delete a Directory
       tags:
         - directories
+  /directories/{id}/sync:
+    post:
+      description: >-
+        Request an asynchronous sync from the directory provider. Currently
+        supports Google Workspace directories in linked or validating state.
+        Manual requests share a five-minute per-directory cooldown across the
+        API, Dashboard, Admin Portal, and MCP. Acceptance means the request was
+        queued, not that the sync has started or completed. A running sync
+        prevents another request from being queued.
+      operationId: DirectoriesController_syncDirectory
+      parameters:
+        - name: id
+          required: true
+          in: path
+          description: Unique identifier for the Directory.
+          schema:
+            example: directory_01ECAZ4NV9QMV47GW873HDCX74
+            type: string
+      responses:
+        '202':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DirectorySyncResponse'
+        '403':
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
+                required:
+                  - message
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
+                required:
+                  - message
+        '409':
+          description: A sync is already in progress. No additional sync was queued.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: string
+                    description: The error code identifying the type of error.
+                    example: directory_sync_in_progress
+                    const: directory_sync_in_progress
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: Request could not be processed.
+                required:
+                  - code
+                  - message
+        '422':
+          description: The directory provider or state does not support manual sync.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: string
+                    description: The error code identifying the type of error.
+                    example: directory_sync_unsupported
+                    const: directory_sync_unsupported
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: Request could not be processed.
+                required:
+                  - code
+                  - message
+        '429':
+          description: The directory is within the manual-sync cooldown window.
+          headers:
+            Retry-After:
+              description: Seconds to wait before requesting another manual sync.
+              schema:
+                type: integer
+                minimum: 1
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DirectorySyncRateLimitError'
+        '503':
+          description: Directory syncing is temporarily paused. No sync was queued.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: string
+                    description: The error code identifying the type of error.
+                    example: directory_sync_disabled
+                    const: directory_sync_disabled
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: Request could not be processed.
+                required:
+                  - code
+                  - message
+      summary: Sync a Directory
+      tags:
+        - directories
   /directory_groups:
     get:
       description: >-
@@ -33570,6 +33693,41 @@ components:
         - data
         - list_metadata
         - list_metadata
+    DirectorySyncResponse:
+      type: object
+      properties:
+        status:
+          type: string
+          description: >-
+            The sync request was queued for asynchronous processing. This does
+            not indicate that the sync has started or completed.
+          example: queued
+          const: queued
+      required:
+        - status
+    DirectorySyncRateLimitError:
+      type: object
+      properties:
+        code:
+          type: string
+          description: The error code identifying the type of error.
+          example: directory_sync_rate_limited
+          const: directory_sync_rate_limited
+        message:
+          type: string
+          description: A human-readable description of the error.
+          example: Request could not be processed.
+        retry_after_seconds:
+          type: integer
+          exclusiveMinimum: 0
+          description: >-
+            The number of seconds to wait before requesting another manual sync
+            of this directory.
+          example: 120
+      required:
+        - code
+        - message
+        - retry_after_seconds
     DirectoryGroup:
       type: object
       properties:

package/dist/services.mjs

@@ -477,6 +477,11 @@ const serviceEndpoints = {
 			"path": "/directories/{id}",
 			"name": "get_directory"
 		},
+		{
+			"method": "POST",
+			"path": "/directories/{id}/sync",
+			"name": "create_directory_sync"
+		},
 		{
 			"method": "GET",
 			"path": "/directory_groups",

package/dist/types.d.ts

@@ -1641,6 +1641,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/directories/{id}/sync": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Sync a Directory
+         * @description Request an asynchronous sync from the directory provider. Currently supports Google Workspace directories in linked or validating state. Manual requests share a five-minute per-directory cooldown across the API, Dashboard, Admin Portal, and MCP. Acceptance means the request was queued, not that the sync has started or completed. A running sync prevents another request from being queued.
+         */
+        post: operations["DirectoriesController_syncDirectory"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/directory_groups": {
         parameters: {
             query?: never;
@@ -8565,6 +8585,32 @@ export interface components {
                 after: string | null;
             };
         };
+        DirectorySyncResponse: {
+            /**
+             * @description The sync request was queued for asynchronous processing. This does not indicate that the sync has started or completed.
+             * @example queued
+             * @constant
+             */
+            status: "queued";
+        };
+        DirectorySyncRateLimitError: {
+            /**
+             * @description The error code identifying the type of error.
+             * @example directory_sync_rate_limited
+             * @constant
+             */
+            code: "directory_sync_rate_limited";
+            /**
+             * @description A human-readable description of the error.
+             * @example Request could not be processed.
+             */
+            message: string;
+            /**
+             * @description The number of seconds to wait before requesting another manual sync of this directory.
+             * @example 120
+             */
+            retry_after_seconds: number;
+        };
         DirectoryGroup: {
             /**
              * @description Distinguishes the Directory Group object.
@@ -31464,6 +31510,132 @@ export interface operations {
             };
         };
     };
+    DirectoriesController_syncDirectory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Unique identifier for the Directory. */
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DirectorySyncResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description A sync is already in progress. No additional sync was queued. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example directory_sync_in_progress
+                         * @constant
+                         */
+                        code: "directory_sync_in_progress";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description The directory provider or state does not support manual sync. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example directory_sync_unsupported
+                         * @constant
+                         */
+                        code: "directory_sync_unsupported";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description The directory is within the manual-sync cooldown window. */
+            429: {
+                headers: {
+                    /** @description Seconds to wait before requesting another manual sync. */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DirectorySyncRateLimitError"];
+                };
+            };
+            /** @description Directory syncing is temporarily paused. No sync was queued. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example directory_sync_disabled
+                         * @constant
+                         */
+                        code: "directory_sync_disabled";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    };
+                };
+            };
+        };
+    };
     DirectoryGroupsController_list: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workos/openapi-spec",
-  "version": "0.117.0",
+  "version": "0.118.0",
   "type": "module",
   "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
   "license": "MIT",