@workos/openapi-spec 0.94.0 → 0.96.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/types.d.ts CHANGED
@@ -2217,6 +2217,58 @@ export interface paths {
2217
2217
  patch?: never;
2218
2218
  trace?: never;
2219
2219
  };
2220
+ "/organizations/{organization_id}/connected_accounts/{slug}": {
2221
+ parameters: {
2222
+ query?: never;
2223
+ header?: never;
2224
+ path?: never;
2225
+ cookie?: never;
2226
+ };
2227
+ /**
2228
+ * Get an organization connected account
2229
+ * @description Retrieves an organization's [connected account](/reference/pipes/connected-account) for a specific provider.
2230
+ */
2231
+ get: operations["DataIntegrationsOrganizationController_getOrganizationDataInstallation"];
2232
+ /**
2233
+ * Update an organization connected account
2234
+ * @description Updates an organization's [connected account](/reference/pipes/connected-account) tokens, scopes, or state for a specific provider.
2235
+ */
2236
+ put: operations["DataIntegrationsOrganizationController_updateOrganizationDataInstallation"];
2237
+ /**
2238
+ * Import an organization connected account
2239
+ * @description Imports an organization-owned [connected account](/reference/pipes/connected-account) by providing OAuth tokens directly. Use this to migrate existing connections or set up connections without going through the OAuth flow.
2240
+ */
2241
+ post: operations["DataIntegrationsOrganizationController_createOrganizationDataInstallation"];
2242
+ /**
2243
+ * Delete an organization connected account
2244
+ * @description Disconnects the organization's account for the provider, including removing any stored access and refresh tokens. A member will need to reauthorize if the organization wants to reconnect. This does not revoke access on the provider side.
2245
+ */
2246
+ delete: operations["DataIntegrationsOrganizationController_deleteOrganizationDataInstallation"];
2247
+ options?: never;
2248
+ head?: never;
2249
+ patch?: never;
2250
+ trace?: never;
2251
+ };
2252
+ "/organizations/{organization_id}/data_providers": {
2253
+ parameters: {
2254
+ query?: never;
2255
+ header?: never;
2256
+ path?: never;
2257
+ cookie?: never;
2258
+ };
2259
+ /**
2260
+ * List providers for an organization
2261
+ * @description Retrieves the organization-owned providers configured for your environment and the organization's [connected account](/reference/pipes/connected-account) information for each. Providers owned by individual users are not included.
2262
+ */
2263
+ get: operations["DataIntegrationsOrganizationController_getOrganizationDataIntegrations"];
2264
+ put?: never;
2265
+ post?: never;
2266
+ delete?: never;
2267
+ options?: never;
2268
+ head?: never;
2269
+ patch?: never;
2270
+ trace?: never;
2271
+ };
2220
2272
  "/organizations/{organization_id}/it_contacts": {
2221
2273
  parameters: {
2222
2274
  query?: never;
@@ -8908,6 +8960,22 @@ export interface components {
8908
8960
  * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
8909
8961
  */
8910
8962
  id: string;
8963
+ /**
8964
+ * @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.
8965
+ * @example compatibility
8966
+ * @enum {string}
8967
+ */
8968
+ connection_role?: "compatibility" | "standard";
8969
+ /**
8970
+ * @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.
8971
+ * @example workspace_123
8972
+ */
8973
+ account_identifier?: string | null;
8974
+ /**
8975
+ * @description A mutable, non-unique display name for the provider account connection. Historical events may omit this field.
8976
+ * @example Acme production
8977
+ */
8978
+ account_display_name?: string | null;
8911
8979
  /**
8912
8980
  * @description The unique ID of the data integration.
8913
8981
  * @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
@@ -8936,6 +9004,17 @@ export interface components {
8936
9004
  * ]
8937
9005
  */
8938
9006
  scopes: string[];
9007
+ /**
9008
+ * @description How the connection authenticates. Historical events may omit this field.
9009
+ * @example oauth
9010
+ * @enum {string}
9011
+ */
9012
+ auth_method?: "oauth" | "api_key" | "client_credentials";
9013
+ /**
9014
+ * @description The last four characters of the API key, or null for other authentication methods. Historical events may omit this field.
9015
+ * @example null
9016
+ */
9017
+ api_key_last_4?: string | null;
8939
9018
  /**
8940
9019
  * @description The state of the connected account.
8941
9020
  * @example connected
@@ -15352,6 +15431,11 @@ export interface components {
15352
15431
  * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
15353
15432
  */
15354
15433
  organization_id: string | null;
15434
+ /**
15435
+ * @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.
15436
+ * @example null
15437
+ */
15438
+ account_identifier?: string | null;
15355
15439
  /**
15356
15440
  * @description A machine-readable error code for the failure.
15357
15441
  * @example authorization_code_exchange_error
@@ -15452,6 +15536,11 @@ export interface components {
15452
15536
  * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
15453
15537
  */
15454
15538
  organization_id: string | null;
15539
+ /**
15540
+ * @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.
15541
+ * @example null
15542
+ */
15543
+ account_identifier?: string | null;
15455
15544
  /**
15456
15545
  * @description A machine-readable error code for the failure.
15457
15546
  * @example authorization_code_exchange_error
@@ -15596,6 +15685,11 @@ export interface components {
15596
15685
  * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
15597
15686
  */
15598
15687
  organization_id: string | null;
15688
+ /**
15689
+ * @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.
15690
+ * @example null
15691
+ */
15692
+ account_identifier?: string | null;
15599
15693
  /**
15600
15694
  * @description A machine-readable error code for the failure.
15601
15695
  * @example authorization_code_exchange_error
@@ -17719,6 +17813,22 @@ export interface components {
17719
17813
  * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
17720
17814
  */
17721
17815
  id: string;
17816
+ /**
17817
+ * @description Whether this is the compatibility connection visible to undeclared clients or a standard connection for plural-aware clients.
17818
+ * @example compatibility
17819
+ * @enum {string}
17820
+ */
17821
+ connection_role: "compatibility" | "standard";
17822
+ /**
17823
+ * @description A best-effort provider account identifier used for correlation, not connection selection.
17824
+ * @example workspace_123
17825
+ */
17826
+ account_identifier: string | null;
17827
+ /**
17828
+ * @description A mutable, non-unique display name for this connection.
17829
+ * @example Acme production
17830
+ */
17831
+ account_display_name: string | null;
17722
17832
  /**
17723
17833
  * @description The User the API key was installed for. Null on an `organization`-owned integration, whose installations belong to the organization.
17724
17834
  * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -18071,6 +18181,22 @@ export interface components {
18071
18181
  * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
18072
18182
  */
18073
18183
  id: string;
18184
+ /**
18185
+ * @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.
18186
+ * @example compatibility
18187
+ * @enum {string}
18188
+ */
18189
+ connection_role: "compatibility" | "standard";
18190
+ /**
18191
+ * @description A best-effort identifier for the provider account this connection points at. It is correlation metadata, not the connection identifier or a selector.
18192
+ * @example workspace_123
18193
+ */
18194
+ account_identifier: string | null;
18195
+ /**
18196
+ * @description A mutable, non-unique display name for the provider account connection.
18197
+ * @example Acme production
18198
+ */
18199
+ account_display_name: string | null;
18074
18200
  /**
18075
18201
  * @description The [User](/reference/authkit/user) identifier associated with this connection.
18076
18202
  * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -18244,6 +18370,22 @@ export interface components {
18244
18370
  * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
18245
18371
  */
18246
18372
  id: string;
18373
+ /**
18374
+ * @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.
18375
+ * @example compatibility
18376
+ * @enum {string}
18377
+ */
18378
+ connection_role: "compatibility" | "standard";
18379
+ /**
18380
+ * @description A best-effort identifier for the provider account this connection points at. It is correlation metadata, not the connection identifier or a selector.
18381
+ * @example workspace_123
18382
+ */
18383
+ account_identifier: string | null;
18384
+ /**
18385
+ * @description A mutable, non-unique display name for the provider account connection.
18386
+ * @example Acme production
18387
+ */
18388
+ account_display_name: string | null;
18247
18389
  /**
18248
18390
  * @description The [User](/reference/authkit/user) identifier associated with this connection.
18249
18391
  * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -18344,6 +18486,22 @@ export interface components {
18344
18486
  * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
18345
18487
  */
18346
18488
  id: string;
18489
+ /**
18490
+ * @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.
18491
+ * @example compatibility
18492
+ * @enum {string}
18493
+ */
18494
+ connection_role: "compatibility" | "standard";
18495
+ /**
18496
+ * @description A best-effort identifier for the provider account this connection points at. It is correlation metadata, not the connection identifier or a selector.
18497
+ * @example workspace_123
18498
+ */
18499
+ account_identifier: string | null;
18500
+ /**
18501
+ * @description A mutable, non-unique display name for the provider account connection.
18502
+ * @example Acme production
18503
+ */
18504
+ account_display_name: string | null;
18347
18505
  /**
18348
18506
  * @description The [User](/reference/authkit/user) identifier associated with this connection.
18349
18507
  * @example user_01EHZNVPK3SFK441A1RGBFSHRT
@@ -29272,6 +29430,9 @@ export interface operations {
29272
29430
  * @example {
29273
29431
  * "object": "connected_account",
29274
29432
  * "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
29433
+ * "connection_role": "compatibility",
29434
+ * "account_identifier": null,
29435
+ * "account_display_name": null,
29275
29436
  * "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
29276
29437
  * "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
29277
29438
  * "scopes": [],
@@ -29371,15 +29532,21 @@ export interface operations {
29371
29532
  content: {
29372
29533
  "application/json": {
29373
29534
  /**
29374
- * @description The ID of the user to authorize.
29535
+ * @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.
29375
29536
  * @example user_01EHZNVPK3SFK441A1RGBFSHRT
29376
29537
  */
29377
29538
  user_id: string;
29378
29539
  /**
29379
- * @description An organization ID to scope the authorization to a specific organization.
29540
+ * @description An organization ID to scope the authorization to a specific organization. Required when `connection_owner` is `organization`.
29380
29541
  * @example org_01EHZNVPK3SFK441A1RGBFSHRT
29381
29542
  */
29382
29543
  organization_id?: string;
29544
+ /**
29545
+ * @description Who will own the connected account. `user` (the default) connects the user's own account. `organization` connects the organization's shared account and requires `organization_id`.
29546
+ * @example user
29547
+ * @enum {string}
29548
+ */
29549
+ connection_owner?: "user" | "organization";
29383
29550
  /**
29384
29551
  * Format: uri
29385
29552
  * @description The URL to redirect the user to after authorization.
@@ -29529,6 +29696,9 @@ export interface operations {
29529
29696
  * @example {
29530
29697
  * "object": "connected_account",
29531
29698
  * "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
29699
+ * "connection_role": "compatibility",
29700
+ * "account_identifier": null,
29701
+ * "account_display_name": null,
29532
29702
  * "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
29533
29703
  * "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
29534
29704
  * "scopes": [],
@@ -32901,6 +33071,612 @@ export interface operations {
32901
33071
  };
32902
33072
  };
32903
33073
  };
33074
+ DataIntegrationsOrganizationController_getOrganizationDataInstallation: {
33075
+ parameters: {
33076
+ query?: {
33077
+ /** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
33078
+ supports_multiple_connections?: boolean;
33079
+ /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the organization has several for this provider. */
33080
+ connected_account_id?: string;
33081
+ };
33082
+ header?: never;
33083
+ path: {
33084
+ /** @description An [Organization](/reference/organization) identifier. */
33085
+ organization_id: string;
33086
+ /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
33087
+ slug: string;
33088
+ };
33089
+ cookie?: never;
33090
+ };
33091
+ requestBody?: never;
33092
+ responses: {
33093
+ /** @description The connected account was retrieved successfully. */
33094
+ 200: {
33095
+ headers: {
33096
+ [name: string]: unknown;
33097
+ };
33098
+ content: {
33099
+ /**
33100
+ * @example {
33101
+ * "object": "connected_account",
33102
+ * "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
33103
+ * "user_id": null,
33104
+ * "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
33105
+ * "connection_role": "compatibility",
33106
+ * "account_identifier": "acme-workspace",
33107
+ * "account_display_name": "Acme production",
33108
+ * "scopes": [
33109
+ * "repo",
33110
+ * "user:email"
33111
+ * ],
33112
+ * "auth_method": "oauth",
33113
+ * "api_key_last_4": null,
33114
+ * "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
33115
+ * "client_secret_last_4": "cdef",
33116
+ * "config": {
33117
+ * "instance_url": "https://example.my.salesforce.com"
33118
+ * },
33119
+ * "state": "connected",
33120
+ * "created_at": "2024-01-16T14:20:00.000Z",
33121
+ * "updated_at": "2024-01-16T14:20:00.000Z"
33122
+ * }
33123
+ */
33124
+ "application/json": components["schemas"]["ConnectedAccount"];
33125
+ };
33126
+ };
33127
+ /** @description The connected account selector is malformed. */
33128
+ 400: {
33129
+ headers: {
33130
+ [name: string]: unknown;
33131
+ };
33132
+ content: {
33133
+ "application/json": {
33134
+ /**
33135
+ * @description A human-readable description of the error.
33136
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33137
+ */
33138
+ message: string;
33139
+ };
33140
+ };
33141
+ };
33142
+ /** @description The request is missing a valid API key. */
33143
+ 401: {
33144
+ headers: {
33145
+ [name: string]: unknown;
33146
+ };
33147
+ content?: never;
33148
+ };
33149
+ /** @description The organization or connected account was not found. */
33150
+ 404: {
33151
+ headers: {
33152
+ [name: string]: unknown;
33153
+ };
33154
+ content: {
33155
+ "application/json": {
33156
+ /**
33157
+ * @description A human-readable description of the error.
33158
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33159
+ */
33160
+ message: string;
33161
+ };
33162
+ };
33163
+ };
33164
+ /** @description Several connected accounts match this organization for the provider; one must be named. */
33165
+ 409: {
33166
+ headers: {
33167
+ [name: string]: unknown;
33168
+ };
33169
+ content: {
33170
+ "application/json": components["schemas"]["AccountSelectionRequiredError"];
33171
+ };
33172
+ };
33173
+ };
33174
+ };
33175
+ DataIntegrationsOrganizationController_updateOrganizationDataInstallation: {
33176
+ parameters: {
33177
+ query?: {
33178
+ /** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
33179
+ supports_multiple_connections?: boolean;
33180
+ /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to update. */
33181
+ connected_account_id?: string;
33182
+ };
33183
+ header?: never;
33184
+ path: {
33185
+ /** @description An [Organization](/reference/organization) identifier. */
33186
+ organization_id: string;
33187
+ /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
33188
+ slug: string;
33189
+ };
33190
+ cookie?: never;
33191
+ };
33192
+ requestBody: {
33193
+ content: {
33194
+ "application/json": components["schemas"]["ConnectedAccountDto"];
33195
+ };
33196
+ };
33197
+ responses: {
33198
+ /** @description The connected account was updated successfully. */
33199
+ 200: {
33200
+ headers: {
33201
+ [name: string]: unknown;
33202
+ };
33203
+ content: {
33204
+ /**
33205
+ * @example {
33206
+ * "object": "connected_account",
33207
+ * "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
33208
+ * "user_id": null,
33209
+ * "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
33210
+ * "connection_role": "compatibility",
33211
+ * "account_identifier": "acme-workspace",
33212
+ * "account_display_name": "Acme production",
33213
+ * "scopes": [
33214
+ * "repo",
33215
+ * "user:email"
33216
+ * ],
33217
+ * "auth_method": "oauth",
33218
+ * "api_key_last_4": null,
33219
+ * "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
33220
+ * "client_secret_last_4": "cdef",
33221
+ * "config": {
33222
+ * "instance_url": "https://example.my.salesforce.com"
33223
+ * },
33224
+ * "state": "connected",
33225
+ * "created_at": "2024-01-16T14:20:00.000Z",
33226
+ * "updated_at": "2024-01-16T14:20:00.000Z"
33227
+ * }
33228
+ */
33229
+ "application/json": components["schemas"]["ConnectedAccount"];
33230
+ };
33231
+ };
33232
+ /** @description The connected account selector is malformed. */
33233
+ 400: {
33234
+ headers: {
33235
+ [name: string]: unknown;
33236
+ };
33237
+ content: {
33238
+ "application/json": {
33239
+ /**
33240
+ * @description A human-readable description of the error.
33241
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33242
+ */
33243
+ message: string;
33244
+ };
33245
+ };
33246
+ };
33247
+ /** @description The request is missing a valid API key. */
33248
+ 401: {
33249
+ headers: {
33250
+ [name: string]: unknown;
33251
+ };
33252
+ content?: never;
33253
+ };
33254
+ /** @description The organization or connected account was not found. */
33255
+ 404: {
33256
+ headers: {
33257
+ [name: string]: unknown;
33258
+ };
33259
+ content: {
33260
+ "application/json": {
33261
+ /**
33262
+ * @description A human-readable description of the error.
33263
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33264
+ */
33265
+ message: string;
33266
+ };
33267
+ };
33268
+ };
33269
+ /** @description Several connected accounts match this organization for the provider; one must be named. */
33270
+ 409: {
33271
+ headers: {
33272
+ [name: string]: unknown;
33273
+ };
33274
+ content: {
33275
+ "application/json": components["schemas"]["AccountSelectionRequiredError"];
33276
+ };
33277
+ };
33278
+ /** @description The request body is malformed (`invalid_request_parameters`). */
33279
+ 422: {
33280
+ headers: {
33281
+ [name: string]: unknown;
33282
+ };
33283
+ content: {
33284
+ "application/json": {
33285
+ /**
33286
+ * @description The error code identifying the type of error.
33287
+ * @example invalid_request_parameters
33288
+ * @constant
33289
+ */
33290
+ code: "invalid_request_parameters";
33291
+ /**
33292
+ * @description A human-readable description of the error.
33293
+ * @example Validation failed.
33294
+ */
33295
+ message: string;
33296
+ /** @description The list of validation errors. */
33297
+ errors: {
33298
+ /**
33299
+ * @description The validation error code.
33300
+ * @example unknown_event_type
33301
+ */
33302
+ code: string;
33303
+ /**
33304
+ * @description A human-readable description of the validation error.
33305
+ * @example Invalid enum value.
33306
+ */
33307
+ message: string;
33308
+ }[];
33309
+ };
33310
+ };
33311
+ };
33312
+ };
33313
+ };
33314
+ DataIntegrationsOrganizationController_createOrganizationDataInstallation: {
33315
+ parameters: {
33316
+ query?: never;
33317
+ header?: never;
33318
+ path: {
33319
+ /** @description An [Organization](/reference/organization) identifier. */
33320
+ organization_id: string;
33321
+ /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
33322
+ slug: string;
33323
+ };
33324
+ cookie?: never;
33325
+ };
33326
+ requestBody: {
33327
+ content: {
33328
+ "application/json": components["schemas"]["ConnectedAccountDto"];
33329
+ };
33330
+ };
33331
+ responses: {
33332
+ /** @description The connected account was created successfully. */
33333
+ 201: {
33334
+ headers: {
33335
+ [name: string]: unknown;
33336
+ };
33337
+ content: {
33338
+ /**
33339
+ * @example {
33340
+ * "object": "connected_account",
33341
+ * "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
33342
+ * "user_id": null,
33343
+ * "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
33344
+ * "connection_role": "compatibility",
33345
+ * "account_identifier": "acme-workspace",
33346
+ * "account_display_name": "Acme production",
33347
+ * "scopes": [
33348
+ * "repo",
33349
+ * "user:email"
33350
+ * ],
33351
+ * "auth_method": "oauth",
33352
+ * "api_key_last_4": null,
33353
+ * "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
33354
+ * "client_secret_last_4": "cdef",
33355
+ * "config": {
33356
+ * "instance_url": "https://example.my.salesforce.com"
33357
+ * },
33358
+ * "state": "connected",
33359
+ * "created_at": "2024-01-16T14:20:00.000Z",
33360
+ * "updated_at": "2024-01-16T14:20:00.000Z"
33361
+ * }
33362
+ */
33363
+ "application/json": components["schemas"]["ConnectedAccount"];
33364
+ };
33365
+ };
33366
+ /** @description The request is missing a valid API key. */
33367
+ 401: {
33368
+ headers: {
33369
+ [name: string]: unknown;
33370
+ };
33371
+ content?: never;
33372
+ };
33373
+ /** @description The organization or data integration was not found. */
33374
+ 404: {
33375
+ headers: {
33376
+ [name: string]: unknown;
33377
+ };
33378
+ content: {
33379
+ "application/json": {
33380
+ /**
33381
+ * @description A human-readable description of the error.
33382
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33383
+ */
33384
+ message: string;
33385
+ };
33386
+ };
33387
+ };
33388
+ /** @description A connected account already exists for this organization and integration. */
33389
+ 409: {
33390
+ headers: {
33391
+ [name: string]: unknown;
33392
+ };
33393
+ content: {
33394
+ "application/json": {
33395
+ /**
33396
+ * @description A human-readable description of the error.
33397
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33398
+ */
33399
+ message: string;
33400
+ };
33401
+ };
33402
+ };
33403
+ /** @description The request body is malformed (`invalid_request_parameters`), the data integration is not in a valid state (`invalid_data_integration_state`), the token combination is invalid (`invalid_token_combination`), or no client credentials are configured for the data integration (`client_credentials_not_configured`). */
33404
+ 422: {
33405
+ headers: {
33406
+ [name: string]: unknown;
33407
+ };
33408
+ content: {
33409
+ "application/json": {
33410
+ /**
33411
+ * @description The error code identifying the type of error.
33412
+ * @example invalid_token_combination
33413
+ * @enum {string}
33414
+ */
33415
+ code: "invalid_token_combination" | "invalid_data_integration_state" | "client_credentials_not_configured";
33416
+ /**
33417
+ * @description A human-readable description of the error.
33418
+ * @example Request could not be processed.
33419
+ */
33420
+ message: string;
33421
+ } | {
33422
+ /**
33423
+ * @description The error code identifying the type of error.
33424
+ * @example invalid_request_parameters
33425
+ * @constant
33426
+ */
33427
+ code: "invalid_request_parameters";
33428
+ /**
33429
+ * @description A human-readable description of the error.
33430
+ * @example Validation failed.
33431
+ */
33432
+ message: string;
33433
+ /** @description The list of validation errors. */
33434
+ errors: {
33435
+ /**
33436
+ * @description The validation error code.
33437
+ * @example unknown_event_type
33438
+ */
33439
+ code: string;
33440
+ /**
33441
+ * @description A human-readable description of the validation error.
33442
+ * @example Invalid enum value.
33443
+ */
33444
+ message: string;
33445
+ }[];
33446
+ };
33447
+ };
33448
+ };
33449
+ };
33450
+ };
33451
+ DataIntegrationsOrganizationController_deleteOrganizationDataInstallation: {
33452
+ parameters: {
33453
+ query?: {
33454
+ /** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
33455
+ supports_multiple_connections?: boolean;
33456
+ /** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to delete. */
33457
+ connected_account_id?: string;
33458
+ };
33459
+ header?: never;
33460
+ path: {
33461
+ /** @description An [Organization](/reference/organization) identifier. */
33462
+ organization_id: string;
33463
+ /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
33464
+ slug: string;
33465
+ };
33466
+ cookie?: never;
33467
+ };
33468
+ requestBody?: never;
33469
+ responses: {
33470
+ /** @description The connected account was deleted successfully. */
33471
+ 204: {
33472
+ headers: {
33473
+ [name: string]: unknown;
33474
+ };
33475
+ content?: never;
33476
+ };
33477
+ /** @description The connected account selector is malformed. */
33478
+ 400: {
33479
+ headers: {
33480
+ [name: string]: unknown;
33481
+ };
33482
+ content: {
33483
+ "application/json": {
33484
+ /**
33485
+ * @description A human-readable description of the error.
33486
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33487
+ */
33488
+ message: string;
33489
+ };
33490
+ };
33491
+ };
33492
+ /** @description The request is missing a valid API key. */
33493
+ 401: {
33494
+ headers: {
33495
+ [name: string]: unknown;
33496
+ };
33497
+ content?: never;
33498
+ };
33499
+ /** @description The organization or connected account was not found. */
33500
+ 404: {
33501
+ headers: {
33502
+ [name: string]: unknown;
33503
+ };
33504
+ content: {
33505
+ "application/json": {
33506
+ /**
33507
+ * @description A human-readable description of the error.
33508
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33509
+ */
33510
+ message: string;
33511
+ };
33512
+ };
33513
+ };
33514
+ /** @description Several connected accounts match this organization for the provider; one must be named. */
33515
+ 409: {
33516
+ headers: {
33517
+ [name: string]: unknown;
33518
+ };
33519
+ content: {
33520
+ "application/json": components["schemas"]["AccountSelectionRequiredError"];
33521
+ };
33522
+ };
33523
+ /** @description The connected account or its WorkOS OAuth grant is being changed by another request. Retry the request. */
33524
+ 503: {
33525
+ headers: {
33526
+ [name: string]: unknown;
33527
+ };
33528
+ content: {
33529
+ "application/json": {
33530
+ /**
33531
+ * @description The error code identifying the type of error.
33532
+ * @example concurrent_request
33533
+ * @constant
33534
+ */
33535
+ code: "concurrent_request";
33536
+ /**
33537
+ * @description A human-readable description of the error.
33538
+ * @example Request could not be processed.
33539
+ */
33540
+ message: string;
33541
+ };
33542
+ };
33543
+ };
33544
+ };
33545
+ };
33546
+ DataIntegrationsOrganizationController_getOrganizationDataIntegrations: {
33547
+ parameters: {
33548
+ query?: {
33549
+ /** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
33550
+ supports_multiple_connections?: boolean;
33551
+ };
33552
+ header?: never;
33553
+ path: {
33554
+ /** @description An [Organization](/reference/organization) identifier to list providers and connected accounts for. */
33555
+ organization_id: string;
33556
+ };
33557
+ cookie?: never;
33558
+ };
33559
+ requestBody?: never;
33560
+ responses: {
33561
+ /** @description The list of data providers was retrieved successfully. */
33562
+ 200: {
33563
+ headers: {
33564
+ [name: string]: unknown;
33565
+ };
33566
+ content: {
33567
+ /**
33568
+ * @example {
33569
+ * "object": "list",
33570
+ * "data": [
33571
+ * {
33572
+ * "object": "data_provider",
33573
+ * "id": "data_integration_01EHZNVPK3SFK441A1RGBFSHRT",
33574
+ * "name": "GitHub",
33575
+ * "description": "Connect your GitHub account to access repositories.",
33576
+ * "slug": "github",
33577
+ * "integration_type": "github",
33578
+ * "credentials_type": "oauth2",
33579
+ * "scopes": [
33580
+ * "repo",
33581
+ * "user:email"
33582
+ * ],
33583
+ * "auth_methods": [
33584
+ * "oauth"
33585
+ * ],
33586
+ * "ownership": "organization",
33587
+ * "created_at": "2024-01-15T10:30:00.000Z",
33588
+ * "updated_at": "2024-01-15T10:30:00.000Z",
33589
+ * "integrationType": "github",
33590
+ * "credentialsType": "oauth2",
33591
+ * "createdAt": "2024-01-15T10:30:00.000Z",
33592
+ * "updatedAt": "2024-01-15T10:30:00.000Z",
33593
+ * "connected_account": {
33594
+ * "object": "connected_account",
33595
+ * "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
33596
+ * "user_id": null,
33597
+ * "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
33598
+ * "connection_role": "compatibility",
33599
+ * "account_identifier": "acme-workspace",
33600
+ * "account_display_name": "Acme production",
33601
+ * "scopes": [
33602
+ * "repo",
33603
+ * "user:email"
33604
+ * ],
33605
+ * "auth_method": "oauth",
33606
+ * "api_key_last_4": null,
33607
+ * "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
33608
+ * "client_secret_last_4": "cdef",
33609
+ * "config": {
33610
+ * "instance_url": "https://example.my.salesforce.com"
33611
+ * },
33612
+ * "state": "connected",
33613
+ * "created_at": "2024-01-16T14:20:00.000Z",
33614
+ * "updated_at": "2024-01-16T14:20:00.000Z",
33615
+ * "userlandUserId": null,
33616
+ * "organizationId": "org_01EHZNVPK3SFK441A1RGBFSHRT",
33617
+ * "createdAt": "2024-01-16T14:20:00.000Z",
33618
+ * "updatedAt": "2024-01-16T14:20:00.000Z"
33619
+ * },
33620
+ * "connected_accounts": [
33621
+ * {
33622
+ * "object": "connected_account",
33623
+ * "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
33624
+ * "user_id": null,
33625
+ * "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
33626
+ * "connection_role": "compatibility",
33627
+ * "account_identifier": "acme-workspace",
33628
+ * "account_display_name": "Acme production",
33629
+ * "scopes": [
33630
+ * "repo",
33631
+ * "user:email"
33632
+ * ],
33633
+ * "auth_method": "oauth",
33634
+ * "api_key_last_4": null,
33635
+ * "client_id": "3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc",
33636
+ * "client_secret_last_4": "cdef",
33637
+ * "config": {
33638
+ * "instance_url": "https://example.my.salesforce.com"
33639
+ * },
33640
+ * "state": "connected",
33641
+ * "created_at": "2024-01-16T14:20:00.000Z",
33642
+ * "updated_at": "2024-01-16T14:20:00.000Z",
33643
+ * "userlandUserId": null,
33644
+ * "organizationId": "org_01EHZNVPK3SFK441A1RGBFSHRT",
33645
+ * "createdAt": "2024-01-16T14:20:00.000Z",
33646
+ * "updatedAt": "2024-01-16T14:20:00.000Z"
33647
+ * }
33648
+ * ]
33649
+ * }
33650
+ * ]
33651
+ * }
33652
+ */
33653
+ "application/json": components["schemas"]["DataIntegrationsListResponse"];
33654
+ };
33655
+ };
33656
+ /** @description The request is missing a valid API key. */
33657
+ 401: {
33658
+ headers: {
33659
+ [name: string]: unknown;
33660
+ };
33661
+ content?: never;
33662
+ };
33663
+ /** @description The organization was not found. */
33664
+ 404: {
33665
+ headers: {
33666
+ [name: string]: unknown;
33667
+ };
33668
+ content: {
33669
+ "application/json": {
33670
+ /**
33671
+ * @description A human-readable description of the error.
33672
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
33673
+ */
33674
+ message: string;
33675
+ };
33676
+ };
33677
+ };
33678
+ };
33679
+ };
32904
33680
  ItContactsController_list: {
32905
33681
  parameters: {
32906
33682
  query?: never;
@@ -40126,7 +40902,7 @@ export interface operations {
40126
40902
  };
40127
40903
  };
40128
40904
  };
40129
- /** @description The request body is malformed (`invalid_request_parameters`), the data integration is not in a valid state (`invalid_data_integration_state`), the token combination is invalid (`invalid_token_combination`), or `refresh_token` is not an active WorkOS OAuth grant of this user (`invalid_refresh_token`). */
40905
+ /** @description The request body is malformed (`invalid_request_parameters`), the data integration is not in a valid state (`invalid_data_integration_state`), the token combination is invalid (`invalid_token_combination`), no client credentials are configured for the data integration (`client_credentials_not_configured`), or `refresh_token` is not an active WorkOS OAuth grant of this user (`invalid_refresh_token`). */
40130
40906
  422: {
40131
40907
  headers: {
40132
40908
  [name: string]: unknown;
@@ -40138,7 +40914,7 @@ export interface operations {
40138
40914
  * @example invalid_refresh_token
40139
40915
  * @enum {string}
40140
40916
  */
40141
- code: "invalid_refresh_token" | "invalid_token_combination" | "invalid_data_integration_state";
40917
+ code: "invalid_refresh_token" | "invalid_token_combination" | "invalid_data_integration_state" | "client_credentials_not_configured";
40142
40918
  /**
40143
40919
  * @description A human-readable description of the error.
40144
40920
  * @example Request could not be processed.