@workos/openapi-spec 0.85.0 → 0.87.0

package/dist/open-api-spec.yaml

@@ -10588,8 +10588,9 @@ paths:
     put:
       description: >-
         Creates or updates an API-key-based installation for the specified
-        integration and user. If an installation already exists, the stored API
-        key is rotated to the new value.
+        integration, owned by the user or, when `connection_owner` is
+        `organization`, shared by the organization. If an installation already
+        exists, the stored API key is rotated to the new value.
       operationId: DataIntegrationsController_upsertApiKey
       parameters:
         - name: slug
@@ -10615,8 +10616,30 @@ paths:
                   description: >-
                     An [Organization](/reference/organization) identifier.
                     Optional parameter to scope the connection to a specific
-                    organization.
+                    organization. Required when `connection_owner` is
+                    `organization`.
                   example: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connected_account_id:
+                  type: string
+                  pattern: ^data_installation_.+$
+                  description: >-
+                    A [connected account](/reference/pipes/connected-account)
+                    identifier. Use this to rotate a specific existing
+                    connection.
+                  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                connection_owner:
+                  type: string
+                  enum:
+                    - user
+                    - organization
+                  description: >-
+                    Whose connection to create or rotate. `user` (the default)
+                    addresses the connection owned by `user_id`. `organization`
+                    addresses the connection shared by every member of
+                    `organization_id`; `user_id` then identifies the member
+                    performing the request and must be an active member of the
+                    organization.
+                  example: user
                 secret:
                   type: string
                   minLength: 1
@@ -10672,7 +10695,7 @@ paths:
                 required:
                   - message
         '404':
-          description: Data integration not found for the given provider slug.
+          description: The data integration or selected connected account was not found.
           content:
             application/json:
               schema:
@@ -10686,19 +10709,12 @@ paths:
                   - message
         '409':
           description: >-
-            Several connected accounts match this user for the provider; one
-            must be named.
+            Several connected accounts match the connection owner for the
+            provider; one must be named.
           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
+                $ref: '#/components/schemas/AccountSelectionRequiredError'
         '422':
           description: >-
             The matched installation uses a different auth method than this
@@ -10818,8 +10834,9 @@ paths:
     put:
       description: >-
         Creates or updates a client-credentials-based installation for the
-        specified integration and user. If an installation already exists, the
-        stored client credentials are rotated to the new values.
+        specified integration, owned by the user or, when `connection_owner` is
+        `organization`, shared by the organization. If an installation already
+        exists, the stored client credentials are rotated to the new values.
       operationId: DataIntegrationsController_upsertClientCredentials
       parameters:
         - name: slug
@@ -10845,8 +10862,30 @@ paths:
                   description: >-
                     An [Organization](/reference/organization) identifier.
                     Optional parameter to scope the connection to a specific
-                    organization.
+                    organization. Required when `connection_owner` is
+                    `organization`.
                   example: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connected_account_id:
+                  type: string
+                  pattern: ^data_installation_.+$
+                  description: >-
+                    A [connected account](/reference/pipes/connected-account)
+                    identifier. Use this to rotate a specific existing
+                    connection.
+                  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                connection_owner:
+                  type: string
+                  enum:
+                    - user
+                    - organization
+                  description: >-
+                    Whose connection to create or rotate. `user` (the default)
+                    addresses the connection owned by `user_id`. `organization`
+                    addresses the connection shared by every member of
+                    `organization_id`; `user_id` then identifies the member
+                    performing the request and must be an active member of the
+                    organization.
+                  example: user
                 client_id:
                   type: string
                   minLength: 1
@@ -10917,7 +10956,7 @@ paths:
                 required:
                   - message
         '404':
-          description: Data integration not found for the given provider slug.
+          description: The data integration or selected connected account was not found.
           content:
             application/json:
               schema:
@@ -10931,19 +10970,12 @@ paths:
                   - message
         '409':
           description: >-
-            Several connected accounts match this user for the provider; one
-            must be named.
+            Several connected accounts match the connection owner for the
+            provider; one must be named.
           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
+                $ref: '#/components/schemas/AccountSelectionRequiredError'
         '422':
           description: >-
             The matched installation uses a different auth method than this
@@ -11082,14 +11114,7 @@ paths:
           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
+                $ref: '#/components/schemas/AccountSelectionRequiredError'
         '422':
           description: >-
             The installation uses an auth method that is not yet supported by
@@ -11224,14 +11249,7 @@ paths:
           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
+                $ref: '#/components/schemas/AccountSelectionRequiredError'
         '422':
           description: >-
             The matched installation uses a different auth method than this
@@ -22291,14 +22309,7 @@ paths:
           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
+                $ref: '#/components/schemas/AccountSelectionRequiredError'
       summary: Get a connected account
       tags:
         - user-management.data-providers
@@ -22382,14 +22393,7 @@ paths:
           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
+                $ref: '#/components/schemas/AccountSelectionRequiredError'
       summary: Delete a connected account
       tags:
         - user-management.data-providers
@@ -22576,14 +22580,7 @@ paths:
           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
+                $ref: '#/components/schemas/AccountSelectionRequiredError'
       summary: Update a connected account
       tags:
         - user-management.data-providers
@@ -42847,6 +42844,25 @@ components:
           required:
             - active
             - error
+    AccountSelectionRequiredError:
+      type: object
+      properties:
+        code:
+          type: string
+          description: >-
+            Indicates that several connected accounts match and the request must
+            name one.
+          example: account_selection_required
+          const: account_selection_required
+        message:
+          type: string
+          description: A human-readable explanation of the ambiguity.
+          example: >-
+            Several connected accounts match this user for this provider. Name
+            one with a connected account id.
+      required:
+        - code
+        - message
     AuthMethodMismatchError:
       type: object
       properties:

package/dist/types.d.ts

@@ -1471,7 +1471,7 @@ export interface paths {
         get?: never;
         /**
          * Upsert an API key for a connected account
-         * @description Creates or updates an API-key-based installation for the specified integration and user. If an installation already exists, the stored API key is rotated to the new value.
+         * @description Creates or updates an API-key-based installation for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. If an installation already exists, the stored API key is rotated to the new value.
          */
         put: operations["DataIntegrationsController_upsertApiKey"];
         post?: never;
@@ -1511,7 +1511,7 @@ export interface paths {
         get?: never;
         /**
          * Upsert client credentials for a connected account
-         * @description Creates or updates a client-credentials-based installation for the specified integration and user. If an installation already exists, the stored client credentials are rotated to the new values.
+         * @description Creates or updates a client-credentials-based installation for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. If an installation already exists, the stored client credentials are rotated to the new values.
          */
         put: operations["DataIntegrationsController_upsertClientCredentials"];
         post?: never;
@@ -17580,6 +17580,19 @@ export interface components {
              */
             error: "needs_reauthorization" | "not_installed";
         };
+        AccountSelectionRequiredError: {
+            /**
+             * @description Indicates that several connected accounts match and the request must name one.
+             * @example account_selection_required
+             * @constant
+             */
+            code: "account_selection_required";
+            /**
+             * @description A human-readable explanation of the ambiguity.
+             * @example Several connected accounts match this user for this provider. Name one with a connected account id.
+             */
+            message: string;
+        };
         AuthMethodMismatchError: {
             /**
              * @description Error code indicating the endpoint does not match the installation auth method.
@@ -28822,10 +28835,21 @@ export interface operations {
                      */
                     user_id: string;
                     /**
-                     * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
+                     * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
                      * @example org_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     organization_id?: string;
+                    /**
+                     * @description A [connected account](/reference/pipes/connected-account) identifier. Use this to rotate a specific existing connection.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    connected_account_id?: string;
+                    /**
+                     * @description Whose connection to create or rotate. `user` (the default) addresses the connection owned by `user_id`. `organization` addresses the connection shared by every member of `organization_id`; `user_id` then identifies the member performing the request and must be an active member of the organization.
+                     * @example user
+                     * @enum {string}
+                     */
+                    connection_owner?: "user" | "organization";
                     /**
                      * @description The API key secret to store for this integration.
                      * @example sk-1234567890abcdef
@@ -28895,7 +28919,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description Data integration not found for the given provider slug. */
+            /** @description The data integration or selected connected account was not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -28910,19 +28934,13 @@ export interface operations {
                     };
                 };
             };
-            /** @description Several connected accounts match this user for the provider; one must be named. */
+            /** @description Several connected accounts match the connection owner for the provider; one must be named. */
             409: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
-                    };
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
                 };
             };
             /** @description The matched installation uses a different auth method than this endpoint expects. */
@@ -29060,10 +29078,21 @@ export interface operations {
                      */
                     user_id: string;
                     /**
-                     * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
+                     * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
                      * @example org_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     organization_id?: string;
+                    /**
+                     * @description A [connected account](/reference/pipes/connected-account) identifier. Use this to rotate a specific existing connection.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    connected_account_id?: string;
+                    /**
+                     * @description Whose connection to create or rotate. `user` (the default) addresses the connection owned by `user_id`. `organization` addresses the connection shared by every member of `organization_id`; `user_id` then identifies the member performing the request and must be an active member of the organization.
+                     * @example user
+                     * @enum {string}
+                     */
+                    connection_owner?: "user" | "organization";
                     /**
                      * @description The OAuth client ID to store for this integration.
                      * @example 3MVG9...
@@ -29146,7 +29175,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description Data integration not found for the given provider slug. */
+            /** @description The data integration or selected connected account was not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -29161,19 +29190,13 @@ export interface operations {
                     };
                 };
             };
-            /** @description Several connected accounts match this user for the provider; one must be named. */
+            /** @description Several connected accounts match the connection owner for the provider; one must be named. */
             409: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
-                    };
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
                 };
             };
             /** @description The matched installation uses a different auth method than this endpoint expects. */
@@ -29308,13 +29331,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
-                    };
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
                 };
             };
             /** @description The installation uses an auth method that is not yet supported by this endpoint. */
@@ -29439,13 +29456,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
-                    };
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
                 };
             };
             /** @description The matched installation uses a different auth method than this endpoint expects. */
@@ -38975,13 +38986,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
-                    };
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
                 };
             };
         };
@@ -39061,13 +39066,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
-                    };
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
                 };
             };
         };
@@ -39225,13 +39224,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
-                    };
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
                 };
             };
         };

package/package.json

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