@workos/openapi-spec 0.95.0 → 0.97.0

package/dist/open-api-spec.yaml

@@ -2997,6 +2997,40 @@ paths:
                     example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
                 required:
                   - message
+        '429':
+          description: ''
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - type: object
+                    properties:
+                      code:
+                        type: string
+                        description: The error code identifying the type of error.
+                        example: sms_challenge_rate_limited
+                        const: sms_challenge_rate_limited
+                      message:
+                        type: string
+                        description: A human-readable description of the error.
+                        example: Request could not be processed.
+                    required:
+                      - code
+                      - message
+                  - type: object
+                    properties:
+                      code:
+                        type: string
+                        description: The error code identifying the type of error.
+                        example: sms_challenge_quota_reached
+                        const: sms_challenge_quota_reached
+                      message:
+                        type: string
+                        description: A human-readable description of the error.
+                        example: Request could not be processed.
+                    required:
+                      - code
+                      - message
       summary: Challenge Factor
       tags:
         - multi-factor-auth
@@ -10712,6 +10746,9 @@ paths:
               example:
                 object: connected_account
                 id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                connection_role: compatibility
+                account_identifier: null
+                account_display_name: null
                 user_id: user_01EHZNVPK3SFK441A1RGBFSHRT
                 organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
                 scopes: []
@@ -10991,6 +11028,9 @@ paths:
               example:
                 object: connected_account
                 id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                connection_role: compatibility
+                account_identifier: null
+                account_display_name: null
                 user_id: user_01EHZNVPK3SFK441A1RGBFSHRT
                 organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
                 scopes: []
@@ -14762,6 +14802,9 @@ paths:
                 id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
                 user_id: null
                 organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connection_role: compatibility
+                account_identifier: acme-workspace
+                account_display_name: Acme production
                 scopes:
                   - repo
                   - user:email
@@ -14965,6 +15008,9 @@ paths:
                 id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
                 user_id: null
                 organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connection_role: compatibility
+                account_identifier: acme-workspace
+                account_display_name: Acme production
                 scopes:
                   - repo
                   - user:email
@@ -15135,6 +15181,9 @@ paths:
                 id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
                 user_id: null
                 organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connection_role: compatibility
+                account_identifier: acme-workspace
+                account_display_name: Acme production
                 scopes:
                   - repo
                   - user:email
@@ -15287,6 +15336,9 @@ paths:
                       id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
                       user_id: null
                       organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
+                      connection_role: compatibility
+                      account_identifier: acme-workspace
+                      account_display_name: Acme production
                       scopes:
                         - repo
                         - user:email
@@ -32963,6 +33015,33 @@ components:
           type: string
           description: The unique ID of the connected account.
           example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+        connection_role:
+          type: string
+          enum:
+            - compatibility
+            - standard
+          description: >-
+            Whether this is the compatibility connection visible to undeclared
+            clients or a standard connection for plural-aware clients.
+            Historical events may omit this field.
+          example: compatibility
+        account_identifier:
+          type:
+            - string
+            - 'null'
+          description: >-
+            A best-effort identifier for the provider account this connection
+            points at. It is not the connection identifier or a selector.
+            Historical events may omit this field.
+          example: workspace_123
+        account_display_name:
+          type:
+            - string
+            - 'null'
+          description: >-
+            A mutable, non-unique display name for the provider account
+            connection. Historical events may omit this field.
+          example: Acme production
         data_integration_id:
           type: string
           description: The unique ID of the data integration.
@@ -32991,6 +33070,24 @@ components:
           example:
             - repo
             - user:email
+        auth_method:
+          type: string
+          enum:
+            - oauth
+            - api_key
+            - client_credentials
+          description: >-
+            How the connection authenticates. Historical events may omit this
+            field.
+          example: oauth
+        api_key_last_4:
+          type:
+            - string
+            - 'null'
+          description: >-
+            The last four characters of the API key, or null for other
+            authentication methods. Historical events may omit this field.
+          example: null
         state:
           type: string
           enum:
@@ -41220,6 +41317,16 @@ components:
                         The ID of the Organization the connection attempt
                         belongs to.
                       example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
+                    account_identifier:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        A best-effort identifier for the provider account
+                        involved in the attempt. It is not a connection
+                        identifier or selector. Historical events may omit this
+                        field.
+                      example: null
                     error_code:
                       type: string
                       description: A machine-readable error code for the failure.
@@ -41347,6 +41454,16 @@ components:
                         The ID of the Organization the connection attempt
                         belongs to.
                       example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
+                    account_identifier:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        A best-effort identifier for the provider account
+                        involved in the attempt. It is not a connection
+                        identifier or selector. Historical events may omit this
+                        field.
+                      example: null
                     error_code:
                       type: string
                       description: A machine-readable error code for the failure.
@@ -41532,6 +41649,16 @@ components:
                         The ID of the Organization the connection attempt
                         belongs to.
                       example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
+                    account_identifier:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        A best-effort identifier for the provider account
+                        involved in the attempt. It is not a connection
+                        identifier or selector. Historical events may omit this
+                        field.
+                      example: null
                     error_code:
                       type: string
                       description: A machine-readable error code for the failure.
@@ -44308,6 +44435,30 @@ components:
                   type: string
                   description: Unique identifier of the installation.
                   example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                connection_role:
+                  type: string
+                  enum:
+                    - compatibility
+                    - standard
+                  description: >-
+                    Whether this is the compatibility connection visible to
+                    undeclared clients or a standard connection for plural-aware
+                    clients.
+                  example: compatibility
+                account_identifier:
+                  type:
+                    - string
+                    - 'null'
+                  description: >-
+                    A best-effort provider account identifier used for
+                    correlation, not connection selection.
+                  example: workspace_123
+                account_display_name:
+                  type:
+                    - string
+                    - 'null'
+                  description: A mutable, non-unique display name for this connection.
+                  example: Acme production
                 user_id:
                   type:
                     - string
@@ -44336,6 +44487,9 @@ components:
                   example: cdef
               required:
                 - id
+                - connection_role
+                - account_identifier
+                - account_display_name
                 - user_id
                 - organization_id
                 - api_key_last_4
@@ -44847,6 +45001,33 @@ components:
           type: string
           description: The unique identifier of the connected account.
           example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+        connection_role:
+          type: string
+          enum:
+            - compatibility
+            - standard
+          description: >-
+            Whether this row is the compatibility connection visible to
+            undeclared clients or a standard peer for plural-aware clients. The
+            role does not indicate preference or creation order.
+          example: compatibility
+        account_identifier:
+          type:
+            - string
+            - 'null'
+          description: >-
+            A best-effort identifier for the provider account this connection
+            points at. It is correlation metadata, not the connection identifier
+            or a selector.
+          example: workspace_123
+        account_display_name:
+          type:
+            - string
+            - 'null'
+          description: >-
+            A mutable, non-unique display name for the provider account
+            connection.
+          example: Acme production
         user_id:
           type:
             - string
@@ -44944,6 +45125,9 @@ components:
       required:
         - object
         - id
+        - connection_role
+        - account_identifier
+        - account_display_name
         - user_id
         - organization_id
         - scopes
@@ -45069,6 +45253,34 @@ components:
                         type: string
                         description: The unique identifier of the connected account.
                         example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                      connection_role:
+                        type: string
+                        enum:
+                          - compatibility
+                          - standard
+                        description: >-
+                          Whether this row is the compatibility connection
+                          visible to undeclared clients or a standard peer for
+                          plural-aware clients. The role does not indicate
+                          preference or creation order.
+                        example: compatibility
+                      account_identifier:
+                        type:
+                          - string
+                          - 'null'
+                        description: >-
+                          A best-effort identifier for the provider account this
+                          connection points at. It is correlation metadata, not
+                          the connection identifier or a selector.
+                        example: workspace_123
+                      account_display_name:
+                        type:
+                          - string
+                          - 'null'
+                        description: >-
+                          A mutable, non-unique display name for the provider
+                          account connection.
+                        example: Acme production
                       user_id:
                         type:
                           - string
@@ -45193,6 +45405,9 @@ components:
                     required:
                       - object
                       - id
+                      - connection_role
+                      - account_identifier
+                      - account_display_name
                       - user_id
                       - organization_id
                       - scopes
@@ -45217,6 +45432,34 @@ components:
                       type: string
                       description: The unique identifier of the connected account.
                       example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                    connection_role:
+                      type: string
+                      enum:
+                        - compatibility
+                        - standard
+                      description: >-
+                        Whether this row is the compatibility connection visible
+                        to undeclared clients or a standard peer for
+                        plural-aware clients. The role does not indicate
+                        preference or creation order.
+                      example: compatibility
+                    account_identifier:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        A best-effort identifier for the provider account this
+                        connection points at. It is correlation metadata, not
+                        the connection identifier or a selector.
+                      example: workspace_123
+                    account_display_name:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        A mutable, non-unique display name for the provider
+                        account connection.
+                      example: Acme production
                     user_id:
                       type:
                         - string
@@ -45336,6 +45579,9 @@ components:
                   required:
                     - object
                     - id
+                    - connection_role
+                    - account_identifier
+                    - account_display_name
                     - user_id
                     - organization_id
                     - scopes

package/dist/types.d.ts

@@ -8960,6 +8960,22 @@ export interface components {
              * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
              */
             id: string;
+            /**
+             * @description Whether this is the compatibility connection visible to undeclared clients or a standard connection for plural-aware clients. Historical events may omit this field.
+             * @example compatibility
+             * @enum {string}
+             */
+            connection_role?: "compatibility" | "standard";
+            /**
+             * @description A best-effort identifier for the provider account this connection points at. It is not the connection identifier or a selector. Historical events may omit this field.
+             * @example workspace_123
+             */
+            account_identifier?: string | null;
+            /**
+             * @description A mutable, non-unique display name for the provider account connection. Historical events may omit this field.
+             * @example Acme production
+             */
+            account_display_name?: string | null;
             /**
              * @description The unique ID of the data integration.
              * @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
@@ -8988,6 +9004,17 @@ export interface components {
              *     ]
              */
             scopes: string[];
+            /**
+             * @description How the connection authenticates. Historical events may omit this field.
+             * @example oauth
+             * @enum {string}
+             */
+            auth_method?: "oauth" | "api_key" | "client_credentials";
+            /**
+             * @description The last four characters of the API key, or null for other authentication methods. Historical events may omit this field.
+             * @example null
+             */
+            api_key_last_4?: string | null;
             /**
              * @description The state of the connected account.
              * @example connected
@@ -15404,6 +15431,11 @@ export interface components {
                  * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
                  */
                 organization_id: string | null;
+                /**
+                 * @description A best-effort identifier for the provider account involved in the attempt. It is not a connection identifier or selector. Historical events may omit this field.
+                 * @example null
+                 */
+                account_identifier?: string | null;
                 /**
                  * @description A machine-readable error code for the failure.
                  * @example authorization_code_exchange_error
@@ -15504,6 +15536,11 @@ export interface components {
                  * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
                  */
                 organization_id: string | null;
+                /**
+                 * @description A best-effort identifier for the provider account involved in the attempt. It is not a connection identifier or selector. Historical events may omit this field.
+                 * @example null
+                 */
+                account_identifier?: string | null;
                 /**
                  * @description A machine-readable error code for the failure.
                  * @example authorization_code_exchange_error
@@ -15648,6 +15685,11 @@ export interface components {
                  * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
                  */
                 organization_id: string | null;
+                /**
+                 * @description A best-effort identifier for the provider account involved in the attempt. It is not a connection identifier or selector. Historical events may omit this field.
+                 * @example null
+                 */
+                account_identifier?: string | null;
                 /**
                  * @description A machine-readable error code for the failure.
                  * @example authorization_code_exchange_error
@@ -17771,6 +17813,22 @@ export interface components {
                  * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
                  */
                 id: string;
+                /**
+                 * @description Whether this is the compatibility connection visible to undeclared clients or a standard connection for plural-aware clients.
+                 * @example compatibility
+                 * @enum {string}
+                 */
+                connection_role: "compatibility" | "standard";
+                /**
+                 * @description A best-effort provider account identifier used for correlation, not connection selection.
+                 * @example workspace_123
+                 */
+                account_identifier: string | null;
+                /**
+                 * @description A mutable, non-unique display name for this connection.
+                 * @example Acme production
+                 */
+                account_display_name: string | null;
                 /**
                  * @description The User the API key was installed for. Null on an `organization`-owned integration, whose installations belong to the organization.
                  * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -18123,6 +18181,22 @@ export interface components {
              * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
              */
             id: string;
+            /**
+             * @description Whether this row is the compatibility connection visible to undeclared clients or a standard peer for plural-aware clients. The role does not indicate preference or creation order.
+             * @example compatibility
+             * @enum {string}
+             */
+            connection_role: "compatibility" | "standard";
+            /**
+             * @description A best-effort identifier for the provider account this connection points at. It is correlation metadata, not the connection identifier or a selector.
+             * @example workspace_123
+             */
+            account_identifier: string | null;
+            /**
+             * @description A mutable, non-unique display name for the provider account connection.
+             * @example Acme production
+             */
+            account_display_name: string | null;
             /**
              * @description The [User](/reference/authkit/user) identifier associated with this connection.
              * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -18296,6 +18370,22 @@ export interface components {
                      * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     id: string;
+                    /**
+                     * @description Whether this row is the compatibility connection visible to undeclared clients or a standard peer for plural-aware clients. The role does not indicate preference or creation order.
+                     * @example compatibility
+                     * @enum {string}
+                     */
+                    connection_role: "compatibility" | "standard";
+                    /**
+                     * @description A best-effort identifier for the provider account this connection points at. It is correlation metadata, not the connection identifier or a selector.
+                     * @example workspace_123
+                     */
+                    account_identifier: string | null;
+                    /**
+                     * @description A mutable, non-unique display name for the provider account connection.
+                     * @example Acme production
+                     */
+                    account_display_name: string | null;
                     /**
                      * @description The [User](/reference/authkit/user) identifier associated with this connection.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -18396,6 +18486,22 @@ export interface components {
                      * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     id: string;
+                    /**
+                     * @description Whether this row is the compatibility connection visible to undeclared clients or a standard peer for plural-aware clients. The role does not indicate preference or creation order.
+                     * @example compatibility
+                     * @enum {string}
+                     */
+                    connection_role: "compatibility" | "standard";
+                    /**
+                     * @description A best-effort identifier for the provider account this connection points at. It is correlation metadata, not the connection identifier or a selector.
+                     * @example workspace_123
+                     */
+                    account_identifier: string | null;
+                    /**
+                     * @description A mutable, non-unique display name for the provider account connection.
+                     * @example Acme production
+                     */
+                    account_display_name: string | null;
                     /**
                      * @description The [User](/reference/authkit/user) identifier associated with this connection.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -22444,6 +22550,38 @@ export interface operations {
                     };
                 };
             };
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example sms_challenge_rate_limited
+                         * @constant
+                         */
+                        code: "sms_challenge_rate_limited";
+                        /**
+                         * @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 sms_challenge_quota_reached
+                         * @constant
+                         */
+                        code: "sms_challenge_quota_reached";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    };
+                };
+            };
         };
     };
     ExternalAuthController_completeLogin: {
@@ -29324,6 +29462,9 @@ export interface operations {
                      * @example {
                      *       "object": "connected_account",
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "connection_role": "compatibility",
+                     *       "account_identifier": null,
+                     *       "account_display_name": null,
                      *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "scopes": [],
@@ -29587,6 +29728,9 @@ export interface operations {
                      * @example {
                      *       "object": "connected_account",
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "connection_role": "compatibility",
+                     *       "account_identifier": null,
+                     *       "account_display_name": null,
                      *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "scopes": [],
@@ -32990,6 +33134,9 @@ export interface operations {
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "user_id": null,
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "connection_role": "compatibility",
+                     *       "account_identifier": "acme-workspace",
+                     *       "account_display_name": "Acme production",
                      *       "scopes": [
                      *         "repo",
                      *         "user:email"
@@ -33092,6 +33239,9 @@ export interface operations {
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "user_id": null,
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "connection_role": "compatibility",
+                     *       "account_identifier": "acme-workspace",
+                     *       "account_display_name": "Acme production",
                      *       "scopes": [
                      *         "repo",
                      *         "user:email"
@@ -33223,6 +33373,9 @@ export interface operations {
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "user_id": null,
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *       "connection_role": "compatibility",
+                     *       "account_identifier": "acme-workspace",
+                     *       "account_display_name": "Acme production",
                      *       "scopes": [
                      *         "repo",
                      *         "user:email"
@@ -33474,6 +33627,9 @@ export interface operations {
                      *             "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *             "user_id": null,
                      *             "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *             "connection_role": "compatibility",
+                     *             "account_identifier": "acme-workspace",
+                     *             "account_display_name": "Acme production",
                      *             "scopes": [
                      *               "repo",
                      *               "user:email"
@@ -33499,6 +33655,9 @@ export interface operations {
                      *               "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *               "user_id": null,
                      *               "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
+                     *               "connection_role": "compatibility",
+                     *               "account_identifier": "acme-workspace",
+                     *               "account_display_name": "Acme production",
                      *               "scopes": [
                      *                 "repo",
                      *                 "user:email"

package/package.json

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