@workos/openapi-spec 0.81.0 → 0.83.0

package/dist/open-api-spec.yaml

@@ -10984,6 +10984,14 @@ paths:
                     Optional parameter to scope the connection to a specific
                     organization.
                   example: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connected_account_id:
+                  type: string
+                  minLength: 1
+                  description: >-
+                    A [connected account](/reference/pipes/connected-account)
+                    identifier. Use this to select a specific connection when
+                    the user has several for this provider.
+                  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
               required:
                 - user_id
       responses:
@@ -11020,7 +11028,7 @@ paths:
         '401':
           description: Unauthorized
         '404':
-          description: Data integration not found for the given provider slug.
+          description: The data integration or selected connected account was not found.
           content:
             application/json:
               schema:
@@ -11098,6 +11106,14 @@ paths:
                     Optional parameter to scope the connection to a specific
                     organization.
                   example: org_01EHZNVPK3SFK441A1RGBFSHRT
+                connected_account_id:
+                  type: string
+                  minLength: 1
+                  description: >-
+                    A [connected account](/reference/pipes/connected-account)
+                    identifier. Use this to select a specific connection when
+                    the user has several for this provider.
+                  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
               required:
                 - user_id
       responses:
@@ -11123,7 +11139,7 @@ paths:
         '401':
           description: Unauthorized
         '404':
-          description: Data integration not found for the given provider slug.
+          description: The data integration or selected connected account was not found.
           content:
             application/json:
               schema:
@@ -22156,6 +22172,17 @@ paths:
           schema:
             example: org_01EHZNVPK3SFK441A1RGBFSHRT
             type: string
+        - name: connected_account_id
+          required: false
+          in: query
+          description: >-
+            A [connected account](/reference/pipes/connected-account)
+            identifier. Use this to select a specific connection when the user
+            has several for this provider.
+          schema:
+            minLength: 1
+            example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+            type: string
       responses:
         '200':
           description: The connected account was retrieved successfully.
@@ -22163,6 +22190,19 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ConnectedAccount'
+        '400':
+          description: The connected account selector is malformed.
+          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
         '401':
           description: The request is missing a valid API key.
         '404':
@@ -22228,9 +22268,32 @@ paths:
           schema:
             example: org_01EHZNVPK3SFK441A1RGBFSHRT
             type: string
+        - name: connected_account_id
+          required: false
+          in: query
+          description: >-
+            A [connected account](/reference/pipes/connected-account)
+            identifier. Use this to select the connection to delete.
+          schema:
+            minLength: 1
+            example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+            type: string
       responses:
         '204':
           description: The connected account was deleted successfully.
+        '400':
+          description: The connected account selector is malformed.
+          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
         '401':
           description: The request is missing a valid API key.
         '404':
@@ -22389,6 +22452,16 @@ paths:
           schema:
             example: org_01EHZNVPK3SFK441A1RGBFSHRT
             type: string
+        - name: connected_account_id
+          required: false
+          in: query
+          description: >-
+            A [connected account](/reference/pipes/connected-account)
+            identifier. Use this to select the connection to update.
+          schema:
+            minLength: 1
+            example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+            type: string
       requestBody:
         required: true
         content:
@@ -22402,6 +22475,19 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ConnectedAccount'
+        '400':
+          description: The connected account selector is malformed.
+          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
         '401':
           description: The request is missing a valid API key.
         '404':
@@ -43143,7 +43229,7 @@ components:
                         items:
                           type: string
                         description: The OAuth scopes granted for this connection.
-                        example:
+                        example: &ref_34
                           - repo
                           - user:email
                       auth_method:
@@ -43193,7 +43279,7 @@ components:
                           `installation` scope, excluding any it declares as
                           secret. Only present when `auth_method` is
                           `client_credentials`.
-                        example:
+                        example: &ref_35
                           instance_url: https://example.my.salesforce.com
                       state:
                         type: string
@@ -43256,6 +43342,151 @@ components:
                       - createdAt
                       - updatedAt
                   - type: 'null'
+              connected_accounts:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    object:
+                      type: string
+                      description: Distinguishes the connected account object.
+                      const: connected_account
+                    id:
+                      type: string
+                      description: The unique identifier of the connected account.
+                      example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                    user_id:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        The [User](/reference/authkit/user) identifier
+                        associated with this connection.
+                      example: user_01EHZNVPK3SFK441A1RGBFSHRT
+                    organization_id:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        The [Organization](/reference/organization) identifier
+                        associated with this connection, or `null` if not scoped
+                        to an organization.
+                      example: null
+                    scopes:
+                      type: array
+                      items:
+                        type: string
+                      description: The OAuth scopes granted for this connection.
+                      example: *ref_34
+                    auth_method:
+                      type: string
+                      enum:
+                        - oauth
+                        - api_key
+                        - client_credentials
+                      description: >-
+                        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:
+                        - string
+                        - 'null'
+                      description: >-
+                        The last four characters of the API key, or `null` for
+                        OAuth connections.
+                      example: null
+                    client_id:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        The client ID supplied for this connection. Only present
+                        when `auth_method` is `client_credentials`.
+                      example: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
+                    client_secret_last_4:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        The last four characters of the client secret supplied
+                        for this connection, or `null` when it can't be read.
+                        Only present when `auth_method` is `client_credentials`.
+                      example: cdef
+                    config:
+                      type: object
+                      additionalProperties:
+                        type: string
+                      description: >-
+                        The connection-level configuration values stored for
+                        this connection — the fields the provider declares at
+                        `installation` scope, excluding any it declares as
+                        secret. Only present when `auth_method` is
+                        `client_credentials`.
+                      example: *ref_35
+                    state:
+                      type: string
+                      enum:
+                        - connected
+                        - needs_reauthorization
+                        - disconnected
+                      description: >-
+                        The state of the connected account:
+
+                        - `connected`: The connection is active and tokens are
+                        valid.
+
+                        - `needs_reauthorization`: The user needs to reauthorize
+                        the connection, typically because required scopes have
+                        changed.
+
+                        - `disconnected`: The connection has been disconnected.
+                      example: connected
+                    created_at:
+                      type: string
+                      description: The timestamp when the connection was created.
+                      example: '2024-01-16T14:20:00.000Z'
+                    updated_at:
+                      type: string
+                      description: The timestamp when the connection was last updated.
+                      example: '2024-01-16T14:20:00.000Z'
+                    userlandUserId:
+                      type:
+                        - string
+                        - 'null'
+                      deprecated: true
+                      description: Use `user_id` instead.
+                    organizationId:
+                      type:
+                        - string
+                        - 'null'
+                      deprecated: true
+                      description: Use `organization_id` instead.
+                    createdAt:
+                      type: string
+                      deprecated: true
+                      description: Use `created_at` instead.
+                    updatedAt:
+                      type: string
+                      deprecated: true
+                      description: Use `updated_at` instead.
+                  required:
+                    - object
+                    - id
+                    - user_id
+                    - organization_id
+                    - scopes
+                    - state
+                    - created_at
+                    - updated_at
+                    - userlandUserId
+                    - organizationId
+                    - createdAt
+                    - updatedAt
+                description: >-
+                  The user's connected accounts for this provider in the
+                  requested ownership context.
             required:
               - object
               - id
@@ -43273,10 +43504,11 @@ components:
               - createdAt
               - updatedAt
               - connected_account
+              - connected_accounts
           description: >-
-            A list of [providers](/reference/pipes/provider), each including a
-            [`connected_account`](/reference/pipes/connected-account) field with
-            the user's connection status.
+            A list of [providers](/reference/pipes/provider), each including the
+            legacy `connected_account` field and the additive
+            `connected_accounts` collection.
       required:
         - object
         - data

package/dist/types.d.ts

@@ -17797,7 +17797,7 @@ export interface components {
              * @constant
              */
             object: "list";
-            /** @description A list of [providers](/reference/pipes/provider), each including a [`connected_account`](/reference/pipes/connected-account) field with the user's connection status. */
+            /** @description A list of [providers](/reference/pipes/provider), each including the legacy `connected_account` field and the additive `connected_accounts` collection. */
             data: {
                 /**
                  * @description Distinguishes the data provider object.
@@ -17984,6 +17984,106 @@ export interface components {
                      */
                     updatedAt: string;
                 } | null;
+                /** @description The user's connected accounts for this provider in the requested ownership context. */
+                connected_accounts: {
+                    /**
+                     * @description Distinguishes the connected account object.
+                     * @constant
+                     */
+                    object: "connected_account";
+                    /**
+                     * @description The unique identifier of the connected account.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    id: string;
+                    /**
+                     * @description The [User](/reference/authkit/user) identifier associated with this connection.
+                     * @example user_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    user_id: string | null;
+                    /**
+                     * @description The [Organization](/reference/organization) identifier associated with this connection, or `null` if not scoped to an organization.
+                     * @example null
+                     */
+                    organization_id: string | null;
+                    /**
+                     * @description The OAuth scopes granted for this connection.
+                     * @example [
+                     *       "repo",
+                     *       "user:email"
+                     *     ]
+                     */
+                    scopes: string[];
+                    /**
+                     * @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" | "client_credentials";
+                    /**
+                     * @description The last four characters of the API key, or `null` for OAuth connections.
+                     * @example null
+                     */
+                    api_key_last_4?: string | null;
+                    /**
+                     * @description The client ID supplied for this connection. Only present when `auth_method` is `client_credentials`.
+                     * @example 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
+                     */
+                    client_id?: string | null;
+                    /**
+                     * @description The last four characters of the client secret supplied for this connection, or `null` when it can't be read. Only present when `auth_method` is `client_credentials`.
+                     * @example cdef
+                     */
+                    client_secret_last_4?: string | null;
+                    /**
+                     * @description The connection-level configuration values stored for this connection — the fields the provider declares at `installation` scope, excluding any it declares as secret. Only present when `auth_method` is `client_credentials`.
+                     * @example {
+                     *       "instance_url": "https://example.my.salesforce.com"
+                     *     }
+                     */
+                    config?: {
+                        [key: string]: string;
+                    };
+                    /**
+                     * @description The state of the connected account:
+                     *     - `connected`: The connection is active and tokens are valid.
+                     *     - `needs_reauthorization`: The user needs to reauthorize the connection, typically because required scopes have changed.
+                     *     - `disconnected`: The connection has been disconnected.
+                     * @example connected
+                     * @enum {string}
+                     */
+                    state: "connected" | "needs_reauthorization" | "disconnected";
+                    /**
+                     * @description The timestamp when the connection was created.
+                     * @example 2024-01-16T14:20:00.000Z
+                     */
+                    created_at: string;
+                    /**
+                     * @description The timestamp when the connection was last updated.
+                     * @example 2024-01-16T14:20:00.000Z
+                     */
+                    updated_at: string;
+                    /**
+                     * @deprecated
+                     * @description Use `user_id` instead.
+                     */
+                    userlandUserId: string | null;
+                    /**
+                     * @deprecated
+                     * @description Use `organization_id` instead.
+                     */
+                    organizationId: string | null;
+                    /**
+                     * @deprecated
+                     * @description Use `created_at` instead.
+                     */
+                    createdAt: string;
+                    /**
+                     * @deprecated
+                     * @description Use `updated_at` instead.
+                     */
+                    updatedAt: string;
+                }[];
             }[];
         };
         PortalLinkResponse: {
@@ -29098,6 +29198,11 @@ export interface operations {
                      * @example org_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     organization_id?: string;
+                    /**
+                     * @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the user has several for this provider.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    connected_account_id?: string;
                 };
             };
         };
@@ -29149,7 +29254,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Data integration not found for the given provider slug. */
+            /** @description The data integration or selected connected account was not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -29219,6 +29324,11 @@ export interface operations {
                      * @example org_01EHZNVPK3SFK441A1RGBFSHRT
                      */
                     organization_id?: string;
+                    /**
+                     * @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the user has several for this provider.
+                     * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
+                     */
+                    connected_account_id?: string;
                 };
             };
         };
@@ -29254,7 +29364,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Data integration not found for the given provider slug. */
+            /** @description The data integration or selected connected account was not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -38745,6 +38855,8 @@ export interface operations {
             query?: {
                 /** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
                 organization_id?: string;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the user has several for this provider. */
+                connected_account_id?: string;
             };
             header?: never;
             path: {
@@ -38766,6 +38878,21 @@ export interface operations {
                     "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: {
@@ -38810,6 +38937,8 @@ export interface operations {
             query?: {
                 /** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
                 organization_id?: string;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to update. */
+                connected_account_id?: string;
             };
             header?: never;
             path: {
@@ -38835,6 +38964,21 @@ export interface operations {
                     "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: {
@@ -38963,6 +39107,8 @@ export interface operations {
             query?: {
                 /** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
                 organization_id?: string;
+                /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to delete. */
+                connected_account_id?: string;
             };
             header?: never;
             path: {
@@ -38982,6 +39128,21 @@ export interface operations {
                 };
                 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: {

package/package.json

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