@workos/openapi-spec 0.120.0 → 0.122.0

package/dist/types.d.ts

@@ -5558,6 +5558,16 @@ export interface components {
             custom_provider?: components["schemas"]["UpdateCustomProviderDefinitionDto"];
         };
         CreateOrganizationConnectedAccountDto: {
+            /**
+             * @description A mutable, non-unique connection label; null clears it. Not an account identifier.
+             * @example Acme production
+             */
+            account_display_name?: string | null;
+            /**
+             * @description A developer-attested account identifier; null clears it.
+             * @example workspace_123
+             */
+            account_identifier?: string | null;
             /**
              * @description The OAuth access token for the connected account.
              * @example gho_16C7e42F292c6912E7710c838347Ae178B4a
@@ -5601,6 +5611,16 @@ export interface components {
             connection_intent?: "add";
         };
         OrganizationConnectedAccountDto: {
+            /**
+             * @description A mutable, non-unique connection label; null clears it. Not an account identifier.
+             * @example Acme production
+             */
+            account_display_name?: string | null;
+            /**
+             * @description A developer-attested account identifier; null clears it.
+             * @example workspace_123
+             */
+            account_identifier?: string | null;
             /**
              * @description The OAuth access token for the connected account.
              * @example gho_16C7e42F292c6912E7710c838347Ae178B4a
@@ -5638,6 +5658,16 @@ export interface components {
             user_id: string;
         };
         CreateConnectedAccountDto: {
+            /**
+             * @description A mutable, non-unique connection label; null clears it. Not an account identifier.
+             * @example Acme production
+             */
+            account_display_name?: string | null;
+            /**
+             * @description A developer-attested account identifier; null clears it.
+             * @example workspace_123
+             */
+            account_identifier?: string | null;
             /**
              * @description The OAuth access token for the connected account.
              * @example gho_16C7e42F292c6912E7710c838347Ae178B4a
@@ -5676,6 +5706,16 @@ export interface components {
             connection_intent?: "add";
         };
         ConnectedAccountDto: {
+            /**
+             * @description A mutable, non-unique connection label; null clears it. Not an account identifier.
+             * @example Acme production
+             */
+            account_display_name?: string | null;
+            /**
+             * @description A developer-attested account identifier; null clears it.
+             * @example workspace_123
+             */
+            account_identifier?: string | null;
             /**
              * @description The OAuth access token for the connected account.
              * @example gho_16C7e42F292c6912E7710c838347Ae178B4a
@@ -18448,7 +18488,7 @@ export interface components {
              */
             error: "not_installed" | "needs_reauthorization";
         };
-        ConnectedAccount: {
+        ConnectedAccountWriteResponse: {
             /**
              * @description Distinguishes the connected account object.
              * @constant
@@ -18542,6 +18582,16 @@ export interface components {
              * @example 2024-01-16T14:20:00.000Z
              */
             updated_at: string;
+            /** @description Non-blocking warnings about an explicitly supplied label, omitted when no duplicate exists. Reads do not include this field. */
+            warnings?: {
+                /** @constant */
+                code: "duplicate_account_display_name";
+                /**
+                 * @description A human-readable explanation of the non-blocking warning.
+                 * @example Another connection for this provider and owner has the same label.
+                 */
+                message: string;
+            }[];
         };
         DataIntegrationsListResponse: {
             /**
@@ -18877,6 +18927,101 @@ export interface components {
                 }[];
             }[];
         };
+        ConnectedAccount: {
+            /**
+             * @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 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
+             */
+            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 secret and undeclared fields. Returned for every authentication method; empty when no stored values can be disclosed.
+             * @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;
+        };
         PortalLinkResponse: {
             /**
              * Format: password
@@ -29802,6 +29947,16 @@ export interface operations {
         requestBody: {
             content: {
                 "application/json": {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
+                    /**
+                     * @description A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
+                     * @example workspace_123
+                     */
+                    account_identifier?: string | null;
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -29824,6 +29979,16 @@ export interface operations {
                      */
                     secret: string;
                 } | {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
+                    /**
+                     * @description A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
+                     * @example workspace_123
+                     */
+                    account_identifier?: string | null;
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -29857,6 +30022,16 @@ export interface operations {
                      */
                     connected_account_id: string;
                 } | {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
+                    /**
+                     * @description A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
+                     * @example workspace_123
+                     */
+                    account_identifier?: string | null;
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -29898,8 +30073,8 @@ export interface operations {
                      *       "object": "connected_account",
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "connection_role": "compatibility",
-                     *       "account_identifier": null,
-                     *       "account_display_name": null,
+                     *       "account_identifier": "workspace_123",
+                     *       "account_display_name": "Acme production",
                      *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "scopes": [],
@@ -29910,7 +30085,7 @@ export interface operations {
                      *       "updated_at": "2024-01-16T14:20:00.000Z"
                      *     }
                      */
-                    "application/json": components["schemas"]["ConnectedAccount"];
+                    "application/json": components["schemas"]["ConnectedAccountWriteResponse"];
                 };
             };
             /** @description Bad Request */
@@ -29920,11 +30095,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
+                        message: string | string[];
                     };
                 };
             };
@@ -30010,6 +30181,16 @@ export interface operations {
         requestBody: {
             content: {
                 "application/json": {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
+                    /**
+                     * @description A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
+                     * @example workspace_123
+                     */
+                    account_identifier?: string | null;
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30052,8 +30233,8 @@ export interface operations {
                      *       "object": "connected_account",
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "connection_role": "standard",
-                     *       "account_identifier": null,
-                     *       "account_display_name": null,
+                     *       "account_identifier": "workspace_123",
+                     *       "account_display_name": "Acme production",
                      *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "scopes": [],
@@ -30064,7 +30245,7 @@ export interface operations {
                      *       "updated_at": "2024-01-16T14:20:00.000Z"
                      *     }
                      */
-                    "application/json": components["schemas"]["ConnectedAccount"];
+                    "application/json": components["schemas"]["ConnectedAccountWriteResponse"];
                 };
             };
             /** @description The request is invalid, including a missing `connection_intent: add` or a supplied `connected_account_id`. */
@@ -30074,11 +30255,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
+                        message: string | string[];
                     };
                 };
             };
@@ -30194,6 +30371,11 @@ export interface operations {
         requestBody: {
             content: {
                 "application/json": {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
                     /**
                      * @description The ID of the user to authorize. When `connection_owner` is `organization`, this is the user authorizing on behalf of the organization; they must be an active member of the organization and do not become the owner of the resulting connected account.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30226,6 +30408,11 @@ export interface operations {
                         [key: string]: string;
                     };
                 } | {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
                     /**
                      * @description The ID of the user to authorize. When `connection_owner` is `organization`, this is the user authorizing on behalf of the organization; they must be an active member of the organization and do not become the owner of the resulting connected account.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30264,6 +30451,11 @@ export interface operations {
                      */
                     connection_intent: "add";
                 } | {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
                     /**
                      * @description The ID of the user to authorize. When `connection_owner` is `organization`, this is the user authorizing on behalf of the organization; they must be an active member of the organization and do not become the owner of the resulting connected account.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30326,11 +30518,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
+                        message: string | string[];
                     };
                 };
             };
@@ -30434,6 +30622,16 @@ export interface operations {
         requestBody: {
             content: {
                 "application/json": {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
+                    /**
+                     * @description A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
+                     * @example workspace_123
+                     */
+                    account_identifier?: string | null;
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30470,6 +30668,16 @@ export interface operations {
                         [key: string]: string;
                     };
                 } | {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
+                    /**
+                     * @description A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
+                     * @example workspace_123
+                     */
+                    account_identifier?: string | null;
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30517,6 +30725,16 @@ export interface operations {
                      */
                     connected_account_id: string;
                 } | {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
+                    /**
+                     * @description A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
+                     * @example workspace_123
+                     */
+                    account_identifier?: string | null;
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30572,8 +30790,8 @@ export interface operations {
                      *       "object": "connected_account",
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "connection_role": "compatibility",
-                     *       "account_identifier": null,
-                     *       "account_display_name": null,
+                     *       "account_identifier": "workspace_123",
+                     *       "account_display_name": "Acme production",
                      *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "scopes": [],
@@ -30583,7 +30801,7 @@ export interface operations {
                      *       "updated_at": "2024-01-16T14:20:00.000Z"
                      *     }
                      */
-                    "application/json": components["schemas"]["ConnectedAccount"];
+                    "application/json": components["schemas"]["ConnectedAccountWriteResponse"];
                 };
             };
             /** @description Bad Request */
@@ -30593,11 +30811,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
+                        message: string | string[];
                     };
                 };
             };
@@ -30683,6 +30897,16 @@ export interface operations {
         requestBody: {
             content: {
                 "application/json": {
+                    /**
+                     * @description A mutable, non-unique label. Omit to preserve an existing label; null clears it. Labels are never account identifiers.
+                     * @example Acme production
+                     */
+                    account_display_name?: string | null;
+                    /**
+                     * @description A developer-attested provider account identifier, never inferred from a label or credential. Omit to preserve an existing identifier; null clears it.
+                     * @example workspace_123
+                     */
+                    account_identifier?: string | null;
                     /**
                      * @description A [User](/reference/authkit/user) identifier.
                      * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -30739,8 +30963,8 @@ export interface operations {
                      *       "object": "connected_account",
                      *       "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "connection_role": "standard",
-                     *       "account_identifier": null,
-                     *       "account_display_name": null,
+                     *       "account_identifier": "workspace_123",
+                     *       "account_display_name": "Acme production",
                      *       "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "scopes": [],
@@ -30750,7 +30974,7 @@ export interface operations {
                      *       "updated_at": "2024-01-16T14:20:00.000Z"
                      *     }
                      */
-                    "application/json": components["schemas"]["ConnectedAccount"];
+                    "application/json": components["schemas"]["ConnectedAccountWriteResponse"];
                 };
             };
             /** @description The request is invalid, including a missing `connection_intent: add` or a supplied `connected_account_id`. */
@@ -30760,11 +30984,7 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        /**
-                         * @description A human-readable description of the error.
-                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
-                         */
-                        message: string;
+                        message: string | string[];
                     };
                 };
             };
@@ -34314,7 +34534,7 @@ export interface operations {
                      *       "user_id": null,
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "connection_role": "compatibility",
-                     *       "account_identifier": "acme-workspace",
+                     *       "account_identifier": "workspace_123",
                      *       "account_display_name": "Acme production",
                      *       "scopes": [
                      *         "repo",
@@ -34421,7 +34641,7 @@ export interface operations {
                      *       "user_id": null,
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "connection_role": "compatibility",
-                     *       "account_identifier": "acme-workspace",
+                     *       "account_identifier": "workspace_123",
                      *       "account_display_name": "Acme production",
                      *       "scopes": [
                      *         "repo",
@@ -34439,7 +34659,7 @@ export interface operations {
                      *       "updated_at": "2024-01-16T14:20:00.000Z"
                      *     }
                      */
-                    "application/json": components["schemas"]["ConnectedAccount"];
+                    "application/json": components["schemas"]["ConnectedAccountWriteResponse"];
                 };
             };
             /** @description The connected account selector is malformed. */
@@ -34570,7 +34790,7 @@ export interface operations {
                      *       "user_id": null,
                      *       "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *       "connection_role": "compatibility",
-                     *       "account_identifier": "acme-workspace",
+                     *       "account_identifier": "workspace_123",
                      *       "account_display_name": "Acme production",
                      *       "scopes": [
                      *         "repo",
@@ -34588,7 +34808,7 @@ export interface operations {
                      *       "updated_at": "2024-01-16T14:20:00.000Z"
                      *     }
                      */
-                    "application/json": components["schemas"]["ConnectedAccount"];
+                    "application/json": components["schemas"]["ConnectedAccountWriteResponse"];
                 };
             };
             /** @description The request is missing a valid API key. */
@@ -34885,7 +35105,7 @@ export interface operations {
                      *             "user_id": null,
                      *             "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *             "connection_role": "compatibility",
-                     *             "account_identifier": "acme-workspace",
+                     *             "account_identifier": "workspace_123",
                      *             "account_display_name": "Acme production",
                      *             "scopes": [
                      *               "repo",
@@ -34913,7 +35133,7 @@ export interface operations {
                      *               "user_id": null,
                      *               "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                      *               "connection_role": "compatibility",
-                     *               "account_identifier": "acme-workspace",
+                     *               "account_identifier": "workspace_123",
                      *               "account_display_name": "Acme production",
                      *               "scopes": [
                      *                 "repo",
@@ -39287,6 +39507,27 @@ export interface operations {
                     };
                 };
             };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example This organization membership is managed by a directory and cannot be deleted. Remove the user from the directory in the identity provider instead.
+                         */
+                        message: string;
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example organization_membership_directory_managed
+                         * @constant
+                         */
+                        code: "organization_membership_directory_managed";
+                    };
+                };
+            };
         };
     };
     UserlandUserOrganizationMembershipsController_deactivate: {
@@ -42029,7 +42270,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ConnectedAccount"];
+                    "application/json": components["schemas"]["ConnectedAccountWriteResponse"];
                 };
             };
             /** @description The connected account selector is malformed. */
@@ -42174,7 +42415,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ConnectedAccount"];
+                    "application/json": components["schemas"]["ConnectedAccountWriteResponse"];
                 };
             };
             /** @description The request is missing a valid API key. */

package/package.json

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