@workos/openapi-spec 0.116.0 → 0.118.0

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.
@@ -18179,6 +18225,19 @@ export interface components {
              */
             url: string;
         };
+        AuthMethodMismatchError: {
+            /**
+             * @description Error code indicating the endpoint does not match the installation auth method.
+             * @example auth_method_mismatch
+             * @constant
+             */
+            code: "auth_method_mismatch";
+            /**
+             * @description A human-readable explanation of the mismatch.
+             * @example This installation uses oauth authentication. Use the POST /:slug/token endpoint instead.
+             */
+            message: string;
+        };
         DataIntegrationAccessTokenResponse: {
             /**
              * @description Indicates whether the access token is valid and ready for use, or if reauthorization is required.
@@ -18243,19 +18302,6 @@ export interface components {
              */
             message: string;
         };
-        AuthMethodMismatchError: {
-            /**
-             * @description Error code indicating the endpoint does not match the installation auth method.
-             * @example auth_method_mismatch
-             * @constant
-             */
-            code: "auth_method_mismatch";
-            /**
-             * @description A human-readable explanation of the mismatch.
-             * @example This installation uses oauth authentication. Use the POST /:slug/token endpoint instead.
-             */
-            message: string;
-        };
         DataIntegrationVendedCredential: {
             /**
              * @description Distinguishes the credential object.
@@ -29904,13 +29950,25 @@ export interface operations {
                     };
                 };
             };
-            /** @description The data integration or selected connected account was not found. */
+            /** @description The data integration or selected connected account was not found (`entity_not_found`). */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example entity_not_found
+                         * @constant
+                         */
+                        code: "entity_not_found";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
                         /**
                          * @description A human-readable description of the error.
                          * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
@@ -30140,6 +30198,87 @@ export interface operations {
                     config?: {
                         [key: string]: string;
                     };
+                } | {
+                    /**
+                     * @description The ID of the user to authorize. When `connection_owner` is `organization`, this is the user authorizing on behalf of the organization; they must be an active member of the organization and do not become the owner of the resulting connected account.
+                     * @example user_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    user_id: string;
+                    /**
+                     * @description An organization ID to scope the authorization to a specific organization. Required when `connection_owner` is `organization`.
+                     * @example org_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    organization_id?: string;
+                    /**
+                     * @description Who will own the connected account. `user` (the default) connects the user's own account. `organization` connects the organization's shared account and requires `organization_id`.
+                     * @example user
+                     * @enum {string}
+                     */
+                    connection_owner?: "user" | "organization";
+                    /**
+                     * Format: uri
+                     * @description The URL to redirect the user to after authorization.
+                     * @example https://example.com/callback
+                     */
+                    return_to?: string;
+                    /**
+                     * @description Connect-time config values for the provider-declared `installation`-scope fields (e.g. a Zendesk `subdomain`), keyed by the config field. Only fields the provider declares may be supplied, and required fields must be provided unless already pinned on the integration.
+                     * @example {
+                     *       "subdomain": "acme"
+                     *     }
+                     */
+                    config?: {
+                        [key: string]: string;
+                    };
+                    /**
+                     * @description Create another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration and otherwise returns 404 `multiple_connections_unavailable`. Omit `connection_intent` to use the compatibility connection, or send `reauthorize` with `connected_account_id` to reauthorize one exact connection.
+                     * @example add
+                     * @constant
+                     */
+                    connection_intent: "add";
+                } | {
+                    /**
+                     * @description The ID of the user to authorize. When `connection_owner` is `organization`, this is the user authorizing on behalf of the organization; they must be an active member of the organization and do not become the owner of the resulting connected account.
+                     * @example user_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    user_id: string;
+                    /**
+                     * @description An organization ID to scope the authorization to a specific organization. Required when `connection_owner` is `organization`.
+                     * @example org_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    organization_id?: string;
+                    /**
+                     * @description Who will own the connected account. `user` (the default) connects the user's own account. `organization` connects the organization's shared account and requires `organization_id`.
+                     * @example user
+                     * @enum {string}
+                     */
+                    connection_owner?: "user" | "organization";
+                    /**
+                     * Format: uri
+                     * @description The URL to redirect the user to after authorization.
+                     * @example https://example.com/callback
+                     */
+                    return_to?: string;
+                    /**
+                     * @description Connect-time config values for the provider-declared `installation`-scope fields (e.g. a Zendesk `subdomain`), keyed by the config field. Only fields the provider declares may be supplied, and required fields must be provided unless already pinned on the integration.
+                     * @example {
+                     *       "subdomain": "acme"
+                     *     }
+                     */
+                    config?: {
+                        [key: string]: string;
+                    };
+                    /**
+                     * @description Reauthorize exactly the connection named by `connected_account_id`.
+                     * @example reauthorize
+                     * @constant
+                     */
+                    connection_intent: "reauthorize";
+                    /**
+                     * @description The exact connected account to reauthorize. Required with `connection_intent: reauthorize`.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    connected_account_id: string;
                 };
             };
         };
@@ -30190,13 +30329,25 @@ export interface operations {
                     };
                 };
             };
-            /** @description Not Found */
+            /** @description The integration or user was not found (`entity_not_found`); `connected_account_not_found` when `connected_account_id` does not name a connection for this owner and integration; or `multiple_connections_unavailable` when `connection_intent: add` would create an additional connection before that capability is available. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example multiple_connections_unavailable
+                         * @enum {string}
+                         */
+                        code: "multiple_connections_unavailable" | "connected_account_not_found" | "entity_not_found";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
                         /**
                          * @description A human-readable description of the error.
                          * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
@@ -30205,6 +30356,15 @@ export interface operations {
                     };
                 };
             };
+            /** @description The selected connected account does not use OAuth authentication. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthMethodMismatchError"];
+                };
+            };
         };
     };
     DataIntegrationsController_upsertClientCredentials: {
@@ -30409,13 +30569,25 @@ export interface operations {
                     };
                 };
             };
-            /** @description The data integration or selected connected account was not found. */
+            /** @description The data integration or selected connected account was not found (`entity_not_found`). */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example entity_not_found
+                         * @constant
+                         */
+                        code: "entity_not_found";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
                         /**
                          * @description A human-readable description of the error.
                          * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
@@ -31338,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.116.0",
+  "version": "0.118.0",
   "type": "module",
   "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
   "license": "MIT",