@workos/openapi-spec 0.94.0 → 0.95.0

package/dist/types.d.ts

@@ -2217,6 +2217,58 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/organizations/{organization_id}/connected_accounts/{slug}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get an organization connected account
+         * @description Retrieves an organization's [connected account](/reference/pipes/connected-account) for a specific provider.
+         */
+        get: operations["DataIntegrationsOrganizationController_getOrganizationDataInstallation"];
+        /**
+         * Update an organization connected account
+         * @description Updates an organization's [connected account](/reference/pipes/connected-account) tokens, scopes, or state for a specific provider.
+         */
+        put: operations["DataIntegrationsOrganizationController_updateOrganizationDataInstallation"];
+        /**
+         * Import an organization connected account
+         * @description Imports an organization-owned [connected account](/reference/pipes/connected-account) by providing OAuth tokens directly. Use this to migrate existing connections or set up connections without going through the OAuth flow.
+         */
+        post: operations["DataIntegrationsOrganizationController_createOrganizationDataInstallation"];
+        /**
+         * Delete an organization connected account
+         * @description Disconnects the organization's account for the provider, including removing any stored access and refresh tokens. A member will need to reauthorize if the organization wants to reconnect. This does not revoke access on the provider side.
+         */
+        delete: operations["DataIntegrationsOrganizationController_deleteOrganizationDataInstallation"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/organizations/{organization_id}/data_providers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List providers for an organization
+         * @description Retrieves the organization-owned providers configured for your environment and the organization's [connected account](/reference/pipes/connected-account) information for each. Providers owned by individual users are not included.
+         */
+        get: operations["DataIntegrationsOrganizationController_getOrganizationDataIntegrations"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/organizations/{organization_id}/it_contacts": {
         parameters: {
             query?: never;
@@ -29371,15 +29423,21 @@ export interface operations {
             content: {
                 "application/json": {
                     /**
-                     * @description The ID of the user to authorize.
+                     * @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.
+                     * @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.
@@ -32901,6 +32959,597 @@ export interface operations {
             };
         };
     };
+    DataIntegrationsOrganizationController_getOrganizationDataInstallation: {
+        parameters: {
+            query?: {
+                /** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
+                supports_multiple_connections?: boolean;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the organization has several for this provider. */
+                connected_account_id?: string;
+            };
+            header?: never;
+            path: {
+                /** @description An [Organization](/reference/organization) identifier. */
+                organization_id: string;
+                /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The connected account was retrieved successfully. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "object": "connected_account",
+                     *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "user_id": null,
+                     *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "scopes": [
+                     *         "repo",
+                     *         "user:email"
+                     *       ],
+                     *       "auth_method": "oauth",
+                     *       "api_key_last_4": null,
+                     *       "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
+                     *       "client_secret_last_4": "cdef",
+                     *       "config": {
+                     *         "instance_url": "https://example.my.salesforce.com"
+                     *       },
+                     *       "state": "connected",
+                     *       "created_at": "2024-01-16T14:20:00.000Z",
+                     *       "updated_at": "2024-01-16T14:20:00.000Z"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ConnectedAccount"];
+                };
+            };
+            /** @description The connected account selector is malformed. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description The request is missing a valid API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The organization or connected account was 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 Several connected accounts match this organization for the provider; one must be named. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
+                };
+            };
+        };
+    };
+    DataIntegrationsOrganizationController_updateOrganizationDataInstallation: {
+        parameters: {
+            query?: {
+                /** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
+                supports_multiple_connections?: boolean;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to update. */
+                connected_account_id?: string;
+            };
+            header?: never;
+            path: {
+                /** @description An [Organization](/reference/organization) identifier. */
+                organization_id: string;
+                /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ConnectedAccountDto"];
+            };
+        };
+        responses: {
+            /** @description The connected account was updated successfully. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "object": "connected_account",
+                     *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "user_id": null,
+                     *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "scopes": [
+                     *         "repo",
+                     *         "user:email"
+                     *       ],
+                     *       "auth_method": "oauth",
+                     *       "api_key_last_4": null,
+                     *       "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
+                     *       "client_secret_last_4": "cdef",
+                     *       "config": {
+                     *         "instance_url": "https://example.my.salesforce.com"
+                     *       },
+                     *       "state": "connected",
+                     *       "created_at": "2024-01-16T14:20:00.000Z",
+                     *       "updated_at": "2024-01-16T14:20:00.000Z"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ConnectedAccount"];
+                };
+            };
+            /** @description The connected account selector is malformed. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description The request is missing a valid API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The organization or connected account was 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 Several connected accounts match this organization for the provider; one must be named. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
+                };
+            };
+            /** @description The request body is malformed (`invalid_request_parameters`). */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example invalid_request_parameters
+                         * @constant
+                         */
+                        code: "invalid_request_parameters";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Validation failed.
+                         */
+                        message: string;
+                        /** @description The list of validation errors. */
+                        errors: {
+                            /**
+                             * @description The validation error code.
+                             * @example unknown_event_type
+                             */
+                            code: string;
+                            /**
+                             * @description A human-readable description of the validation error.
+                             * @example Invalid enum value.
+                             */
+                            message: string;
+                        }[];
+                    };
+                };
+            };
+        };
+    };
+    DataIntegrationsOrganizationController_createOrganizationDataInstallation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description An [Organization](/reference/organization) identifier. */
+                organization_id: string;
+                /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ConnectedAccountDto"];
+            };
+        };
+        responses: {
+            /** @description The connected account was created successfully. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "object": "connected_account",
+                     *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "user_id": null,
+                     *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "scopes": [
+                     *         "repo",
+                     *         "user:email"
+                     *       ],
+                     *       "auth_method": "oauth",
+                     *       "api_key_last_4": null,
+                     *       "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
+                     *       "client_secret_last_4": "cdef",
+                     *       "config": {
+                     *         "instance_url": "https://example.my.salesforce.com"
+                     *       },
+                     *       "state": "connected",
+                     *       "created_at": "2024-01-16T14:20:00.000Z",
+                     *       "updated_at": "2024-01-16T14:20:00.000Z"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ConnectedAccount"];
+                };
+            };
+            /** @description The request is missing a valid API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The organization or data integration was 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 connected account already exists for this organization and integration. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description The request body is malformed (`invalid_request_parameters`), the data integration is not in a valid state (`invalid_data_integration_state`), the token combination is invalid (`invalid_token_combination`), or no client credentials are configured for the data integration (`client_credentials_not_configured`). */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example invalid_token_combination
+                         * @enum {string}
+                         */
+                        code: "invalid_token_combination" | "invalid_data_integration_state" | "client_credentials_not_configured";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    } | {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example invalid_request_parameters
+                         * @constant
+                         */
+                        code: "invalid_request_parameters";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Validation failed.
+                         */
+                        message: string;
+                        /** @description The list of validation errors. */
+                        errors: {
+                            /**
+                             * @description The validation error code.
+                             * @example unknown_event_type
+                             */
+                            code: string;
+                            /**
+                             * @description A human-readable description of the validation error.
+                             * @example Invalid enum value.
+                             */
+                            message: string;
+                        }[];
+                    };
+                };
+            };
+        };
+    };
+    DataIntegrationsOrganizationController_deleteOrganizationDataInstallation: {
+        parameters: {
+            query?: {
+                /** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
+                supports_multiple_connections?: boolean;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to delete. */
+                connected_account_id?: string;
+            };
+            header?: never;
+            path: {
+                /** @description An [Organization](/reference/organization) identifier. */
+                organization_id: string;
+                /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The connected account was deleted successfully. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The connected account selector is malformed. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+            /** @description The request is missing a valid API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The organization or connected account was 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 Several connected accounts match this organization for the provider; one must be named. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccountSelectionRequiredError"];
+                };
+            };
+            /** @description The connected account or its WorkOS OAuth grant is being changed by another request. Retry the request. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example concurrent_request
+                         * @constant
+                         */
+                        code: "concurrent_request";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    };
+                };
+            };
+        };
+    };
+    DataIntegrationsOrganizationController_getOrganizationDataIntegrations: {
+        parameters: {
+            query?: {
+                /** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
+                supports_multiple_connections?: boolean;
+            };
+            header?: never;
+            path: {
+                /** @description An [Organization](/reference/organization) identifier to list providers and connected accounts for. */
+                organization_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The list of data providers was retrieved successfully. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "object": "list",
+                     *       "data": [
+                     *         {
+                     *           "object": "data_provider",
+                     *           "id": "data_integration_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *           "name": "GitHub",
+                     *           "description": "Connect your GitHub account to access repositories.",
+                     *           "slug": "github",
+                     *           "integration_type": "github",
+                     *           "credentials_type": "oauth2",
+                     *           "scopes": [
+                     *             "repo",
+                     *             "user:email"
+                     *           ],
+                     *           "auth_methods": [
+                     *             "oauth"
+                     *           ],
+                     *           "ownership": "organization",
+                     *           "created_at": "2024-01-15T10:30:00.000Z",
+                     *           "updated_at": "2024-01-15T10:30:00.000Z",
+                     *           "integrationType": "github",
+                     *           "credentialsType": "oauth2",
+                     *           "createdAt": "2024-01-15T10:30:00.000Z",
+                     *           "updatedAt": "2024-01-15T10:30:00.000Z",
+                     *           "connected_account": {
+                     *             "object": "connected_account",
+                     *             "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *             "user_id": null,
+                     *             "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *             "scopes": [
+                     *               "repo",
+                     *               "user:email"
+                     *             ],
+                     *             "auth_method": "oauth",
+                     *             "api_key_last_4": null,
+                     *             "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
+                     *             "client_secret_last_4": "cdef",
+                     *             "config": {
+                     *               "instance_url": "https://example.my.salesforce.com"
+                     *             },
+                     *             "state": "connected",
+                     *             "created_at": "2024-01-16T14:20:00.000Z",
+                     *             "updated_at": "2024-01-16T14:20:00.000Z",
+                     *             "userlandUserId": null,
+                     *             "organizationId": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *             "createdAt": "2024-01-16T14:20:00.000Z",
+                     *             "updatedAt": "2024-01-16T14:20:00.000Z"
+                     *           },
+                     *           "connected_accounts": [
+                     *             {
+                     *               "object": "connected_account",
+                     *               "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *               "user_id": null,
+                     *               "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *               "scopes": [
+                     *                 "repo",
+                     *                 "user:email"
+                     *               ],
+                     *               "auth_method": "oauth",
+                     *               "api_key_last_4": null,
+                     *               "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
+                     *               "client_secret_last_4": "cdef",
+                     *               "config": {
+                     *                 "instance_url": "https://example.my.salesforce.com"
+                     *               },
+                     *               "state": "connected",
+                     *               "created_at": "2024-01-16T14:20:00.000Z",
+                     *               "updated_at": "2024-01-16T14:20:00.000Z",
+                     *               "userlandUserId": null,
+                     *               "organizationId": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *               "createdAt": "2024-01-16T14:20:00.000Z",
+                     *               "updatedAt": "2024-01-16T14:20:00.000Z"
+                     *             }
+                     *           ]
+                     *         }
+                     *       ]
+                     *     }
+                     */
+                    "application/json": components["schemas"]["DataIntegrationsListResponse"];
+                };
+            };
+            /** @description The request is missing a valid API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The organization was 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;
+                    };
+                };
+            };
+        };
+    };
     ItContactsController_list: {
         parameters: {
             query?: never;
@@ -40126,7 +40775,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description The request body is malformed (`invalid_request_parameters`), the data integration is not in a valid state (`invalid_data_integration_state`), the token combination is invalid (`invalid_token_combination`), or `refresh_token` is not an active WorkOS OAuth grant of this user (`invalid_refresh_token`). */
+            /** @description The request body is malformed (`invalid_request_parameters`), the data integration is not in a valid state (`invalid_data_integration_state`), the token combination is invalid (`invalid_token_combination`), no client credentials are configured for the data integration (`client_credentials_not_configured`), or `refresh_token` is not an active WorkOS OAuth grant of this user (`invalid_refresh_token`). */
             422: {
                 headers: {
                     [name: string]: unknown;
@@ -40138,7 +40787,7 @@ export interface operations {
                          * @example invalid_refresh_token
                          * @enum {string}
                          */
-                        code: "invalid_refresh_token" | "invalid_token_combination" | "invalid_data_integration_state";
+                        code: "invalid_refresh_token" | "invalid_token_combination" | "invalid_data_integration_state" | "client_credentials_not_configured";
                         /**
                          * @description A human-readable description of the error.
                          * @example Request could not be processed.