@workos/openapi-spec 0.49.0 → 0.51.0

package/dist/open-api-spec.yaml

@@ -7737,6 +7737,18 @@ paths:
                   format: uri
                   description: The URL to redirect the user to after authorization.
                   example: https://example.com/callback
+                config:
+                  type: object
+                  additionalProperties:
+                    type: 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
               required:
                 - user_id
       responses:
@@ -10193,10 +10205,13 @@ paths:
         '400':
           description: >-
             The request body is invalid. Possible reasons: the body is empty (at
-            least one of `enabled`, `scopes`, or `client_id` must be provided);
-            `client_id` and `client_secret` are not provided together; or
-            `client_id`/`client_secret` were supplied for a provider that does
-            not support organization-managed credentials.
+            least one of `enabled`, `scopes`, `client_id`, or `config` must be
+            provided); `client_id` and `client_secret` are not provided
+            together; `client_id`/`client_secret` were supplied for a provider
+            that does not support organization-managed credentials; or `config`
+            contains a field the provider does not declare, a value that does
+            not match that field's pattern, or was supplied for a provider whose
+            credentials are not organization-managed.
           content:
             application/json:
               schema:
@@ -35555,6 +35570,17 @@ components:
               items:
                 type: string
             - type: 'null'
+        config:
+          type: object
+          additionalProperties:
+            type: string
+          description: >-
+            The provider-specific config values in effect for this organization,
+            keyed by config field. Reflects the organization override for
+            organization-credential providers, otherwise the provider root.
+            Empty when none are configured.
+          example:
+            account_identifier: acme-prod
         created_at:
           type: string
           description: The timestamp when the configuration was created.
@@ -35573,6 +35599,7 @@ components:
         - name
         - enabled
         - scopes
+        - config
         - created_at
         - updated_at
     DataIntegrationConfigurationListResponse:
@@ -35624,6 +35651,20 @@ components:
             The OAuth client secret of the organization's own application. Must
             be provided together with `client_id`.
           example: ••••••••
+        config:
+          type: object
+          additionalProperties:
+            type: string
+          description: >-
+            Provider-specific config values to set for the organization, keyed
+            by config field. Only fields the provider declares are accepted, and
+            each value must match that field's pattern. Accepted only for
+            providers whose credentials are organization-managed; for shared or
+            custom credential providers, config belongs on the integration
+            itself (via the data-integrations API) and supplying it here is
+            rejected.
+          example:
+            account_identifier: acme-prod
     DataIntegration:
       type: object
       properties:
@@ -35688,6 +35729,7 @@ components:
             enum:
               - oauth
               - api_key
+              - client_credentials
           description: >-
             How accounts authenticate with the provider for this Data
             Integration.
@@ -36202,9 +36244,10 @@ components:
           enum:
             - oauth
             - api_key
+            - client_credentials
           description: >-
-            The authentication method used for this connection (`oauth` or
-            `api_key`). Defaults to `oauth` if absent.
+            The authentication method used for this connection (`oauth`,
+            `api_key`, or `client_credentials`). Defaults to `oauth` if absent.
           example: oauth
         api_key_last_4:
           type:
@@ -36312,10 +36355,11 @@ components:
                   enum:
                     - oauth
                     - api_key
+                    - client_credentials
                 description: >-
                   The authentication methods supported by this provider
-                  (`oauth`, `api_key`, or both). Defaults to `["oauth"]` if
-                  absent.
+                  (`oauth`, `api_key`, `client_credentials`, or a combination).
+                  Defaults to `["oauth"]` if absent.
                 example:
                   - oauth
               ownership:
@@ -36394,9 +36438,11 @@ components:
                         enum:
                           - oauth
                           - api_key
+                          - client_credentials
                         description: >-
                           The authentication method used for this connection
-                          (`oauth` or `api_key`). Defaults to `oauth` if absent.
+                          (`oauth`, `api_key`, or `client_credentials`).
+                          Defaults to `oauth` if absent.
                         example: oauth
                       api_key_last_4:
                         type:

package/dist/types.d.ts

@@ -15208,6 +15208,15 @@ export interface components {
              *     ]
              */
             scopes: string[] | null;
+            /**
+             * @description The provider-specific config values in effect for this organization, keyed by config field. Reflects the organization override for organization-credential providers, otherwise the provider root. Empty when none are configured.
+             * @example {
+             *       "account_identifier": "acme-prod"
+             *     }
+             */
+            config: {
+                [key: string]: string;
+            };
             /**
              * @description The timestamp when the configuration was created.
              * @example 2024-01-15T10:30:00.000Z
@@ -15253,6 +15262,15 @@ export interface components {
              * @example ••••••••
              */
             client_secret?: string;
+            /**
+             * @description Provider-specific config values to set for the organization, keyed by config field. Only fields the provider declares are accepted, and each value must match that field's pattern. Accepted only for providers whose credentials are organization-managed; for shared or custom credential providers, config belongs on the integration itself (via the data-integrations API) and supplying it here is rejected.
+             * @example {
+             *       "account_identifier": "acme-prod"
+             *     }
+             */
+            config?: {
+                [key: string]: string;
+            };
         };
         DataIntegration: {
             /**
@@ -15311,7 +15329,7 @@ export interface components {
              *       "oauth"
              *     ]
              */
-            auth_methods: ("oauth" | "api_key")[];
+            auth_methods: ("oauth" | "api_key" | "client_credentials")[];
             /** @description The credentials configured for the Data Integration. */
             credentials: {
                 /**
@@ -15646,11 +15664,11 @@ export interface components {
              */
             scopes: string[];
             /**
-             * @description The authentication method used for this connection (`oauth` or `api_key`). Defaults to `oauth` if absent.
+             * @description The authentication method used for this connection (`oauth`, `api_key`, or `client_credentials`). Defaults to `oauth` if absent.
              * @example oauth
              * @enum {string}
              */
-            auth_method?: "oauth" | "api_key";
+            auth_method?: "oauth" | "api_key" | "client_credentials";
             /**
              * @description The last four characters of the API key, or `null` for OAuth connections.
              * @example null
@@ -15728,12 +15746,12 @@ export interface components {
                  */
                 scopes: string[] | null;
                 /**
-                 * @description The authentication methods supported by this provider (`oauth`, `api_key`, or both). Defaults to `["oauth"]` if absent.
+                 * @description The authentication methods supported by this provider (`oauth`, `api_key`, `client_credentials`, or a combination). Defaults to `["oauth"]` if absent.
                  * @example [
                  *       "oauth"
                  *     ]
                  */
-                auth_methods?: ("oauth" | "api_key")[];
+                auth_methods?: ("oauth" | "api_key" | "client_credentials")[];
                 /**
                  * @description Whether the provider is owned by a user or organization.
                  * @enum {string}
@@ -15800,11 +15818,11 @@ export interface components {
                      */
                     scopes: string[];
                     /**
-                     * @description The authentication method used for this connection (`oauth` or `api_key`). Defaults to `oauth` if absent.
+                     * @description The authentication method used for this connection (`oauth`, `api_key`, or `client_credentials`). Defaults to `oauth` if absent.
                      * @example oauth
                      * @enum {string}
                      */
-                    auth_method?: "oauth" | "api_key";
+                    auth_method?: "oauth" | "api_key" | "client_credentials";
                     /**
                      * @description The last four characters of the API key, or `null` for OAuth connections.
                      * @example null
@@ -23878,6 +23896,15 @@ export interface operations {
                      * @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;
+                    };
                 };
             };
         };
@@ -26113,7 +26140,7 @@ export interface operations {
                     "application/json": components["schemas"]["DataIntegrationConfigurationResponse"];
                 };
             };
-            /** @description The request body is invalid. Possible reasons: the body is empty (at least one of `enabled`, `scopes`, or `client_id` must be provided); `client_id` and `client_secret` are not provided together; or `client_id`/`client_secret` were supplied for a provider that does not support organization-managed credentials. */
+            /** @description The request body is invalid. Possible reasons: the body is empty (at least one of `enabled`, `scopes`, `client_id`, or `config` must be provided); `client_id` and `client_secret` are not provided together; `client_id`/`client_secret` were supplied for a provider that does not support organization-managed credentials; or `config` contains a field the provider does not declare, a value that does not match that field's pattern, or was supplied for a provider whose credentials are not organization-managed. */
             400: {
                 headers: {
                     [name: string]: unknown;

package/package.json

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