@workos/openapi-spec 0.26.0 → 0.27.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 +37 -0
- package/dist/types.d.ts +30 -2
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -21591,6 +21591,7 @@ components:
|
|
|
21591
21591
|
- agent.registration.claim.attempt.created
|
|
21592
21592
|
- agent.registration.claim.completed
|
|
21593
21593
|
- agent.registration.credential.issued
|
|
21594
|
+
- agent.registration.deleted
|
|
21594
21595
|
- agent.registration.expired
|
|
21595
21596
|
- agent.registration.organization.switched
|
|
21596
21597
|
- authentication.email_verification_succeeded
|
|
@@ -25658,6 +25659,42 @@ components:
|
|
|
25658
25659
|
- data
|
|
25659
25660
|
- created_at
|
|
25660
25661
|
- object
|
|
25662
|
+
- type: object
|
|
25663
|
+
properties:
|
|
25664
|
+
id:
|
|
25665
|
+
type: string
|
|
25666
|
+
description: Unique identifier for the event.
|
|
25667
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
25668
|
+
event:
|
|
25669
|
+
type: string
|
|
25670
|
+
const: agent.registration.deleted
|
|
25671
|
+
data:
|
|
25672
|
+
type: object
|
|
25673
|
+
properties:
|
|
25674
|
+
agent_registration_id:
|
|
25675
|
+
type: string
|
|
25676
|
+
description: The agent registration that was deleted.
|
|
25677
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
25678
|
+
required:
|
|
25679
|
+
- agent_registration_id
|
|
25680
|
+
description: The event payload.
|
|
25681
|
+
created_at:
|
|
25682
|
+
format: date-time
|
|
25683
|
+
type: string
|
|
25684
|
+
description: An ISO 8601 timestamp.
|
|
25685
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
25686
|
+
context:
|
|
25687
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
25688
|
+
object:
|
|
25689
|
+
type: string
|
|
25690
|
+
description: Distinguishes the Event object.
|
|
25691
|
+
const: event
|
|
25692
|
+
required:
|
|
25693
|
+
- id
|
|
25694
|
+
- event
|
|
25695
|
+
- data
|
|
25696
|
+
- created_at
|
|
25697
|
+
- object
|
|
25661
25698
|
- type: object
|
|
25662
25699
|
properties:
|
|
25663
25700
|
id:
|
package/dist/types.d.ts
CHANGED
|
@@ -4807,7 +4807,7 @@ export interface components {
|
|
|
4807
4807
|
* "dsync.user.created"
|
|
4808
4808
|
* ]
|
|
4809
4809
|
*/
|
|
4810
|
-
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")[];
|
|
4810
|
+
events: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "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")[];
|
|
4811
4811
|
};
|
|
4812
4812
|
UpdateWebhookEndpointDto: {
|
|
4813
4813
|
/**
|
|
@@ -4828,7 +4828,7 @@ export interface components {
|
|
|
4828
4828
|
* "dsync.user.created"
|
|
4829
4829
|
* ]
|
|
4830
4830
|
*/
|
|
4831
|
-
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")[];
|
|
4831
|
+
events?: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "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")[];
|
|
4832
4832
|
};
|
|
4833
4833
|
WidgetSessionTokenDto: {
|
|
4834
4834
|
/**
|
|
@@ -7958,6 +7958,34 @@ export interface components {
|
|
|
7958
7958
|
* @constant
|
|
7959
7959
|
*/
|
|
7960
7960
|
object: "event";
|
|
7961
|
+
} | {
|
|
7962
|
+
/**
|
|
7963
|
+
* @description Unique identifier for the event.
|
|
7964
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
7965
|
+
*/
|
|
7966
|
+
id: string;
|
|
7967
|
+
/** @constant */
|
|
7968
|
+
event: "agent.registration.deleted";
|
|
7969
|
+
/** @description The event payload. */
|
|
7970
|
+
data: {
|
|
7971
|
+
/**
|
|
7972
|
+
* @description The agent registration that was deleted.
|
|
7973
|
+
* @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
7974
|
+
*/
|
|
7975
|
+
agent_registration_id: string;
|
|
7976
|
+
};
|
|
7977
|
+
/**
|
|
7978
|
+
* Format: date-time
|
|
7979
|
+
* @description An ISO 8601 timestamp.
|
|
7980
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
7981
|
+
*/
|
|
7982
|
+
created_at: string;
|
|
7983
|
+
context?: components["schemas"]["EventContextDto"];
|
|
7984
|
+
/**
|
|
7985
|
+
* @description Distinguishes the Event object.
|
|
7986
|
+
* @constant
|
|
7987
|
+
*/
|
|
7988
|
+
object: "event";
|
|
7961
7989
|
} | {
|
|
7962
7990
|
/**
|
|
7963
7991
|
* @description Unique identifier for the event.
|