@workos/openapi-spec 0.91.0 → 0.93.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 +291 -1
- package/dist/types.d.ts +225 -3
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -25719,9 +25719,11 @@ components:
|
|
|
25719
25719
|
properties:
|
|
25720
25720
|
sms_template:
|
|
25721
25721
|
type: string
|
|
25722
|
+
maxLength: 160
|
|
25722
25723
|
description: >-
|
|
25723
25724
|
A custom template for the SMS message. Use the {{code}} placeholder
|
|
25724
|
-
to include the verification code.
|
|
25725
|
+
to include the verification code. Must not contain URLs or domain
|
|
25726
|
+
names.
|
|
25725
25727
|
example: Your verification code is {{code}}.
|
|
25726
25728
|
CheckAuthorizationDto:
|
|
25727
25729
|
allOf:
|
|
@@ -28584,6 +28586,11 @@ components:
|
|
|
28584
28586
|
- permission.created
|
|
28585
28587
|
- permission.deleted
|
|
28586
28588
|
- permission.updated
|
|
28589
|
+
- pipes.account_connection.add_failed
|
|
28590
|
+
- pipes.account_connection.connected
|
|
28591
|
+
- pipes.account_connection.connection_failed
|
|
28592
|
+
- pipes.account_connection.disconnected
|
|
28593
|
+
- pipes.account_connection.reauthorization_needed
|
|
28587
28594
|
- pipes.connected_account.connected
|
|
28588
28595
|
- pipes.connected_account.connection_failed
|
|
28589
28596
|
- pipes.connected_account.disconnected
|
|
@@ -40535,6 +40542,289 @@ components:
|
|
|
40535
40542
|
- data
|
|
40536
40543
|
- created_at
|
|
40537
40544
|
- object
|
|
40545
|
+
- type: object
|
|
40546
|
+
properties:
|
|
40547
|
+
id:
|
|
40548
|
+
type: string
|
|
40549
|
+
description: Unique identifier for the event.
|
|
40550
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40551
|
+
event:
|
|
40552
|
+
type: string
|
|
40553
|
+
const: pipes.account_connection.add_failed
|
|
40554
|
+
data:
|
|
40555
|
+
type: object
|
|
40556
|
+
properties:
|
|
40557
|
+
object:
|
|
40558
|
+
type: string
|
|
40559
|
+
description: The object type.
|
|
40560
|
+
example: connection_failed
|
|
40561
|
+
const: connection_failed
|
|
40562
|
+
data_integration_id:
|
|
40563
|
+
type: string
|
|
40564
|
+
description: The unique ID of the data integration.
|
|
40565
|
+
example: data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40566
|
+
provider_slug:
|
|
40567
|
+
type: string
|
|
40568
|
+
description: The provider slug for this connection attempt.
|
|
40569
|
+
example: github
|
|
40570
|
+
user_id:
|
|
40571
|
+
type:
|
|
40572
|
+
- string
|
|
40573
|
+
- 'null'
|
|
40574
|
+
description: The ID of the User the connection attempt belongs to.
|
|
40575
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40576
|
+
organization_id:
|
|
40577
|
+
type:
|
|
40578
|
+
- string
|
|
40579
|
+
- 'null'
|
|
40580
|
+
description: >-
|
|
40581
|
+
The ID of the Organization the connection attempt
|
|
40582
|
+
belongs to.
|
|
40583
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
40584
|
+
error_code:
|
|
40585
|
+
type: string
|
|
40586
|
+
description: A machine-readable error code for the failure.
|
|
40587
|
+
example: authorization_code_exchange_error
|
|
40588
|
+
error_reason:
|
|
40589
|
+
type:
|
|
40590
|
+
- string
|
|
40591
|
+
- 'null'
|
|
40592
|
+
description: A human-readable explanation of the failure.
|
|
40593
|
+
example: The authorization code has expired.
|
|
40594
|
+
provider_error:
|
|
40595
|
+
type:
|
|
40596
|
+
- string
|
|
40597
|
+
- 'null'
|
|
40598
|
+
description: The raw error code returned by the OAuth provider.
|
|
40599
|
+
example: access_denied
|
|
40600
|
+
provider_error_description:
|
|
40601
|
+
type:
|
|
40602
|
+
- string
|
|
40603
|
+
- 'null'
|
|
40604
|
+
description: >-
|
|
40605
|
+
The raw error description returned by the OAuth
|
|
40606
|
+
provider.
|
|
40607
|
+
example: The user denied the authorization request.
|
|
40608
|
+
created_at:
|
|
40609
|
+
format: date-time
|
|
40610
|
+
type: string
|
|
40611
|
+
description: An ISO 8601 timestamp.
|
|
40612
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
40613
|
+
required:
|
|
40614
|
+
- object
|
|
40615
|
+
- data_integration_id
|
|
40616
|
+
- provider_slug
|
|
40617
|
+
- user_id
|
|
40618
|
+
- organization_id
|
|
40619
|
+
- error_code
|
|
40620
|
+
- error_reason
|
|
40621
|
+
- provider_error
|
|
40622
|
+
- provider_error_description
|
|
40623
|
+
- created_at
|
|
40624
|
+
title: PipesConnectionFailed
|
|
40625
|
+
description: The event payload.
|
|
40626
|
+
created_at:
|
|
40627
|
+
format: date-time
|
|
40628
|
+
type: string
|
|
40629
|
+
description: An ISO 8601 timestamp.
|
|
40630
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
40631
|
+
context:
|
|
40632
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
40633
|
+
object:
|
|
40634
|
+
type: string
|
|
40635
|
+
description: Distinguishes the Event object.
|
|
40636
|
+
const: event
|
|
40637
|
+
required:
|
|
40638
|
+
- id
|
|
40639
|
+
- event
|
|
40640
|
+
- data
|
|
40641
|
+
- created_at
|
|
40642
|
+
- object
|
|
40643
|
+
- type: object
|
|
40644
|
+
properties:
|
|
40645
|
+
id:
|
|
40646
|
+
type: string
|
|
40647
|
+
description: Unique identifier for the event.
|
|
40648
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40649
|
+
event:
|
|
40650
|
+
type: string
|
|
40651
|
+
const: pipes.account_connection.connected
|
|
40652
|
+
data:
|
|
40653
|
+
$ref: '#/components/schemas/PipesConnectedAccount'
|
|
40654
|
+
description: The event payload.
|
|
40655
|
+
created_at:
|
|
40656
|
+
format: date-time
|
|
40657
|
+
type: string
|
|
40658
|
+
description: An ISO 8601 timestamp.
|
|
40659
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
40660
|
+
context:
|
|
40661
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
40662
|
+
object:
|
|
40663
|
+
type: string
|
|
40664
|
+
description: Distinguishes the Event object.
|
|
40665
|
+
const: event
|
|
40666
|
+
required:
|
|
40667
|
+
- id
|
|
40668
|
+
- event
|
|
40669
|
+
- data
|
|
40670
|
+
- created_at
|
|
40671
|
+
- object
|
|
40672
|
+
- type: object
|
|
40673
|
+
properties:
|
|
40674
|
+
id:
|
|
40675
|
+
type: string
|
|
40676
|
+
description: Unique identifier for the event.
|
|
40677
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40678
|
+
event:
|
|
40679
|
+
type: string
|
|
40680
|
+
const: pipes.account_connection.connection_failed
|
|
40681
|
+
data:
|
|
40682
|
+
type: object
|
|
40683
|
+
properties:
|
|
40684
|
+
object:
|
|
40685
|
+
type: string
|
|
40686
|
+
description: The object type.
|
|
40687
|
+
example: connection_failed
|
|
40688
|
+
const: connection_failed
|
|
40689
|
+
data_integration_id:
|
|
40690
|
+
type: string
|
|
40691
|
+
description: The unique ID of the data integration.
|
|
40692
|
+
example: data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40693
|
+
provider_slug:
|
|
40694
|
+
type: string
|
|
40695
|
+
description: The provider slug for this connection attempt.
|
|
40696
|
+
example: github
|
|
40697
|
+
user_id:
|
|
40698
|
+
type:
|
|
40699
|
+
- string
|
|
40700
|
+
- 'null'
|
|
40701
|
+
description: The ID of the User the connection attempt belongs to.
|
|
40702
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40703
|
+
organization_id:
|
|
40704
|
+
type:
|
|
40705
|
+
- string
|
|
40706
|
+
- 'null'
|
|
40707
|
+
description: >-
|
|
40708
|
+
The ID of the Organization the connection attempt
|
|
40709
|
+
belongs to.
|
|
40710
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
40711
|
+
error_code:
|
|
40712
|
+
type: string
|
|
40713
|
+
description: A machine-readable error code for the failure.
|
|
40714
|
+
example: authorization_code_exchange_error
|
|
40715
|
+
error_reason:
|
|
40716
|
+
type:
|
|
40717
|
+
- string
|
|
40718
|
+
- 'null'
|
|
40719
|
+
description: A human-readable explanation of the failure.
|
|
40720
|
+
example: The authorization code has expired.
|
|
40721
|
+
provider_error:
|
|
40722
|
+
type:
|
|
40723
|
+
- string
|
|
40724
|
+
- 'null'
|
|
40725
|
+
description: The raw error code returned by the OAuth provider.
|
|
40726
|
+
example: access_denied
|
|
40727
|
+
provider_error_description:
|
|
40728
|
+
type:
|
|
40729
|
+
- string
|
|
40730
|
+
- 'null'
|
|
40731
|
+
description: >-
|
|
40732
|
+
The raw error description returned by the OAuth
|
|
40733
|
+
provider.
|
|
40734
|
+
example: The user denied the authorization request.
|
|
40735
|
+
created_at:
|
|
40736
|
+
format: date-time
|
|
40737
|
+
type: string
|
|
40738
|
+
description: An ISO 8601 timestamp.
|
|
40739
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
40740
|
+
required:
|
|
40741
|
+
- object
|
|
40742
|
+
- data_integration_id
|
|
40743
|
+
- provider_slug
|
|
40744
|
+
- user_id
|
|
40745
|
+
- organization_id
|
|
40746
|
+
- error_code
|
|
40747
|
+
- error_reason
|
|
40748
|
+
- provider_error
|
|
40749
|
+
- provider_error_description
|
|
40750
|
+
- created_at
|
|
40751
|
+
title: PipesConnectionFailed
|
|
40752
|
+
description: The event payload.
|
|
40753
|
+
created_at:
|
|
40754
|
+
format: date-time
|
|
40755
|
+
type: string
|
|
40756
|
+
description: An ISO 8601 timestamp.
|
|
40757
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
40758
|
+
context:
|
|
40759
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
40760
|
+
object:
|
|
40761
|
+
type: string
|
|
40762
|
+
description: Distinguishes the Event object.
|
|
40763
|
+
const: event
|
|
40764
|
+
required:
|
|
40765
|
+
- id
|
|
40766
|
+
- event
|
|
40767
|
+
- data
|
|
40768
|
+
- created_at
|
|
40769
|
+
- object
|
|
40770
|
+
- type: object
|
|
40771
|
+
properties:
|
|
40772
|
+
id:
|
|
40773
|
+
type: string
|
|
40774
|
+
description: Unique identifier for the event.
|
|
40775
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40776
|
+
event:
|
|
40777
|
+
type: string
|
|
40778
|
+
const: pipes.account_connection.disconnected
|
|
40779
|
+
data:
|
|
40780
|
+
$ref: '#/components/schemas/PipesConnectedAccount'
|
|
40781
|
+
description: The event payload.
|
|
40782
|
+
created_at:
|
|
40783
|
+
format: date-time
|
|
40784
|
+
type: string
|
|
40785
|
+
description: An ISO 8601 timestamp.
|
|
40786
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
40787
|
+
context:
|
|
40788
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
40789
|
+
object:
|
|
40790
|
+
type: string
|
|
40791
|
+
description: Distinguishes the Event object.
|
|
40792
|
+
const: event
|
|
40793
|
+
required:
|
|
40794
|
+
- id
|
|
40795
|
+
- event
|
|
40796
|
+
- data
|
|
40797
|
+
- created_at
|
|
40798
|
+
- object
|
|
40799
|
+
- type: object
|
|
40800
|
+
properties:
|
|
40801
|
+
id:
|
|
40802
|
+
type: string
|
|
40803
|
+
description: Unique identifier for the event.
|
|
40804
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
40805
|
+
event:
|
|
40806
|
+
type: string
|
|
40807
|
+
const: pipes.account_connection.reauthorization_needed
|
|
40808
|
+
data:
|
|
40809
|
+
$ref: '#/components/schemas/PipesConnectedAccount'
|
|
40810
|
+
description: The event payload.
|
|
40811
|
+
created_at:
|
|
40812
|
+
format: date-time
|
|
40813
|
+
type: string
|
|
40814
|
+
description: An ISO 8601 timestamp.
|
|
40815
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
40816
|
+
context:
|
|
40817
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
40818
|
+
object:
|
|
40819
|
+
type: string
|
|
40820
|
+
description: Distinguishes the Event object.
|
|
40821
|
+
const: event
|
|
40822
|
+
required:
|
|
40823
|
+
- id
|
|
40824
|
+
- event
|
|
40825
|
+
- data
|
|
40826
|
+
- created_at
|
|
40827
|
+
- object
|
|
40538
40828
|
- type: object
|
|
40539
40829
|
properties:
|
|
40540
40830
|
id:
|
package/dist/types.d.ts
CHANGED
|
@@ -4377,7 +4377,7 @@ export interface components {
|
|
|
4377
4377
|
};
|
|
4378
4378
|
ChallengeAuthenticationFactorDto: {
|
|
4379
4379
|
/**
|
|
4380
|
-
* @description A custom template for the SMS message. Use the {{code}} placeholder to include the verification code.
|
|
4380
|
+
* @description A custom template for the SMS message. Use the {{code}} placeholder to include the verification code. Must not contain URLs or domain names.
|
|
4381
4381
|
* @example Your verification code is {{code}}.
|
|
4382
4382
|
*/
|
|
4383
4383
|
sms_template?: string;
|
|
@@ -6015,7 +6015,7 @@ export interface components {
|
|
|
6015
6015
|
* "dsync.user.created"
|
|
6016
6016
|
* ]
|
|
6017
6017
|
*/
|
|
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.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")[];
|
|
6019
6019
|
};
|
|
6020
6020
|
UpdateWebhookEndpointDto: {
|
|
6021
6021
|
/**
|
|
@@ -6036,7 +6036,7 @@ export interface components {
|
|
|
6036
6036
|
* "dsync.user.created"
|
|
6037
6037
|
* ]
|
|
6038
6038
|
*/
|
|
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.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")[];
|
|
6040
6040
|
};
|
|
6041
6041
|
WidgetSessionTokenDto: {
|
|
6042
6042
|
/**
|
|
@@ -15313,6 +15313,228 @@ export interface components {
|
|
|
15313
15313
|
* @constant
|
|
15314
15314
|
*/
|
|
15315
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";
|
|
15316
15538
|
} | {
|
|
15317
15539
|
/**
|
|
15318
15540
|
* @description Unique identifier for the event.
|