@workos/openapi-spec 0.23.0 → 0.25.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.
@@ -21556,6 +21556,7 @@ components:
21556
21556
  - agent.registration.claim.attempt.created
21557
21557
  - agent.registration.claim.completed
21558
21558
  - agent.registration.credential.issued
21559
+ - agent.registration.expired
21559
21560
  - agent.registration.organization.switched
21560
21561
  - authentication.email_verification_succeeded
21561
21562
  - authentication.magic_auth_failed
@@ -21571,6 +21572,7 @@ components:
21571
21572
  - authentication.sso_started
21572
21573
  - authentication.sso_succeeded
21573
21574
  - authentication.sso_timed_out
21575
+ - radar.challenge_created
21574
21576
  - authentication.radar_risk_detected
21575
21577
  - authentication.reauthentication_succeeded
21576
21578
  - api_key.created
@@ -25621,6 +25623,42 @@ components:
25621
25623
  - data
25622
25624
  - created_at
25623
25625
  - object
25626
+ - type: object
25627
+ properties:
25628
+ id:
25629
+ type: string
25630
+ description: Unique identifier for the event.
25631
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
25632
+ event:
25633
+ type: string
25634
+ const: agent.registration.expired
25635
+ data:
25636
+ type: object
25637
+ properties:
25638
+ agent_registration_id:
25639
+ type: string
25640
+ description: The agent registration that expired.
25641
+ example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
25642
+ required:
25643
+ - agent_registration_id
25644
+ description: The event payload.
25645
+ created_at:
25646
+ format: date-time
25647
+ type: string
25648
+ description: An ISO 8601 timestamp.
25649
+ example: '2026-01-15T12:00:00.000Z'
25650
+ context:
25651
+ $ref: '#/components/schemas/EventContextDto'
25652
+ object:
25653
+ type: string
25654
+ description: Distinguishes the Event object.
25655
+ const: event
25656
+ required:
25657
+ - id
25658
+ - event
25659
+ - data
25660
+ - created_at
25661
+ - object
25624
25662
  - type: object
25625
25663
  properties:
25626
25664
  id:
@@ -32529,6 +32567,58 @@ components:
32529
32567
  - data
32530
32568
  - created_at
32531
32569
  - object
32570
+ - type: object
32571
+ properties:
32572
+ id:
32573
+ type: string
32574
+ description: Unique identifier for the event.
32575
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
32576
+ event:
32577
+ type: string
32578
+ const: radar.challenge_created
32579
+ data:
32580
+ type: object
32581
+ properties:
32582
+ type:
32583
+ type: string
32584
+ description: The type of the Radar challenge.
32585
+ example: email
32586
+ const: email
32587
+ radar_challenge_id:
32588
+ type: string
32589
+ description: The ID of the Radar challenge.
32590
+ example: radar_challenge_01HWZBQZY2M3AMQW166Q22K88F
32591
+ user_id:
32592
+ type: string
32593
+ description: The ID of the user.
32594
+ example: user_01E4ZCR3C56J083X43JQXF3JK5
32595
+ email:
32596
+ type: string
32597
+ description: The email address of the user.
32598
+ example: user@example.com
32599
+ required:
32600
+ - type
32601
+ - radar_challenge_id
32602
+ - user_id
32603
+ - email
32604
+ description: The event payload.
32605
+ created_at:
32606
+ format: date-time
32607
+ type: string
32608
+ description: An ISO 8601 timestamp.
32609
+ example: '2026-01-15T12:00:00.000Z'
32610
+ context:
32611
+ $ref: '#/components/schemas/EventContextDto'
32612
+ object:
32613
+ type: string
32614
+ description: Distinguishes the Event object.
32615
+ const: event
32616
+ required:
32617
+ - id
32618
+ - event
32619
+ - data
32620
+ - created_at
32621
+ - object
32532
32622
  - type: object
32533
32623
  properties:
32534
32624
  id:
package/dist/types.d.ts CHANGED
@@ -4787,7 +4787,7 @@ export interface components {
4787
4787
  * "dsync.user.created"
4788
4788
  * ]
4789
4789
  */
4790
- events: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.organization.switched" | "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" | "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")[];
4790
+ events: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.expired" | "agent.registration.organization.switched" | "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")[];
4791
4791
  };
4792
4792
  UpdateWebhookEndpointDto: {
4793
4793
  /**
@@ -4808,7 +4808,7 @@ export interface components {
4808
4808
  * "dsync.user.created"
4809
4809
  * ]
4810
4810
  */
4811
- events?: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.organization.switched" | "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" | "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")[];
4811
+ events?: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.expired" | "agent.registration.organization.switched" | "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")[];
4812
4812
  };
4813
4813
  WidgetSessionTokenDto: {
4814
4814
  /**
@@ -7938,6 +7938,34 @@ export interface components {
7938
7938
  * @constant
7939
7939
  */
7940
7940
  object: "event";
7941
+ } | {
7942
+ /**
7943
+ * @description Unique identifier for the event.
7944
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
7945
+ */
7946
+ id: string;
7947
+ /** @constant */
7948
+ event: "agent.registration.expired";
7949
+ /** @description The event payload. */
7950
+ data: {
7951
+ /**
7952
+ * @description The agent registration that expired.
7953
+ * @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
7954
+ */
7955
+ agent_registration_id: string;
7956
+ };
7957
+ /**
7958
+ * Format: date-time
7959
+ * @description An ISO 8601 timestamp.
7960
+ * @example 2026-01-15T12:00:00.000Z
7961
+ */
7962
+ created_at: string;
7963
+ context?: components["schemas"]["EventContextDto"];
7964
+ /**
7965
+ * @description Distinguishes the Event object.
7966
+ * @constant
7967
+ */
7968
+ object: "event";
7941
7969
  } | {
7942
7970
  /**
7943
7971
  * @description Unique identifier for the event.
@@ -13244,6 +13272,50 @@ export interface components {
13244
13272
  * @constant
13245
13273
  */
13246
13274
  object: "event";
13275
+ } | {
13276
+ /**
13277
+ * @description Unique identifier for the event.
13278
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
13279
+ */
13280
+ id: string;
13281
+ /** @constant */
13282
+ event: "radar.challenge_created";
13283
+ /** @description The event payload. */
13284
+ data: {
13285
+ /**
13286
+ * @description The type of the Radar challenge.
13287
+ * @example email
13288
+ * @constant
13289
+ */
13290
+ type: "email";
13291
+ /**
13292
+ * @description The ID of the Radar challenge.
13293
+ * @example radar_challenge_01HWZBQZY2M3AMQW166Q22K88F
13294
+ */
13295
+ radar_challenge_id: string;
13296
+ /**
13297
+ * @description The ID of the user.
13298
+ * @example user_01E4ZCR3C56J083X43JQXF3JK5
13299
+ */
13300
+ user_id: string;
13301
+ /**
13302
+ * @description The email address of the user.
13303
+ * @example user@example.com
13304
+ */
13305
+ email: string;
13306
+ };
13307
+ /**
13308
+ * Format: date-time
13309
+ * @description An ISO 8601 timestamp.
13310
+ * @example 2026-01-15T12:00:00.000Z
13311
+ */
13312
+ created_at: string;
13313
+ context?: components["schemas"]["EventContextDto"];
13314
+ /**
13315
+ * @description Distinguishes the Event object.
13316
+ * @constant
13317
+ */
13318
+ object: "event";
13247
13319
  } | {
13248
13320
  /**
13249
13321
  * @description Unique identifier for the event.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workos/openapi-spec",
3
- "version": "0.23.0",
3
+ "version": "0.25.0",
4
4
  "type": "module",
5
5
  "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
6
6
  "license": "MIT",