@workos/openapi-spec 0.90.0 → 0.92.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/open-api-spec.yaml +1508 -399
- package/dist/services.mjs +31 -0
- package/dist/types.d.ts +1041 -17
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -1418,7 +1418,7 @@ export interface paths {
|
|
|
1418
1418
|
};
|
|
1419
1419
|
/**
|
|
1420
1420
|
* List data integrations
|
|
1421
|
-
* @description Lists the environment's data integrations configured with `custom` or `organization` credentials, including custom providers and API key integrations.
|
|
1421
|
+
* @description Lists the environment's data integrations configured with `custom` or `organization` credentials, including custom providers and API key integrations. Both user-owned and organization-owned roots are returned, each as its own row with an `ownership`; filter with `ownership` to return only one kind.
|
|
1422
1422
|
*/
|
|
1423
1423
|
get: operations["DataIntegrationsManagementController_listDataIntegrations"];
|
|
1424
1424
|
put?: never;
|
|
@@ -1442,18 +1442,18 @@ export interface paths {
|
|
|
1442
1442
|
};
|
|
1443
1443
|
/**
|
|
1444
1444
|
* Get a data integration
|
|
1445
|
-
* @description Retrieves
|
|
1445
|
+
* @description Retrieves the user-owned data integration by its slug.
|
|
1446
1446
|
*/
|
|
1447
1447
|
get: operations["DataIntegrationsManagementController_getDataIntegration"];
|
|
1448
1448
|
/**
|
|
1449
1449
|
* Update a data integration
|
|
1450
|
-
* @description Updates the description, enabled state, or custom credentials of
|
|
1450
|
+
* @description Updates the description, enabled state, or custom credentials of the user-owned data integration. For custom providers, `custom_provider` updates the OAuth definition.
|
|
1451
1451
|
*/
|
|
1452
1452
|
put: operations["DataIntegrationsManagementController_updateDataIntegration"];
|
|
1453
1453
|
post?: never;
|
|
1454
1454
|
/**
|
|
1455
1455
|
* Delete a data integration
|
|
1456
|
-
* @description Deletes
|
|
1456
|
+
* @description Deletes the user-owned data integration and all of its connected installations. For a custom provider, the provider definition is deleted once no organization-owned root references it either.
|
|
1457
1457
|
*/
|
|
1458
1458
|
delete: operations["DataIntegrationsManagementController_deleteDataIntegration"];
|
|
1459
1459
|
options?: never;
|
|
@@ -1541,6 +1541,34 @@ export interface paths {
|
|
|
1541
1541
|
patch?: never;
|
|
1542
1542
|
trace?: never;
|
|
1543
1543
|
};
|
|
1544
|
+
"/data-integrations/{slug}/organization": {
|
|
1545
|
+
parameters: {
|
|
1546
|
+
query?: never;
|
|
1547
|
+
header?: never;
|
|
1548
|
+
path?: never;
|
|
1549
|
+
cookie?: never;
|
|
1550
|
+
};
|
|
1551
|
+
/**
|
|
1552
|
+
* Get an organization-owned data integration
|
|
1553
|
+
* @description Retrieves the organization-owned data integration for a provider by its slug. The `/organization` suffix selects the environment-level organization-owned root for the provider; it does not name a particular organization.
|
|
1554
|
+
*/
|
|
1555
|
+
get: operations["DataIntegrationsManagementController_getOrganizationDataIntegration"];
|
|
1556
|
+
/**
|
|
1557
|
+
* Update an organization-owned data integration
|
|
1558
|
+
* @description Updates the description, enabled state, or custom credentials of the organization-owned data integration for a provider. For custom providers, `custom_provider` updates the OAuth definition, which is shared with the user-owned root. The `/organization` suffix selects the environment-level organization-owned root for the provider; it does not name a particular organization.
|
|
1559
|
+
*/
|
|
1560
|
+
put: operations["DataIntegrationsManagementController_updateOrganizationDataIntegration"];
|
|
1561
|
+
post?: never;
|
|
1562
|
+
/**
|
|
1563
|
+
* Delete an organization-owned data integration
|
|
1564
|
+
* @description Deletes the organization-owned data integration for a provider and all of its connected installations. For a custom provider, the provider definition is deleted once no user-owned root references it either. The `/organization` suffix selects the environment-level organization-owned root for the provider; it does not name a particular organization.
|
|
1565
|
+
*/
|
|
1566
|
+
delete: operations["DataIntegrationsManagementController_deleteOrganizationDataIntegration"];
|
|
1567
|
+
options?: never;
|
|
1568
|
+
head?: never;
|
|
1569
|
+
patch?: never;
|
|
1570
|
+
trace?: never;
|
|
1571
|
+
};
|
|
1544
1572
|
"/data-integrations/{slug}/token": {
|
|
1545
1573
|
parameters: {
|
|
1546
1574
|
query?: never;
|
|
@@ -2539,6 +2567,50 @@ export interface paths {
|
|
|
2539
2567
|
patch?: never;
|
|
2540
2568
|
trace?: never;
|
|
2541
2569
|
};
|
|
2570
|
+
"/user_management/authkit_oauth_resources": {
|
|
2571
|
+
parameters: {
|
|
2572
|
+
query?: never;
|
|
2573
|
+
header?: never;
|
|
2574
|
+
path?: never;
|
|
2575
|
+
cookie?: never;
|
|
2576
|
+
};
|
|
2577
|
+
/**
|
|
2578
|
+
* List MCP resource indicators
|
|
2579
|
+
* @description Lists the MCP resource indicators configured for an environment.
|
|
2580
|
+
*/
|
|
2581
|
+
get: operations["AuthkitOauthResourcesController_list"];
|
|
2582
|
+
put?: never;
|
|
2583
|
+
/**
|
|
2584
|
+
* Create an MCP resource indicator
|
|
2585
|
+
* @description Adds an MCP resource indicator (RFC 8707) to an environment, leaving any others in place.
|
|
2586
|
+
*/
|
|
2587
|
+
post: operations["AuthkitOauthResourcesController_create"];
|
|
2588
|
+
delete?: never;
|
|
2589
|
+
options?: never;
|
|
2590
|
+
head?: never;
|
|
2591
|
+
patch?: never;
|
|
2592
|
+
trace?: never;
|
|
2593
|
+
};
|
|
2594
|
+
"/user_management/authkit_oauth_resources/{id}": {
|
|
2595
|
+
parameters: {
|
|
2596
|
+
query?: never;
|
|
2597
|
+
header?: never;
|
|
2598
|
+
path?: never;
|
|
2599
|
+
cookie?: never;
|
|
2600
|
+
};
|
|
2601
|
+
get?: never;
|
|
2602
|
+
put?: never;
|
|
2603
|
+
post?: never;
|
|
2604
|
+
/**
|
|
2605
|
+
* Delete an MCP resource indicator
|
|
2606
|
+
* @description Removes an MCP resource indicator from an environment. Any application consents granted against it are removed too.
|
|
2607
|
+
*/
|
|
2608
|
+
delete: operations["AuthkitOauthResourcesController_delete"];
|
|
2609
|
+
options?: never;
|
|
2610
|
+
head?: never;
|
|
2611
|
+
patch?: never;
|
|
2612
|
+
trace?: never;
|
|
2613
|
+
};
|
|
2542
2614
|
"/user_management/authorize": {
|
|
2543
2615
|
parameters: {
|
|
2544
2616
|
query?: never;
|
|
@@ -3419,7 +3491,7 @@ export interface paths {
|
|
|
3419
3491
|
post: operations["DataIntegrationsUserManagementController_createUserDataInstallation"];
|
|
3420
3492
|
/**
|
|
3421
3493
|
* Delete a connected account
|
|
3422
|
-
* @description Disconnects WorkOS's account for the user, including removing any stored access and refresh tokens. The user will need to reauthorize if they want to reconnect.
|
|
3494
|
+
* @description Disconnects WorkOS's account for the user, including removing any stored access and refresh tokens. The user will need to reauthorize if they want to reconnect. Access is not revoked on the provider side, except for the WorkOS OAuth provider, whose underlying AuthKit grant is revoked.
|
|
3423
3495
|
*/
|
|
3424
3496
|
delete: operations["DataIntegrationsUserManagementController_deleteUserDataInstallation"];
|
|
3425
3497
|
options?: never;
|
|
@@ -5268,11 +5340,11 @@ export interface components {
|
|
|
5268
5340
|
*/
|
|
5269
5341
|
provider: string;
|
|
5270
5342
|
/**
|
|
5271
|
-
* @description Who owns the Data Integration. `
|
|
5272
|
-
* @example
|
|
5343
|
+
* @description Who owns the Data Integration. `user` (the default) creates the integration users connect their own accounts to; `organization` creates the root organizations connect to. Ownership is fixed at creation, and one integration of each ownership may exist per provider. Independent of `credentials.type`.
|
|
5344
|
+
* @example user
|
|
5273
5345
|
* @enum {string}
|
|
5274
5346
|
*/
|
|
5275
|
-
ownership?: "
|
|
5347
|
+
ownership?: "user" | "organization";
|
|
5276
5348
|
/**
|
|
5277
5349
|
* @description An optional description of the Data Integration.
|
|
5278
5350
|
* @example Production GitHub app
|
|
@@ -5501,6 +5573,18 @@ export interface components {
|
|
|
5501
5573
|
*/
|
|
5502
5574
|
user_agent?: string;
|
|
5503
5575
|
};
|
|
5576
|
+
CreateAuthkitOauthResourceDto: {
|
|
5577
|
+
/**
|
|
5578
|
+
* @description The resource URI. May be a wildcard pattern with a single `*` in the leftmost hostname label, where enabled for the environment.
|
|
5579
|
+
* @example https://api.example.com
|
|
5580
|
+
*/
|
|
5581
|
+
uri: string;
|
|
5582
|
+
/**
|
|
5583
|
+
* @description Whether the resource being created becomes the environment default, clearing any previous default. Applies at creation only — this API has no update endpoint yet, so changing the default on an existing resource is done from the dashboard. A wildcard pattern cannot be the default.
|
|
5584
|
+
* @example false
|
|
5585
|
+
*/
|
|
5586
|
+
default?: boolean;
|
|
5587
|
+
};
|
|
5504
5588
|
CreateRedirectUriDto: {
|
|
5505
5589
|
/**
|
|
5506
5590
|
* @description The redirect URI to create.
|
|
@@ -5931,7 +6015,7 @@ export interface components {
|
|
|
5931
6015
|
* "dsync.user.created"
|
|
5932
6016
|
* ]
|
|
5933
6017
|
*/
|
|
5934
|
-
events: ("agent.blueprint.created" | "agent.blueprint.deleted" | "agent.blueprint.updated" | "agent.instance.created" | "agent.instance.deleted" | "agent.instance.session.created" | "agent.instance.session.revoked" | "agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "agent.registration.refreshed" | "agent.registration.expired" | "agent.registration.organization.switched" | "agent.registration.revoked" | "authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "radar.challenge_created" | "authentication.radar_risk_detected" | "authentication.reauthentication_succeeded" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
6018
|
+
events: ("agent.blueprint.created" | "agent.blueprint.deleted" | "agent.blueprint.updated" | "agent.instance.created" | "agent.instance.deleted" | "agent.instance.session.created" | "agent.instance.session.revoked" | "agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "agent.registration.refreshed" | "agent.registration.expired" | "agent.registration.organization.switched" | "agent.registration.revoked" | "authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "radar.challenge_created" | "authentication.radar_risk_detected" | "authentication.reauthentication_succeeded" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.account_connection.add_failed" | "pipes.account_connection.connected" | "pipes.account_connection.connection_failed" | "pipes.account_connection.disconnected" | "pipes.account_connection.reauthorization_needed" | "pipes.connected_account.connected" | "pipes.connected_account.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
5935
6019
|
};
|
|
5936
6020
|
UpdateWebhookEndpointDto: {
|
|
5937
6021
|
/**
|
|
@@ -5952,7 +6036,7 @@ export interface components {
|
|
|
5952
6036
|
* "dsync.user.created"
|
|
5953
6037
|
* ]
|
|
5954
6038
|
*/
|
|
5955
|
-
events?: ("agent.blueprint.created" | "agent.blueprint.deleted" | "agent.blueprint.updated" | "agent.instance.created" | "agent.instance.deleted" | "agent.instance.session.created" | "agent.instance.session.revoked" | "agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "agent.registration.refreshed" | "agent.registration.expired" | "agent.registration.organization.switched" | "agent.registration.revoked" | "authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "radar.challenge_created" | "authentication.radar_risk_detected" | "authentication.reauthentication_succeeded" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
6039
|
+
events?: ("agent.blueprint.created" | "agent.blueprint.deleted" | "agent.blueprint.updated" | "agent.instance.created" | "agent.instance.deleted" | "agent.instance.session.created" | "agent.instance.session.revoked" | "agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "agent.registration.refreshed" | "agent.registration.expired" | "agent.registration.organization.switched" | "agent.registration.revoked" | "authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "radar.challenge_created" | "authentication.radar_risk_detected" | "authentication.reauthentication_succeeded" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.account_connection.add_failed" | "pipes.account_connection.connected" | "pipes.account_connection.connection_failed" | "pipes.account_connection.disconnected" | "pipes.account_connection.reauthorization_needed" | "pipes.connected_account.connected" | "pipes.connected_account.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
5956
6040
|
};
|
|
5957
6041
|
WidgetSessionTokenDto: {
|
|
5958
6042
|
/**
|
|
@@ -15229,6 +15313,228 @@ export interface components {
|
|
|
15229
15313
|
* @constant
|
|
15230
15314
|
*/
|
|
15231
15315
|
object: "event";
|
|
15316
|
+
} | {
|
|
15317
|
+
/**
|
|
15318
|
+
* @description Unique identifier for the event.
|
|
15319
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15320
|
+
*/
|
|
15321
|
+
id: string;
|
|
15322
|
+
/** @constant */
|
|
15323
|
+
event: "pipes.account_connection.add_failed";
|
|
15324
|
+
/**
|
|
15325
|
+
* PipesConnectionFailed
|
|
15326
|
+
* @description The event payload.
|
|
15327
|
+
*/
|
|
15328
|
+
data: {
|
|
15329
|
+
/**
|
|
15330
|
+
* @description The object type.
|
|
15331
|
+
* @example connection_failed
|
|
15332
|
+
* @constant
|
|
15333
|
+
*/
|
|
15334
|
+
object: "connection_failed";
|
|
15335
|
+
/**
|
|
15336
|
+
* @description The unique ID of the data integration.
|
|
15337
|
+
* @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15338
|
+
*/
|
|
15339
|
+
data_integration_id: string;
|
|
15340
|
+
/**
|
|
15341
|
+
* @description The provider slug for this connection attempt.
|
|
15342
|
+
* @example github
|
|
15343
|
+
*/
|
|
15344
|
+
provider_slug: string;
|
|
15345
|
+
/**
|
|
15346
|
+
* @description The ID of the User the connection attempt belongs to.
|
|
15347
|
+
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15348
|
+
*/
|
|
15349
|
+
user_id: string | null;
|
|
15350
|
+
/**
|
|
15351
|
+
* @description The ID of the Organization the connection attempt belongs to.
|
|
15352
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
15353
|
+
*/
|
|
15354
|
+
organization_id: string | null;
|
|
15355
|
+
/**
|
|
15356
|
+
* @description A machine-readable error code for the failure.
|
|
15357
|
+
* @example authorization_code_exchange_error
|
|
15358
|
+
*/
|
|
15359
|
+
error_code: string;
|
|
15360
|
+
/**
|
|
15361
|
+
* @description A human-readable explanation of the failure.
|
|
15362
|
+
* @example The authorization code has expired.
|
|
15363
|
+
*/
|
|
15364
|
+
error_reason: string | null;
|
|
15365
|
+
/**
|
|
15366
|
+
* @description The raw error code returned by the OAuth provider.
|
|
15367
|
+
* @example access_denied
|
|
15368
|
+
*/
|
|
15369
|
+
provider_error: string | null;
|
|
15370
|
+
/**
|
|
15371
|
+
* @description The raw error description returned by the OAuth provider.
|
|
15372
|
+
* @example The user denied the authorization request.
|
|
15373
|
+
*/
|
|
15374
|
+
provider_error_description: string | null;
|
|
15375
|
+
/**
|
|
15376
|
+
* Format: date-time
|
|
15377
|
+
* @description An ISO 8601 timestamp.
|
|
15378
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15379
|
+
*/
|
|
15380
|
+
created_at: string;
|
|
15381
|
+
};
|
|
15382
|
+
/**
|
|
15383
|
+
* Format: date-time
|
|
15384
|
+
* @description An ISO 8601 timestamp.
|
|
15385
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15386
|
+
*/
|
|
15387
|
+
created_at: string;
|
|
15388
|
+
context?: components["schemas"]["EventContextDto"];
|
|
15389
|
+
/**
|
|
15390
|
+
* @description Distinguishes the Event object.
|
|
15391
|
+
* @constant
|
|
15392
|
+
*/
|
|
15393
|
+
object: "event";
|
|
15394
|
+
} | {
|
|
15395
|
+
/**
|
|
15396
|
+
* @description Unique identifier for the event.
|
|
15397
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15398
|
+
*/
|
|
15399
|
+
id: string;
|
|
15400
|
+
/** @constant */
|
|
15401
|
+
event: "pipes.account_connection.connected";
|
|
15402
|
+
/** @description The event payload. */
|
|
15403
|
+
data: components["schemas"]["PipesConnectedAccount"];
|
|
15404
|
+
/**
|
|
15405
|
+
* Format: date-time
|
|
15406
|
+
* @description An ISO 8601 timestamp.
|
|
15407
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15408
|
+
*/
|
|
15409
|
+
created_at: string;
|
|
15410
|
+
context?: components["schemas"]["EventContextDto"];
|
|
15411
|
+
/**
|
|
15412
|
+
* @description Distinguishes the Event object.
|
|
15413
|
+
* @constant
|
|
15414
|
+
*/
|
|
15415
|
+
object: "event";
|
|
15416
|
+
} | {
|
|
15417
|
+
/**
|
|
15418
|
+
* @description Unique identifier for the event.
|
|
15419
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15420
|
+
*/
|
|
15421
|
+
id: string;
|
|
15422
|
+
/** @constant */
|
|
15423
|
+
event: "pipes.account_connection.connection_failed";
|
|
15424
|
+
/**
|
|
15425
|
+
* PipesConnectionFailed
|
|
15426
|
+
* @description The event payload.
|
|
15427
|
+
*/
|
|
15428
|
+
data: {
|
|
15429
|
+
/**
|
|
15430
|
+
* @description The object type.
|
|
15431
|
+
* @example connection_failed
|
|
15432
|
+
* @constant
|
|
15433
|
+
*/
|
|
15434
|
+
object: "connection_failed";
|
|
15435
|
+
/**
|
|
15436
|
+
* @description The unique ID of the data integration.
|
|
15437
|
+
* @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15438
|
+
*/
|
|
15439
|
+
data_integration_id: string;
|
|
15440
|
+
/**
|
|
15441
|
+
* @description The provider slug for this connection attempt.
|
|
15442
|
+
* @example github
|
|
15443
|
+
*/
|
|
15444
|
+
provider_slug: string;
|
|
15445
|
+
/**
|
|
15446
|
+
* @description The ID of the User the connection attempt belongs to.
|
|
15447
|
+
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15448
|
+
*/
|
|
15449
|
+
user_id: string | null;
|
|
15450
|
+
/**
|
|
15451
|
+
* @description The ID of the Organization the connection attempt belongs to.
|
|
15452
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
15453
|
+
*/
|
|
15454
|
+
organization_id: string | null;
|
|
15455
|
+
/**
|
|
15456
|
+
* @description A machine-readable error code for the failure.
|
|
15457
|
+
* @example authorization_code_exchange_error
|
|
15458
|
+
*/
|
|
15459
|
+
error_code: string;
|
|
15460
|
+
/**
|
|
15461
|
+
* @description A human-readable explanation of the failure.
|
|
15462
|
+
* @example The authorization code has expired.
|
|
15463
|
+
*/
|
|
15464
|
+
error_reason: string | null;
|
|
15465
|
+
/**
|
|
15466
|
+
* @description The raw error code returned by the OAuth provider.
|
|
15467
|
+
* @example access_denied
|
|
15468
|
+
*/
|
|
15469
|
+
provider_error: string | null;
|
|
15470
|
+
/**
|
|
15471
|
+
* @description The raw error description returned by the OAuth provider.
|
|
15472
|
+
* @example The user denied the authorization request.
|
|
15473
|
+
*/
|
|
15474
|
+
provider_error_description: string | null;
|
|
15475
|
+
/**
|
|
15476
|
+
* Format: date-time
|
|
15477
|
+
* @description An ISO 8601 timestamp.
|
|
15478
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15479
|
+
*/
|
|
15480
|
+
created_at: string;
|
|
15481
|
+
};
|
|
15482
|
+
/**
|
|
15483
|
+
* Format: date-time
|
|
15484
|
+
* @description An ISO 8601 timestamp.
|
|
15485
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15486
|
+
*/
|
|
15487
|
+
created_at: string;
|
|
15488
|
+
context?: components["schemas"]["EventContextDto"];
|
|
15489
|
+
/**
|
|
15490
|
+
* @description Distinguishes the Event object.
|
|
15491
|
+
* @constant
|
|
15492
|
+
*/
|
|
15493
|
+
object: "event";
|
|
15494
|
+
} | {
|
|
15495
|
+
/**
|
|
15496
|
+
* @description Unique identifier for the event.
|
|
15497
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15498
|
+
*/
|
|
15499
|
+
id: string;
|
|
15500
|
+
/** @constant */
|
|
15501
|
+
event: "pipes.account_connection.disconnected";
|
|
15502
|
+
/** @description The event payload. */
|
|
15503
|
+
data: components["schemas"]["PipesConnectedAccount"];
|
|
15504
|
+
/**
|
|
15505
|
+
* Format: date-time
|
|
15506
|
+
* @description An ISO 8601 timestamp.
|
|
15507
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15508
|
+
*/
|
|
15509
|
+
created_at: string;
|
|
15510
|
+
context?: components["schemas"]["EventContextDto"];
|
|
15511
|
+
/**
|
|
15512
|
+
* @description Distinguishes the Event object.
|
|
15513
|
+
* @constant
|
|
15514
|
+
*/
|
|
15515
|
+
object: "event";
|
|
15516
|
+
} | {
|
|
15517
|
+
/**
|
|
15518
|
+
* @description Unique identifier for the event.
|
|
15519
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15520
|
+
*/
|
|
15521
|
+
id: string;
|
|
15522
|
+
/** @constant */
|
|
15523
|
+
event: "pipes.account_connection.reauthorization_needed";
|
|
15524
|
+
/** @description The event payload. */
|
|
15525
|
+
data: components["schemas"]["PipesConnectedAccount"];
|
|
15526
|
+
/**
|
|
15527
|
+
* Format: date-time
|
|
15528
|
+
* @description An ISO 8601 timestamp.
|
|
15529
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15530
|
+
*/
|
|
15531
|
+
created_at: string;
|
|
15532
|
+
context?: components["schemas"]["EventContextDto"];
|
|
15533
|
+
/**
|
|
15534
|
+
* @description Distinguishes the Event object.
|
|
15535
|
+
* @constant
|
|
15536
|
+
*/
|
|
15537
|
+
object: "event";
|
|
15232
15538
|
} | {
|
|
15233
15539
|
/**
|
|
15234
15540
|
* @description Unique identifier for the event.
|
|
@@ -17343,11 +17649,11 @@ export interface components {
|
|
|
17343
17649
|
*/
|
|
17344
17650
|
integration_type: string;
|
|
17345
17651
|
/**
|
|
17346
|
-
* @description Who owns the Data Integration: `
|
|
17347
|
-
* @example
|
|
17652
|
+
* @description Who owns the Data Integration: `user` when users connect their own accounts, `organization` when organizations connect. Fixed at creation.
|
|
17653
|
+
* @example user
|
|
17348
17654
|
* @enum {string}
|
|
17349
17655
|
*/
|
|
17350
|
-
ownership: "
|
|
17656
|
+
ownership: "user" | "organization";
|
|
17351
17657
|
/**
|
|
17352
17658
|
* @description An optional description of the Data Integration.
|
|
17353
17659
|
* @example Production GitHub app
|
|
@@ -17926,7 +18232,7 @@ export interface components {
|
|
|
17926
18232
|
* @description Use updated_at instead.
|
|
17927
18233
|
*/
|
|
17928
18234
|
updatedAt: string;
|
|
17929
|
-
/** @description The user's [connected account](/reference/pipes/connected-account) for this provider, or `null`
|
|
18235
|
+
/** @description The user's compatibility [connected account](/reference/pipes/connected-account) for this provider, or `null` when the compatibility slot is empty. This legacy field never selects a standard connection. */
|
|
17930
18236
|
connected_account: {
|
|
17931
18237
|
/**
|
|
17932
18238
|
* @description Distinguishes the connected account object.
|
|
@@ -18026,7 +18332,7 @@ export interface components {
|
|
|
18026
18332
|
*/
|
|
18027
18333
|
updatedAt: string;
|
|
18028
18334
|
} | null;
|
|
18029
|
-
/** @description The user's connected accounts for this provider in the requested ownership context. */
|
|
18335
|
+
/** @description The user's connected accounts for this provider in the requested ownership context. This contains only the compatibility connection unless `supports_multiple_connections` is `true`. */
|
|
18030
18336
|
connected_accounts: {
|
|
18031
18337
|
/**
|
|
18032
18338
|
* @description Distinguishes the connected account object.
|
|
@@ -18237,6 +18543,38 @@ export interface components {
|
|
|
18237
18543
|
*/
|
|
18238
18544
|
message: string;
|
|
18239
18545
|
};
|
|
18546
|
+
AuthkitOauthResource: {
|
|
18547
|
+
/**
|
|
18548
|
+
* @description The object type.
|
|
18549
|
+
* @constant
|
|
18550
|
+
*/
|
|
18551
|
+
object: "authkit_oauth_resource";
|
|
18552
|
+
/**
|
|
18553
|
+
* @description The ID of the MCP resource indicator.
|
|
18554
|
+
* @example authkit_oauth_resource_01EHZNVPK3SFK441A1RGBFSHRT
|
|
18555
|
+
*/
|
|
18556
|
+
id: string;
|
|
18557
|
+
/**
|
|
18558
|
+
* @description The resource URI.
|
|
18559
|
+
* @example https://api.example.com
|
|
18560
|
+
*/
|
|
18561
|
+
uri: string;
|
|
18562
|
+
/**
|
|
18563
|
+
* @description Whether this is the default MCP resource indicator for the environment.
|
|
18564
|
+
* @example false
|
|
18565
|
+
*/
|
|
18566
|
+
default: boolean;
|
|
18567
|
+
/**
|
|
18568
|
+
* @description The timestamp when the MCP resource indicator was created.
|
|
18569
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
18570
|
+
*/
|
|
18571
|
+
created_at: string;
|
|
18572
|
+
/**
|
|
18573
|
+
* @description The timestamp when the MCP resource indicator was last updated.
|
|
18574
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
18575
|
+
*/
|
|
18576
|
+
updated_at: string;
|
|
18577
|
+
};
|
|
18240
18578
|
RedirectUri: {
|
|
18241
18579
|
/**
|
|
18242
18580
|
* @description The object type.
|
|
@@ -20920,6 +21258,8 @@ export interface operations {
|
|
|
20920
21258
|
limit?: number;
|
|
20921
21259
|
/** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to `normal`. */
|
|
20922
21260
|
order?: components["schemas"]["PaginationOrder"];
|
|
21261
|
+
/** @description Only return sessions of instances acting within this organization. */
|
|
21262
|
+
organization_id?: string;
|
|
20923
21263
|
/** @description Only return sessions of instances minted from this blueprint. */
|
|
20924
21264
|
agent_blueprint_id?: string;
|
|
20925
21265
|
/** @description Only return sessions belonging to this agent instance. */
|
|
@@ -28519,6 +28859,8 @@ export interface operations {
|
|
|
28519
28859
|
limit?: number;
|
|
28520
28860
|
/** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to `normal`. */
|
|
28521
28861
|
order?: components["schemas"]["PaginationOrder"];
|
|
28862
|
+
/** @description Only return Data Integrations with this ownership: `user` for the integrations users connect their own accounts to, or `organization` for the roots organizations connect to. Omit to return both. */
|
|
28863
|
+
ownership?: "user" | "organization";
|
|
28522
28864
|
};
|
|
28523
28865
|
header?: never;
|
|
28524
28866
|
path?: never;
|
|
@@ -28542,6 +28884,36 @@ export interface operations {
|
|
|
28542
28884
|
};
|
|
28543
28885
|
content?: never;
|
|
28544
28886
|
};
|
|
28887
|
+
/** @description Organization-owned data integrations are not available for this environment. */
|
|
28888
|
+
404: {
|
|
28889
|
+
headers: {
|
|
28890
|
+
[name: string]: unknown;
|
|
28891
|
+
};
|
|
28892
|
+
content: {
|
|
28893
|
+
"application/json": {
|
|
28894
|
+
/**
|
|
28895
|
+
* @description A human-readable description of the error.
|
|
28896
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
28897
|
+
*/
|
|
28898
|
+
message: string;
|
|
28899
|
+
};
|
|
28900
|
+
};
|
|
28901
|
+
};
|
|
28902
|
+
/** @description Unprocessable Entity */
|
|
28903
|
+
422: {
|
|
28904
|
+
headers: {
|
|
28905
|
+
[name: string]: unknown;
|
|
28906
|
+
};
|
|
28907
|
+
content: {
|
|
28908
|
+
"application/json": {
|
|
28909
|
+
/**
|
|
28910
|
+
* @description A human-readable description of the error.
|
|
28911
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
28912
|
+
*/
|
|
28913
|
+
message: string;
|
|
28914
|
+
};
|
|
28915
|
+
};
|
|
28916
|
+
};
|
|
28545
28917
|
};
|
|
28546
28918
|
};
|
|
28547
28919
|
DataIntegrationsManagementController_createDataIntegration: {
|
|
@@ -29275,6 +29647,11 @@ export interface operations {
|
|
|
29275
29647
|
* @enum {string}
|
|
29276
29648
|
*/
|
|
29277
29649
|
connection_owner?: "user" | "organization";
|
|
29650
|
+
/**
|
|
29651
|
+
* @description Set to `true` to use the plural connection contract. If no `connected_account_id` is supplied and several connections match, the request returns `account_selection_required`. When omitted or `false`, only the compatibility connection is considered.
|
|
29652
|
+
* @example true
|
|
29653
|
+
*/
|
|
29654
|
+
supports_multiple_connections?: boolean;
|
|
29278
29655
|
};
|
|
29279
29656
|
};
|
|
29280
29657
|
};
|
|
@@ -29382,6 +29759,294 @@ export interface operations {
|
|
|
29382
29759
|
};
|
|
29383
29760
|
};
|
|
29384
29761
|
};
|
|
29762
|
+
DataIntegrationsManagementController_getOrganizationDataIntegration: {
|
|
29763
|
+
parameters: {
|
|
29764
|
+
query?: never;
|
|
29765
|
+
header?: never;
|
|
29766
|
+
path: {
|
|
29767
|
+
/** @description The slug identifier of the data integration. */
|
|
29768
|
+
slug: string;
|
|
29769
|
+
};
|
|
29770
|
+
cookie?: never;
|
|
29771
|
+
};
|
|
29772
|
+
requestBody?: never;
|
|
29773
|
+
responses: {
|
|
29774
|
+
/** @description OK */
|
|
29775
|
+
200: {
|
|
29776
|
+
headers: {
|
|
29777
|
+
[name: string]: unknown;
|
|
29778
|
+
};
|
|
29779
|
+
content: {
|
|
29780
|
+
/**
|
|
29781
|
+
* @example {
|
|
29782
|
+
* "object": "data_integration",
|
|
29783
|
+
* "id": "data_integration_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
29784
|
+
* "slug": "github",
|
|
29785
|
+
* "integration_type": "github",
|
|
29786
|
+
* "ownership": "organization",
|
|
29787
|
+
* "description": "Production GitHub app",
|
|
29788
|
+
* "enabled": true,
|
|
29789
|
+
* "state": "valid",
|
|
29790
|
+
* "scopes": [
|
|
29791
|
+
* "repo",
|
|
29792
|
+
* "read:org"
|
|
29793
|
+
* ],
|
|
29794
|
+
* "redirect_uri": "https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback",
|
|
29795
|
+
* "auth_methods": [
|
|
29796
|
+
* "oauth"
|
|
29797
|
+
* ],
|
|
29798
|
+
* "credentials": {
|
|
29799
|
+
* "type": "custom",
|
|
29800
|
+
* "client_id": "Iv1.abc123",
|
|
29801
|
+
* "redacted_client_secret": "6789"
|
|
29802
|
+
* },
|
|
29803
|
+
* "installation": null,
|
|
29804
|
+
* "config": {
|
|
29805
|
+
* "account": "myorg-myaccount"
|
|
29806
|
+
* },
|
|
29807
|
+
* "custom_provider": {
|
|
29808
|
+
* "name": "My OAuth App",
|
|
29809
|
+
* "authorization_url": "https://provider.example.com/oauth/authorize",
|
|
29810
|
+
* "token_url": "https://provider.example.com/oauth/token",
|
|
29811
|
+
* "refresh_token_url": "https://provider.example.com/oauth/token",
|
|
29812
|
+
* "pkce_enabled": true,
|
|
29813
|
+
* "request_scope_separator": " ",
|
|
29814
|
+
* "scopes_required": false,
|
|
29815
|
+
* "client_secret_required": true,
|
|
29816
|
+
* "additional_authorization_parameters": {
|
|
29817
|
+
* "prompt": "consent"
|
|
29818
|
+
* },
|
|
29819
|
+
* "token_body_content_type": "application/x-www-form-urlencoded",
|
|
29820
|
+
* "authenticate_via": "request_body"
|
|
29821
|
+
* },
|
|
29822
|
+
* "created_at": "2026-01-15T12:00:00.000Z",
|
|
29823
|
+
* "updated_at": "2026-01-15T12:00:00.000Z"
|
|
29824
|
+
* }
|
|
29825
|
+
*/
|
|
29826
|
+
"application/json": components["schemas"]["DataIntegration"];
|
|
29827
|
+
};
|
|
29828
|
+
};
|
|
29829
|
+
/** @description Unauthorized */
|
|
29830
|
+
401: {
|
|
29831
|
+
headers: {
|
|
29832
|
+
[name: string]: unknown;
|
|
29833
|
+
};
|
|
29834
|
+
content?: never;
|
|
29835
|
+
};
|
|
29836
|
+
/** @description Not Found */
|
|
29837
|
+
404: {
|
|
29838
|
+
headers: {
|
|
29839
|
+
[name: string]: unknown;
|
|
29840
|
+
};
|
|
29841
|
+
content: {
|
|
29842
|
+
"application/json": {
|
|
29843
|
+
/**
|
|
29844
|
+
* @description A human-readable description of the error.
|
|
29845
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
29846
|
+
*/
|
|
29847
|
+
message: string;
|
|
29848
|
+
};
|
|
29849
|
+
};
|
|
29850
|
+
};
|
|
29851
|
+
};
|
|
29852
|
+
};
|
|
29853
|
+
DataIntegrationsManagementController_updateOrganizationDataIntegration: {
|
|
29854
|
+
parameters: {
|
|
29855
|
+
query?: never;
|
|
29856
|
+
header?: never;
|
|
29857
|
+
path: {
|
|
29858
|
+
/** @description The slug identifier of the data integration. */
|
|
29859
|
+
slug: string;
|
|
29860
|
+
};
|
|
29861
|
+
cookie?: never;
|
|
29862
|
+
};
|
|
29863
|
+
requestBody: {
|
|
29864
|
+
content: {
|
|
29865
|
+
"application/json": components["schemas"]["UpdateDataIntegrationDto"];
|
|
29866
|
+
};
|
|
29867
|
+
};
|
|
29868
|
+
responses: {
|
|
29869
|
+
/** @description OK */
|
|
29870
|
+
200: {
|
|
29871
|
+
headers: {
|
|
29872
|
+
[name: string]: unknown;
|
|
29873
|
+
};
|
|
29874
|
+
content: {
|
|
29875
|
+
/**
|
|
29876
|
+
* @example {
|
|
29877
|
+
* "object": "data_integration",
|
|
29878
|
+
* "id": "data_integration_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
29879
|
+
* "slug": "github",
|
|
29880
|
+
* "integration_type": "github",
|
|
29881
|
+
* "ownership": "organization",
|
|
29882
|
+
* "description": "Production GitHub app",
|
|
29883
|
+
* "enabled": true,
|
|
29884
|
+
* "state": "valid",
|
|
29885
|
+
* "scopes": [
|
|
29886
|
+
* "repo",
|
|
29887
|
+
* "read:org"
|
|
29888
|
+
* ],
|
|
29889
|
+
* "redirect_uri": "https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback",
|
|
29890
|
+
* "auth_methods": [
|
|
29891
|
+
* "oauth"
|
|
29892
|
+
* ],
|
|
29893
|
+
* "credentials": {
|
|
29894
|
+
* "type": "custom",
|
|
29895
|
+
* "client_id": "Iv1.abc123",
|
|
29896
|
+
* "redacted_client_secret": "6789"
|
|
29897
|
+
* },
|
|
29898
|
+
* "installation": null,
|
|
29899
|
+
* "config": {
|
|
29900
|
+
* "account": "myorg-myaccount"
|
|
29901
|
+
* },
|
|
29902
|
+
* "custom_provider": {
|
|
29903
|
+
* "name": "My OAuth App",
|
|
29904
|
+
* "authorization_url": "https://provider.example.com/oauth/authorize",
|
|
29905
|
+
* "token_url": "https://provider.example.com/oauth/token",
|
|
29906
|
+
* "refresh_token_url": "https://provider.example.com/oauth/token",
|
|
29907
|
+
* "pkce_enabled": true,
|
|
29908
|
+
* "request_scope_separator": " ",
|
|
29909
|
+
* "scopes_required": false,
|
|
29910
|
+
* "client_secret_required": true,
|
|
29911
|
+
* "additional_authorization_parameters": {
|
|
29912
|
+
* "prompt": "consent"
|
|
29913
|
+
* },
|
|
29914
|
+
* "token_body_content_type": "application/x-www-form-urlencoded",
|
|
29915
|
+
* "authenticate_via": "request_body"
|
|
29916
|
+
* },
|
|
29917
|
+
* "created_at": "2026-01-15T12:00:00.000Z",
|
|
29918
|
+
* "updated_at": "2026-01-15T12:00:00.000Z"
|
|
29919
|
+
* }
|
|
29920
|
+
*/
|
|
29921
|
+
"application/json": components["schemas"]["DataIntegration"];
|
|
29922
|
+
};
|
|
29923
|
+
};
|
|
29924
|
+
/** @description Bad Request */
|
|
29925
|
+
400: {
|
|
29926
|
+
headers: {
|
|
29927
|
+
[name: string]: unknown;
|
|
29928
|
+
};
|
|
29929
|
+
content: {
|
|
29930
|
+
"application/json": {
|
|
29931
|
+
/**
|
|
29932
|
+
* @description A human-readable description of the error.
|
|
29933
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
29934
|
+
*/
|
|
29935
|
+
message: string;
|
|
29936
|
+
};
|
|
29937
|
+
};
|
|
29938
|
+
};
|
|
29939
|
+
/** @description Unauthorized */
|
|
29940
|
+
401: {
|
|
29941
|
+
headers: {
|
|
29942
|
+
[name: string]: unknown;
|
|
29943
|
+
};
|
|
29944
|
+
content?: never;
|
|
29945
|
+
};
|
|
29946
|
+
/** @description Forbidden */
|
|
29947
|
+
403: {
|
|
29948
|
+
headers: {
|
|
29949
|
+
[name: string]: unknown;
|
|
29950
|
+
};
|
|
29951
|
+
content: {
|
|
29952
|
+
"application/json": {
|
|
29953
|
+
/**
|
|
29954
|
+
* @description A human-readable description of the error.
|
|
29955
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
29956
|
+
*/
|
|
29957
|
+
message: string;
|
|
29958
|
+
};
|
|
29959
|
+
};
|
|
29960
|
+
};
|
|
29961
|
+
/** @description Not Found */
|
|
29962
|
+
404: {
|
|
29963
|
+
headers: {
|
|
29964
|
+
[name: string]: unknown;
|
|
29965
|
+
};
|
|
29966
|
+
content: {
|
|
29967
|
+
"application/json": {
|
|
29968
|
+
/**
|
|
29969
|
+
* @description A human-readable description of the error.
|
|
29970
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
29971
|
+
*/
|
|
29972
|
+
message: string;
|
|
29973
|
+
};
|
|
29974
|
+
};
|
|
29975
|
+
};
|
|
29976
|
+
409: {
|
|
29977
|
+
headers: {
|
|
29978
|
+
[name: string]: unknown;
|
|
29979
|
+
};
|
|
29980
|
+
content: {
|
|
29981
|
+
"application/json": {
|
|
29982
|
+
/**
|
|
29983
|
+
* @description A human-readable description of the error.
|
|
29984
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
29985
|
+
*/
|
|
29986
|
+
message: string;
|
|
29987
|
+
};
|
|
29988
|
+
};
|
|
29989
|
+
};
|
|
29990
|
+
/** @description Unprocessable Entity */
|
|
29991
|
+
422: {
|
|
29992
|
+
headers: {
|
|
29993
|
+
[name: string]: unknown;
|
|
29994
|
+
};
|
|
29995
|
+
content: {
|
|
29996
|
+
"application/json": {
|
|
29997
|
+
/**
|
|
29998
|
+
* @description A human-readable description of the error.
|
|
29999
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
30000
|
+
*/
|
|
30001
|
+
message: string;
|
|
30002
|
+
};
|
|
30003
|
+
};
|
|
30004
|
+
};
|
|
30005
|
+
};
|
|
30006
|
+
};
|
|
30007
|
+
DataIntegrationsManagementController_deleteOrganizationDataIntegration: {
|
|
30008
|
+
parameters: {
|
|
30009
|
+
query?: never;
|
|
30010
|
+
header?: never;
|
|
30011
|
+
path: {
|
|
30012
|
+
/** @description The slug identifier of the data integration. */
|
|
30013
|
+
slug: string;
|
|
30014
|
+
};
|
|
30015
|
+
cookie?: never;
|
|
30016
|
+
};
|
|
30017
|
+
requestBody?: never;
|
|
30018
|
+
responses: {
|
|
30019
|
+
/** @description No Content */
|
|
30020
|
+
204: {
|
|
30021
|
+
headers: {
|
|
30022
|
+
[name: string]: unknown;
|
|
30023
|
+
};
|
|
30024
|
+
content?: never;
|
|
30025
|
+
};
|
|
30026
|
+
/** @description Unauthorized */
|
|
30027
|
+
401: {
|
|
30028
|
+
headers: {
|
|
30029
|
+
[name: string]: unknown;
|
|
30030
|
+
};
|
|
30031
|
+
content?: never;
|
|
30032
|
+
};
|
|
30033
|
+
/** @description Not Found */
|
|
30034
|
+
404: {
|
|
30035
|
+
headers: {
|
|
30036
|
+
[name: string]: unknown;
|
|
30037
|
+
};
|
|
30038
|
+
content: {
|
|
30039
|
+
"application/json": {
|
|
30040
|
+
/**
|
|
30041
|
+
* @description A human-readable description of the error.
|
|
30042
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
30043
|
+
*/
|
|
30044
|
+
message: string;
|
|
30045
|
+
};
|
|
30046
|
+
};
|
|
30047
|
+
};
|
|
30048
|
+
};
|
|
30049
|
+
};
|
|
29385
30050
|
DataIntegrationsController_getUserlandUserToken: {
|
|
29386
30051
|
parameters: {
|
|
29387
30052
|
query?: never;
|
|
@@ -29416,6 +30081,11 @@ export interface operations {
|
|
|
29416
30081
|
* @enum {string}
|
|
29417
30082
|
*/
|
|
29418
30083
|
connection_owner?: "user" | "organization";
|
|
30084
|
+
/**
|
|
30085
|
+
* @description Set to `true` to use the plural connection contract. If no `connected_account_id` is supplied and several connections match, the request returns `account_selection_required`. When omitted or `false`, only the compatibility connection is considered.
|
|
30086
|
+
* @example true
|
|
30087
|
+
*/
|
|
30088
|
+
supports_multiple_connections?: boolean;
|
|
29419
30089
|
};
|
|
29420
30090
|
};
|
|
29421
30091
|
};
|
|
@@ -34659,6 +35329,212 @@ export interface operations {
|
|
|
34659
35329
|
};
|
|
34660
35330
|
};
|
|
34661
35331
|
};
|
|
35332
|
+
AuthkitOauthResourcesController_list: {
|
|
35333
|
+
parameters: {
|
|
35334
|
+
query?: {
|
|
35335
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`. */
|
|
35336
|
+
before?: string;
|
|
35337
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`. */
|
|
35338
|
+
after?: string;
|
|
35339
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
35340
|
+
limit?: number;
|
|
35341
|
+
/** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to `normal`. */
|
|
35342
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
35343
|
+
};
|
|
35344
|
+
header?: never;
|
|
35345
|
+
path?: never;
|
|
35346
|
+
cookie?: never;
|
|
35347
|
+
};
|
|
35348
|
+
requestBody?: never;
|
|
35349
|
+
responses: {
|
|
35350
|
+
/** @description MCP resource indicators listed successfully. */
|
|
35351
|
+
200: {
|
|
35352
|
+
headers: {
|
|
35353
|
+
[name: string]: unknown;
|
|
35354
|
+
};
|
|
35355
|
+
content: {
|
|
35356
|
+
"application/json": {
|
|
35357
|
+
/**
|
|
35358
|
+
* @description Indicates this is a list response.
|
|
35359
|
+
* @constant
|
|
35360
|
+
*/
|
|
35361
|
+
object?: "list";
|
|
35362
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
35363
|
+
list_metadata?: {
|
|
35364
|
+
/**
|
|
35365
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
|
|
35366
|
+
* @example authkit_oauth_resource_01HXYZ123456789ABCDEFGHIJ
|
|
35367
|
+
*/
|
|
35368
|
+
before: string | null;
|
|
35369
|
+
/**
|
|
35370
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
|
|
35371
|
+
* @example authkit_oauth_resource_01HXYZ987654321KJIHGFEDCBA
|
|
35372
|
+
*/
|
|
35373
|
+
after: string | null;
|
|
35374
|
+
};
|
|
35375
|
+
} & {
|
|
35376
|
+
/** @description The list of records for the current page. */
|
|
35377
|
+
data?: components["schemas"]["AuthkitOauthResource"][];
|
|
35378
|
+
};
|
|
35379
|
+
};
|
|
35380
|
+
};
|
|
35381
|
+
/** @description Unauthorized */
|
|
35382
|
+
401: {
|
|
35383
|
+
headers: {
|
|
35384
|
+
[name: string]: unknown;
|
|
35385
|
+
};
|
|
35386
|
+
content: {
|
|
35387
|
+
/**
|
|
35388
|
+
* @example {
|
|
35389
|
+
* "message": "Unauthorized"
|
|
35390
|
+
* }
|
|
35391
|
+
*/
|
|
35392
|
+
"application/json": {
|
|
35393
|
+
/**
|
|
35394
|
+
* @description A human-readable description of the error.
|
|
35395
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
35396
|
+
*/
|
|
35397
|
+
message: string;
|
|
35398
|
+
};
|
|
35399
|
+
};
|
|
35400
|
+
};
|
|
35401
|
+
};
|
|
35402
|
+
};
|
|
35403
|
+
AuthkitOauthResourcesController_create: {
|
|
35404
|
+
parameters: {
|
|
35405
|
+
query?: never;
|
|
35406
|
+
header?: never;
|
|
35407
|
+
path?: never;
|
|
35408
|
+
cookie?: never;
|
|
35409
|
+
};
|
|
35410
|
+
requestBody: {
|
|
35411
|
+
content: {
|
|
35412
|
+
"application/json": components["schemas"]["CreateAuthkitOauthResourceDto"];
|
|
35413
|
+
};
|
|
35414
|
+
};
|
|
35415
|
+
responses: {
|
|
35416
|
+
/** @description MCP resource indicator created successfully. */
|
|
35417
|
+
201: {
|
|
35418
|
+
headers: {
|
|
35419
|
+
[name: string]: unknown;
|
|
35420
|
+
};
|
|
35421
|
+
content: {
|
|
35422
|
+
/**
|
|
35423
|
+
* @example {
|
|
35424
|
+
* "object": "authkit_oauth_resource",
|
|
35425
|
+
* "id": "authkit_oauth_resource_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
35426
|
+
* "uri": "https://api.example.com",
|
|
35427
|
+
* "default": false,
|
|
35428
|
+
* "created_at": "2026-01-15T12:00:00.000Z",
|
|
35429
|
+
* "updated_at": "2026-01-15T12:00:00.000Z"
|
|
35430
|
+
* }
|
|
35431
|
+
*/
|
|
35432
|
+
"application/json": components["schemas"]["AuthkitOauthResource"];
|
|
35433
|
+
};
|
|
35434
|
+
};
|
|
35435
|
+
/** @description Unauthorized */
|
|
35436
|
+
401: {
|
|
35437
|
+
headers: {
|
|
35438
|
+
[name: string]: unknown;
|
|
35439
|
+
};
|
|
35440
|
+
content: {
|
|
35441
|
+
/**
|
|
35442
|
+
* @example {
|
|
35443
|
+
* "message": "Unauthorized"
|
|
35444
|
+
* }
|
|
35445
|
+
*/
|
|
35446
|
+
"application/json": {
|
|
35447
|
+
/**
|
|
35448
|
+
* @description A human-readable description of the error.
|
|
35449
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
35450
|
+
*/
|
|
35451
|
+
message: string;
|
|
35452
|
+
};
|
|
35453
|
+
};
|
|
35454
|
+
};
|
|
35455
|
+
/** @description Validation failed. */
|
|
35456
|
+
422: {
|
|
35457
|
+
headers: {
|
|
35458
|
+
[name: string]: unknown;
|
|
35459
|
+
};
|
|
35460
|
+
content: {
|
|
35461
|
+
/**
|
|
35462
|
+
* @example {
|
|
35463
|
+
* "message": "AuthKit OAuth resource 'https://api.example.com' already exists."
|
|
35464
|
+
* }
|
|
35465
|
+
*/
|
|
35466
|
+
"application/json": {
|
|
35467
|
+
/**
|
|
35468
|
+
* @description A human-readable description of the error.
|
|
35469
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
35470
|
+
*/
|
|
35471
|
+
message: string;
|
|
35472
|
+
};
|
|
35473
|
+
};
|
|
35474
|
+
};
|
|
35475
|
+
};
|
|
35476
|
+
};
|
|
35477
|
+
AuthkitOauthResourcesController_delete: {
|
|
35478
|
+
parameters: {
|
|
35479
|
+
query?: never;
|
|
35480
|
+
header?: never;
|
|
35481
|
+
path: {
|
|
35482
|
+
/** @description The ID of the MCP resource indicator to delete. */
|
|
35483
|
+
id: string;
|
|
35484
|
+
};
|
|
35485
|
+
cookie?: never;
|
|
35486
|
+
};
|
|
35487
|
+
requestBody?: never;
|
|
35488
|
+
responses: {
|
|
35489
|
+
/** @description MCP resource indicator deleted successfully. */
|
|
35490
|
+
204: {
|
|
35491
|
+
headers: {
|
|
35492
|
+
[name: string]: unknown;
|
|
35493
|
+
};
|
|
35494
|
+
content?: never;
|
|
35495
|
+
};
|
|
35496
|
+
/** @description Unauthorized */
|
|
35497
|
+
401: {
|
|
35498
|
+
headers: {
|
|
35499
|
+
[name: string]: unknown;
|
|
35500
|
+
};
|
|
35501
|
+
content: {
|
|
35502
|
+
/**
|
|
35503
|
+
* @example {
|
|
35504
|
+
* "message": "Unauthorized"
|
|
35505
|
+
* }
|
|
35506
|
+
*/
|
|
35507
|
+
"application/json": {
|
|
35508
|
+
/**
|
|
35509
|
+
* @description A human-readable description of the error.
|
|
35510
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
35511
|
+
*/
|
|
35512
|
+
message: string;
|
|
35513
|
+
};
|
|
35514
|
+
};
|
|
35515
|
+
};
|
|
35516
|
+
/** @description MCP resource indicator not found. */
|
|
35517
|
+
404: {
|
|
35518
|
+
headers: {
|
|
35519
|
+
[name: string]: unknown;
|
|
35520
|
+
};
|
|
35521
|
+
content: {
|
|
35522
|
+
/**
|
|
35523
|
+
* @example {
|
|
35524
|
+
* "message": "AuthKit OAuth resource not found: 'authkit_oauth_resource_01EHZNVPK3SFK441A1RGBFSHRT'."
|
|
35525
|
+
* }
|
|
35526
|
+
*/
|
|
35527
|
+
"application/json": {
|
|
35528
|
+
/**
|
|
35529
|
+
* @description A human-readable description of the error.
|
|
35530
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
35531
|
+
*/
|
|
35532
|
+
message: string;
|
|
35533
|
+
};
|
|
35534
|
+
};
|
|
35535
|
+
};
|
|
35536
|
+
};
|
|
35537
|
+
};
|
|
34662
35538
|
UserlandSsoController_authorize: {
|
|
34663
35539
|
parameters: {
|
|
34664
35540
|
query: {
|
|
@@ -38961,6 +39837,8 @@ export interface operations {
|
|
|
38961
39837
|
query?: {
|
|
38962
39838
|
/** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
38963
39839
|
organization_id?: string;
|
|
39840
|
+
/** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
|
|
39841
|
+
supports_multiple_connections?: boolean;
|
|
38964
39842
|
/** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select a specific connection when the user has several for this provider. */
|
|
38965
39843
|
connected_account_id?: string;
|
|
38966
39844
|
};
|
|
@@ -39037,6 +39915,8 @@ export interface operations {
|
|
|
39037
39915
|
query?: {
|
|
39038
39916
|
/** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
39039
39917
|
organization_id?: string;
|
|
39918
|
+
/** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
|
|
39919
|
+
supports_multiple_connections?: boolean;
|
|
39040
39920
|
/** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to update. */
|
|
39041
39921
|
connected_account_id?: string;
|
|
39042
39922
|
};
|
|
@@ -39110,6 +39990,73 @@ export interface operations {
|
|
|
39110
39990
|
"application/json": components["schemas"]["AccountSelectionRequiredError"];
|
|
39111
39991
|
};
|
|
39112
39992
|
};
|
|
39993
|
+
/** @description The request body is malformed (`invalid_request_parameters`), or `refresh_token` is not an active WorkOS OAuth grant of this user (`invalid_refresh_token`). */
|
|
39994
|
+
422: {
|
|
39995
|
+
headers: {
|
|
39996
|
+
[name: string]: unknown;
|
|
39997
|
+
};
|
|
39998
|
+
content: {
|
|
39999
|
+
"application/json": {
|
|
40000
|
+
/**
|
|
40001
|
+
* @description The error code identifying the type of error.
|
|
40002
|
+
* @example invalid_refresh_token
|
|
40003
|
+
* @constant
|
|
40004
|
+
*/
|
|
40005
|
+
code: "invalid_refresh_token";
|
|
40006
|
+
/**
|
|
40007
|
+
* @description A human-readable description of the error.
|
|
40008
|
+
* @example Request could not be processed.
|
|
40009
|
+
*/
|
|
40010
|
+
message: string;
|
|
40011
|
+
} | {
|
|
40012
|
+
/**
|
|
40013
|
+
* @description The error code identifying the type of error.
|
|
40014
|
+
* @example invalid_request_parameters
|
|
40015
|
+
* @constant
|
|
40016
|
+
*/
|
|
40017
|
+
code: "invalid_request_parameters";
|
|
40018
|
+
/**
|
|
40019
|
+
* @description A human-readable description of the error.
|
|
40020
|
+
* @example Validation failed.
|
|
40021
|
+
*/
|
|
40022
|
+
message: string;
|
|
40023
|
+
/** @description The list of validation errors. */
|
|
40024
|
+
errors: {
|
|
40025
|
+
/**
|
|
40026
|
+
* @description The validation error code.
|
|
40027
|
+
* @example unknown_event_type
|
|
40028
|
+
*/
|
|
40029
|
+
code: string;
|
|
40030
|
+
/**
|
|
40031
|
+
* @description A human-readable description of the validation error.
|
|
40032
|
+
* @example Invalid enum value.
|
|
40033
|
+
*/
|
|
40034
|
+
message: string;
|
|
40035
|
+
}[];
|
|
40036
|
+
};
|
|
40037
|
+
};
|
|
40038
|
+
};
|
|
40039
|
+
/** @description The WorkOS OAuth grant behind `refresh_token` is being changed by another request. Retry the request. */
|
|
40040
|
+
503: {
|
|
40041
|
+
headers: {
|
|
40042
|
+
[name: string]: unknown;
|
|
40043
|
+
};
|
|
40044
|
+
content: {
|
|
40045
|
+
"application/json": {
|
|
40046
|
+
/**
|
|
40047
|
+
* @description The error code identifying the type of error.
|
|
40048
|
+
* @example concurrent_request
|
|
40049
|
+
* @constant
|
|
40050
|
+
*/
|
|
40051
|
+
code: "concurrent_request";
|
|
40052
|
+
/**
|
|
40053
|
+
* @description A human-readable description of the error.
|
|
40054
|
+
* @example Request could not be processed.
|
|
40055
|
+
*/
|
|
40056
|
+
message: string;
|
|
40057
|
+
};
|
|
40058
|
+
};
|
|
40059
|
+
};
|
|
39113
40060
|
};
|
|
39114
40061
|
};
|
|
39115
40062
|
DataIntegrationsUserManagementController_createUserDataInstallation: {
|
|
@@ -39179,16 +40126,68 @@ export interface operations {
|
|
|
39179
40126
|
};
|
|
39180
40127
|
};
|
|
39181
40128
|
};
|
|
39182
|
-
/** @description The data integration is not in a valid state
|
|
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`). */
|
|
39183
40130
|
422: {
|
|
39184
40131
|
headers: {
|
|
39185
40132
|
[name: string]: unknown;
|
|
39186
40133
|
};
|
|
39187
40134
|
content: {
|
|
39188
40135
|
"application/json": {
|
|
40136
|
+
/**
|
|
40137
|
+
* @description The error code identifying the type of error.
|
|
40138
|
+
* @example invalid_refresh_token
|
|
40139
|
+
* @enum {string}
|
|
40140
|
+
*/
|
|
40141
|
+
code: "invalid_refresh_token" | "invalid_token_combination" | "invalid_data_integration_state";
|
|
39189
40142
|
/**
|
|
39190
40143
|
* @description A human-readable description of the error.
|
|
39191
|
-
* @example
|
|
40144
|
+
* @example Request could not be processed.
|
|
40145
|
+
*/
|
|
40146
|
+
message: string;
|
|
40147
|
+
} | {
|
|
40148
|
+
/**
|
|
40149
|
+
* @description The error code identifying the type of error.
|
|
40150
|
+
* @example invalid_request_parameters
|
|
40151
|
+
* @constant
|
|
40152
|
+
*/
|
|
40153
|
+
code: "invalid_request_parameters";
|
|
40154
|
+
/**
|
|
40155
|
+
* @description A human-readable description of the error.
|
|
40156
|
+
* @example Validation failed.
|
|
40157
|
+
*/
|
|
40158
|
+
message: string;
|
|
40159
|
+
/** @description The list of validation errors. */
|
|
40160
|
+
errors: {
|
|
40161
|
+
/**
|
|
40162
|
+
* @description The validation error code.
|
|
40163
|
+
* @example unknown_event_type
|
|
40164
|
+
*/
|
|
40165
|
+
code: string;
|
|
40166
|
+
/**
|
|
40167
|
+
* @description A human-readable description of the validation error.
|
|
40168
|
+
* @example Invalid enum value.
|
|
40169
|
+
*/
|
|
40170
|
+
message: string;
|
|
40171
|
+
}[];
|
|
40172
|
+
};
|
|
40173
|
+
};
|
|
40174
|
+
};
|
|
40175
|
+
/** @description The WorkOS OAuth grant behind `refresh_token` is being changed by another request. Retry the request. */
|
|
40176
|
+
503: {
|
|
40177
|
+
headers: {
|
|
40178
|
+
[name: string]: unknown;
|
|
40179
|
+
};
|
|
40180
|
+
content: {
|
|
40181
|
+
"application/json": {
|
|
40182
|
+
/**
|
|
40183
|
+
* @description The error code identifying the type of error.
|
|
40184
|
+
* @example concurrent_request
|
|
40185
|
+
* @constant
|
|
40186
|
+
*/
|
|
40187
|
+
code: "concurrent_request";
|
|
40188
|
+
/**
|
|
40189
|
+
* @description A human-readable description of the error.
|
|
40190
|
+
* @example Request could not be processed.
|
|
39192
40191
|
*/
|
|
39193
40192
|
message: string;
|
|
39194
40193
|
};
|
|
@@ -39201,6 +40200,8 @@ export interface operations {
|
|
|
39201
40200
|
query?: {
|
|
39202
40201
|
/** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
39203
40202
|
organization_id?: string;
|
|
40203
|
+
/** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
|
|
40204
|
+
supports_multiple_connections?: boolean;
|
|
39204
40205
|
/** @description A [connected account](/reference/pipes/connected-account) identifier. Use this to select the connection to delete. */
|
|
39205
40206
|
connected_account_id?: string;
|
|
39206
40207
|
};
|
|
@@ -39268,6 +40269,27 @@ export interface operations {
|
|
|
39268
40269
|
"application/json": components["schemas"]["AccountSelectionRequiredError"];
|
|
39269
40270
|
};
|
|
39270
40271
|
};
|
|
40272
|
+
/** @description The connected account or its WorkOS OAuth grant is being changed by another request. Retry the request. */
|
|
40273
|
+
503: {
|
|
40274
|
+
headers: {
|
|
40275
|
+
[name: string]: unknown;
|
|
40276
|
+
};
|
|
40277
|
+
content: {
|
|
40278
|
+
"application/json": {
|
|
40279
|
+
/**
|
|
40280
|
+
* @description The error code identifying the type of error.
|
|
40281
|
+
* @example concurrent_request
|
|
40282
|
+
* @constant
|
|
40283
|
+
*/
|
|
40284
|
+
code: "concurrent_request";
|
|
40285
|
+
/**
|
|
40286
|
+
* @description A human-readable description of the error.
|
|
40287
|
+
* @example Request could not be processed.
|
|
40288
|
+
*/
|
|
40289
|
+
message: string;
|
|
40290
|
+
};
|
|
40291
|
+
};
|
|
40292
|
+
};
|
|
39271
40293
|
};
|
|
39272
40294
|
};
|
|
39273
40295
|
DataIntegrationsUserManagementController_getUserDataIntegrations: {
|
|
@@ -39275,6 +40297,8 @@ export interface operations {
|
|
|
39275
40297
|
query?: {
|
|
39276
40298
|
/** @description An [Organization](/reference/organization) identifier. Optional parameter to filter connections for a specific organization. */
|
|
39277
40299
|
organization_id?: string;
|
|
40300
|
+
/** @description Set to `true` to use the plural connection contract. When omitted or `false`, only the compatibility connection is considered. */
|
|
40301
|
+
supports_multiple_connections?: boolean;
|
|
39278
40302
|
};
|
|
39279
40303
|
header?: never;
|
|
39280
40304
|
path: {
|