@workos/openapi-spec 0.57.0 → 0.59.0

package/dist/open-api-spec.yaml

@@ -8013,6 +8013,21 @@ paths:
                     example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
                 required:
                   - message
+        '422':
+          description: >-
+            The installation uses an auth method that is not yet supported by
+            this endpoint.
+          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
       summary: Vend credentials for a connected account
       tags:
         - pipes
@@ -21184,12 +21199,16 @@ components:
         authorization_url:
           type: string
           format: uri
-          description: The provider's OAuth authorization endpoint.
+          description: >-
+            The provider's OAuth authorization endpoint. Required for OAuth
+            providers; omit for `api_key` providers.
           example: https://provider.example.com/oauth/authorize
         token_url:
           type: string
           format: uri
-          description: The provider's OAuth token endpoint.
+          description: >-
+            The provider's OAuth token endpoint. Required for OAuth providers;
+            omit for `api_key` providers.
           example: https://provider.example.com/oauth/token
         refresh_token_url:
           type:
@@ -21246,8 +21265,6 @@ components:
           example: request_body
       required:
         - name
-        - authorization_url
-        - token_url
     CreateDataIntegrationDto:
       type: object
       properties:
@@ -36292,6 +36309,7 @@ components:
                   x-extensible-enum:
                     - oauth
                     - api_key
+                    - client_credentials
                   const: oauth
                 value:
                   type: string
@@ -36354,6 +36372,7 @@ components:
                   x-extensible-enum:
                     - oauth
                     - api_key
+                    - client_credentials
                   const: api_key
                 value:
                   type: string
@@ -36367,6 +36386,78 @@ components:
           required:
             - active
             - credential
+        - type: object
+          properties:
+            active:
+              type: boolean
+              description: Indicates credentials are available.
+              const: true
+            credential:
+              type: object
+              properties:
+                object:
+                  type: string
+                  description: Distinguishes the credential object.
+                  const: credential
+                auth_method:
+                  type: string
+                  description: >-
+                    The authentication method for this credential. Additional
+                    values may be added in the future; handle unknown values
+                    gracefully.
+                  x-extensible-enum:
+                    - oauth
+                    - api_key
+                    - client_credentials
+                  const: client_credentials
+                value:
+                  type: string
+                  description: The client-credentials access token.
+                  example: 00D5g000000XXXX!AQEAQ...
+                expires_at:
+                  type:
+                    - string
+                    - 'null'
+                  description: >-
+                    The ISO-8601 formatted timestamp indicating when the
+                    credential expires.
+                  example: '2025-12-31T23:59:59.000Z'
+                scopes:
+                  type: array
+                  items:
+                    type: string
+                  description: The scopes granted to the access token.
+                  example:
+                    - api
+                missing_scopes:
+                  type: array
+                  items:
+                    type: string
+                  description: >-
+                    If the integration has requested scopes that aren't present
+                    on the access token, they're listed here.
+                  example: []
+                metadata:
+                  type: object
+                  additionalProperties: {}
+                  description: >-
+                    Non-sensitive fields captured from the provider token
+                    response (e.g. Salesforce `instance_url`), as configured for
+                    the provider.
+                  example:
+                    instance_url: https://acme.my.salesforce.com
+              required:
+                - object
+                - auth_method
+                - value
+                - expires_at
+                - scopes
+                - missing_scopes
+                - metadata
+              description: The credential object containing the vended secret.
+          required:
+            - active
+            - credential
         - type: object
           properties:
             active:

package/dist/types.d.ts

@@ -4260,16 +4260,16 @@ export interface components {
             name: string;
             /**
              * Format: uri
-             * @description The provider's OAuth authorization endpoint.
+             * @description The provider's OAuth authorization endpoint. Required for OAuth providers; omit for `api_key` providers.
              * @example https://provider.example.com/oauth/authorize
              */
-            authorization_url: string;
+            authorization_url?: string;
             /**
              * Format: uri
-             * @description The provider's OAuth token endpoint.
+             * @description The provider's OAuth token endpoint. Required for OAuth providers; omit for `api_key` providers.
              * @example https://provider.example.com/oauth/token
              */
-            token_url: string;
+            token_url?: string;
             /**
              * Format: uri
              * @description The endpoint used to refresh tokens, if different from the token endpoint.
@@ -15672,6 +15672,56 @@ export interface components {
                  */
                 value: string;
             };
+        } | {
+            /**
+             * @description Indicates credentials are available.
+             * @constant
+             */
+            active: true;
+            /** @description The credential object containing the vended secret. */
+            credential: {
+                /**
+                 * @description Distinguishes the credential object.
+                 * @constant
+                 */
+                object: "credential";
+                /**
+                 * @description The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully.
+                 * @constant
+                 */
+                auth_method: "client_credentials";
+                /**
+                 * @description The client-credentials access token.
+                 * @example 00D5g000000XXXX!AQEAQ...
+                 */
+                value: string;
+                /**
+                 * @description The ISO-8601 formatted timestamp indicating when the credential expires.
+                 * @example 2025-12-31T23:59:59.000Z
+                 */
+                expires_at: string | null;
+                /**
+                 * @description The scopes granted to the access token.
+                 * @example [
+                 *       "api"
+                 *     ]
+                 */
+                scopes: string[];
+                /**
+                 * @description If the integration has requested scopes that aren't present on the access token, they're listed here.
+                 * @example []
+                 */
+                missing_scopes: string[];
+                /**
+                 * @description Non-sensitive fields captured from the provider token response (e.g. Salesforce `instance_url`), as configured for the provider.
+                 * @example {
+                 *       "instance_url": "https://acme.my.salesforce.com"
+                 *     }
+                 */
+                metadata: {
+                    [key: string]: unknown;
+                };
+            };
         } | {
             /**
              * @description Indicates credentials are not available.
@@ -24245,6 +24295,21 @@ export interface operations {
                     };
                 };
             };
+            /** @description The installation uses an auth method that is not yet supported by this endpoint. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
         };
     };
     DataIntegrationsController_getUserlandUserToken: {

package/package.json

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