@workos/openapi-spec 0.24.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.
- package/dist/open-api-spec.yaml +53 -0
- package/dist/types.d.ts +46 -2
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -21572,6 +21572,7 @@ components:
|
|
|
21572
21572
|
- authentication.sso_started
|
|
21573
21573
|
- authentication.sso_succeeded
|
|
21574
21574
|
- authentication.sso_timed_out
|
|
21575
|
+
- radar.challenge_created
|
|
21575
21576
|
- authentication.radar_risk_detected
|
|
21576
21577
|
- authentication.reauthentication_succeeded
|
|
21577
21578
|
- api_key.created
|
|
@@ -32566,6 +32567,58 @@ components:
|
|
|
32566
32567
|
- data
|
|
32567
32568
|
- created_at
|
|
32568
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
|
|
32569
32622
|
- type: object
|
|
32570
32623
|
properties:
|
|
32571
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.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" | "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.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" | "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
|
/**
|
|
@@ -13272,6 +13272,50 @@ export interface components {
|
|
|
13272
13272
|
* @constant
|
|
13273
13273
|
*/
|
|
13274
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";
|
|
13275
13319
|
} | {
|
|
13276
13320
|
/**
|
|
13277
13321
|
* @description Unique identifier for the event.
|