Update OpenAPI spec (bf9c417)

.last-synced-sha

@@ -1 +1 @@
-005c716e68a7846c61ed4495986dad17d10dbd95
+bf9c417018b5ce2feb68fa97f8d38b4bf4f900cf

package.json

@@ -52,16 +52,16 @@
     "prepare": "husky"
   },
   "overrides": {
-    "js-yaml": "^5.3.0",
+    "js-yaml": "^5.4.1",
     "lodash": "^4.17.23"
   },
   "devDependencies": {
-    "@types/node": "^26.2.0",
+    "@types/node": "^26.4.0",
     "@workos/oagen": "^0.29.2",
-    "@workos/oagen-emitters": "^0.24.4",
+    "@workos/oagen-emitters": "^0.24.5",
     "diff2html": "^3.4.56",
     "husky": "^9.1.7",
-    "js-yaml": "^5.3.0",
+    "js-yaml": "^5.4.1",
     "openapi-to-postmanv2": "^6.3.3",
     "tsdown": "^0.22.14",
     "tsx": "^4.23.12",

spec/open-api-spec.yaml

@@ -22467,14 +22467,19 @@ components:
           format: uri
           description: >-
             The provider's OAuth authorization endpoint. Required for OAuth
-            providers; omit for `api_key` providers.
+            providers; omit for `api_key` providers. Must be a static URL:
+            `${config.…}` placeholders are resolved against a provider's
+            declared config fields, which custom providers cannot declare.
           example: https://provider.example.com/oauth/authorize
         token_url:
           type: string
           format: uri
           description: >-
-            The provider's OAuth token endpoint. Required for OAuth providers;
-            omit for `api_key` providers.
+            The provider's OAuth token endpoint. Required for OAuth and
+            `client_credentials` providers; omit for `api_key` providers. Must
+            be a static URL: `${config.…}` placeholders are resolved against a
+            provider's declared config fields, which custom providers cannot
+            declare.
           example: https://provider.example.com/oauth/token
         refresh_token_url:
           type:
@@ -22483,7 +22488,7 @@ components:
           format: uri
           description: >-
             The endpoint used to refresh tokens, if different from the token
-            endpoint.
+            endpoint. Must be a static URL, like the other endpoints.
           example: https://provider.example.com/oauth/token
         pkce_enabled:
           type: boolean
@@ -22623,12 +22628,18 @@ components:
         authorization_url:
           type: string
           format: uri
-          description: The provider's OAuth authorization endpoint.
+          description: >-
+            The provider's OAuth authorization endpoint. Must be a static URL:
+            `${config.…}` placeholders are resolved against a provider's
+            declared config fields, which custom providers cannot declare.
           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. Must be a static URL:
+            `${config.…}` placeholders are resolved against a provider's
+            declared config fields, which custom providers cannot declare.
           example: https://provider.example.com/oauth/token
         refresh_token_url:
           type:
@@ -22637,7 +22648,7 @@ components:
           format: uri
           description: >-
             The endpoint used to refresh tokens, if different from the token
-            endpoint.
+            endpoint. Must be a static URL, like the other endpoints.
           example: https://provider.example.com/oauth/token
         pkce_enabled:
           type: boolean
@@ -35060,6 +35071,190 @@ components:
                 - data
                 - created_at
                 - object
+            - type: object
+              properties:
+                id:
+                  type: string
+                  description: Unique identifier for the event.
+                  example: event_01EHZNVPK3SFK441A1RGBFSHRT
+                event:
+                  type: string
+                  const: resource_export.completed
+                data:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      description: The ID of the resource export.
+                      example: resource_export_01HWZBQZY2M3AMQW166Q22K88F
+                    resource_type:
+                      type: string
+                      enum:
+                        - users
+                        - organizations
+                        - events
+                        - sessions
+                      description: The type of resource being exported.
+                      example: users
+                  required:
+                    - id
+                    - resource_type
+                  description: The event payload.
+                created_at:
+                  format: date-time
+                  type: string
+                  description: An ISO 8601 timestamp.
+                  example: '2026-01-15T12:00:00.000Z'
+                context:
+                  $ref: '#/components/schemas/EventContextDto'
+                object:
+                  type: string
+                  description: Distinguishes the Event object.
+                  const: event
+              required:
+                - id
+                - event
+                - data
+                - created_at
+                - object
+            - type: object
+              properties:
+                id:
+                  type: string
+                  description: Unique identifier for the event.
+                  example: event_01EHZNVPK3SFK441A1RGBFSHRT
+                event:
+                  type: string
+                  const: resource_export.created
+                data:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      description: The ID of the resource export.
+                      example: resource_export_01HWZBQZY2M3AMQW166Q22K88F
+                    resource_type:
+                      type: string
+                      enum:
+                        - users
+                        - organizations
+                        - events
+                        - sessions
+                      description: The type of resource being exported.
+                      example: users
+                  required:
+                    - id
+                    - resource_type
+                  description: The event payload.
+                created_at:
+                  format: date-time
+                  type: string
+                  description: An ISO 8601 timestamp.
+                  example: '2026-01-15T12:00:00.000Z'
+                context:
+                  $ref: '#/components/schemas/EventContextDto'
+                object:
+                  type: string
+                  description: Distinguishes the Event object.
+                  const: event
+              required:
+                - id
+                - event
+                - data
+                - created_at
+                - object
+            - type: object
+              properties:
+                id:
+                  type: string
+                  description: Unique identifier for the event.
+                  example: event_01EHZNVPK3SFK441A1RGBFSHRT
+                event:
+                  type: string
+                  const: resource_export.downloaded
+                data:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      description: The ID of the resource export.
+                      example: resource_export_01HWZBQZY2M3AMQW166Q22K88F
+                    resource_type:
+                      type: string
+                      enum:
+                        - users
+                        - organizations
+                        - events
+                        - sessions
+                      description: The type of resource being exported.
+                      example: users
+                  required:
+                    - id
+                    - resource_type
+                  description: The event payload.
+                created_at:
+                  format: date-time
+                  type: string
+                  description: An ISO 8601 timestamp.
+                  example: '2026-01-15T12:00:00.000Z'
+                context:
+                  $ref: '#/components/schemas/EventContextDto'
+                object:
+                  type: string
+                  description: Distinguishes the Event object.
+                  const: event
+              required:
+                - id
+                - event
+                - data
+                - created_at
+                - object
+            - type: object
+              properties:
+                id:
+                  type: string
+                  description: Unique identifier for the event.
+                  example: event_01EHZNVPK3SFK441A1RGBFSHRT
+                event:
+                  type: string
+                  const: resource_export.failed
+                data:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      description: The ID of the resource export.
+                      example: resource_export_01HWZBQZY2M3AMQW166Q22K88F
+                    resource_type:
+                      type: string
+                      enum:
+                        - users
+                        - organizations
+                        - events
+                        - sessions
+                      description: The type of resource being exported.
+                      example: users
+                  required:
+                    - id
+                    - resource_type
+                  description: The event payload.
+                created_at:
+                  format: date-time
+                  type: string
+                  description: An ISO 8601 timestamp.
+                  example: '2026-01-15T12:00:00.000Z'
+                context:
+                  $ref: '#/components/schemas/EventContextDto'
+                object:
+                  type: string
+                  description: Distinguishes the Event object.
+                  const: event
+              required:
+                - id
+                - event
+                - data
+                - created_at
+                - object
             - type: object
               properties:
                 id:
@@ -37388,7 +37583,9 @@ components:
           type: string
           description: >-
             The OAuth redirect URI to register with the provider when
-            configuring the custom application.
+            configuring the custom application. Empty for `api_key` and
+            `client_credentials` integrations, which run no authorization
+            redirect.
           example: >-
             https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback
         auth_methods:
@@ -37407,8 +37604,8 @@ components:
         credentials:
           description: >-
             The integration-level OAuth app credentials. `null` for `api_key`
-            integrations, which hold no OAuth credentials (keys are installed
-            per-tenant).
+            and `client_credentials` integrations, which hold no
+            integration-level credentials (secrets are installed per-tenant).
           oneOf:
             - type: object
               properties: