@workos/openapi-spec 0.30.0 → 0.32.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 -14
- package/dist/types.d.ts +30 -10
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -21599,6 +21599,7 @@ components:
|
|
|
21599
21599
|
- agent.registration.deleted
|
|
21600
21600
|
- agent.registration.expired
|
|
21601
21601
|
- agent.registration.organization.switched
|
|
21602
|
+
- agent.registration.revoked
|
|
21602
21603
|
- authentication.email_verification_succeeded
|
|
21603
21604
|
- authentication.magic_auth_failed
|
|
21604
21605
|
- authentication.magic_auth_succeeded
|
|
@@ -24011,20 +24012,6 @@ components:
|
|
|
24011
24012
|
connections this is the ACS URL; for OIDC connections this is the
|
|
24012
24013
|
redirect URI.
|
|
24013
24014
|
example: https://auth.workos.com/sso/saml/acs/conn_externalkey
|
|
24014
|
-
options:
|
|
24015
|
-
type: object
|
|
24016
|
-
properties:
|
|
24017
|
-
signing_cert:
|
|
24018
|
-
type:
|
|
24019
|
-
- string
|
|
24020
|
-
- 'null'
|
|
24021
|
-
description: The signing certificate of the SAML connection.
|
|
24022
|
-
example: null
|
|
24023
|
-
required:
|
|
24024
|
-
- signing_cert
|
|
24025
|
-
description: >-
|
|
24026
|
-
Configuration options for SAML connections. Only present for SAML
|
|
24027
|
-
connection types.
|
|
24028
24015
|
created_at:
|
|
24029
24016
|
format: date-time
|
|
24030
24017
|
type: string
|
|
@@ -25787,6 +25774,42 @@ components:
|
|
|
25787
25774
|
- data
|
|
25788
25775
|
- created_at
|
|
25789
25776
|
- object
|
|
25777
|
+
- type: object
|
|
25778
|
+
properties:
|
|
25779
|
+
id:
|
|
25780
|
+
type: string
|
|
25781
|
+
description: Unique identifier for the event.
|
|
25782
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
25783
|
+
event:
|
|
25784
|
+
type: string
|
|
25785
|
+
const: agent.registration.revoked
|
|
25786
|
+
data:
|
|
25787
|
+
type: object
|
|
25788
|
+
properties:
|
|
25789
|
+
agent_registration_id:
|
|
25790
|
+
type: string
|
|
25791
|
+
description: The agent registration that was revoked.
|
|
25792
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
25793
|
+
required:
|
|
25794
|
+
- agent_registration_id
|
|
25795
|
+
description: The event payload.
|
|
25796
|
+
created_at:
|
|
25797
|
+
format: date-time
|
|
25798
|
+
type: string
|
|
25799
|
+
description: An ISO 8601 timestamp.
|
|
25800
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
25801
|
+
context:
|
|
25802
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
25803
|
+
object:
|
|
25804
|
+
type: string
|
|
25805
|
+
description: Distinguishes the Event object.
|
|
25806
|
+
const: event
|
|
25807
|
+
required:
|
|
25808
|
+
- id
|
|
25809
|
+
- event
|
|
25810
|
+
- data
|
|
25811
|
+
- created_at
|
|
25812
|
+
- object
|
|
25790
25813
|
- type: object
|
|
25791
25814
|
properties:
|
|
25792
25815
|
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.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")[];
|
|
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" | "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")[];
|
|
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.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")[];
|
|
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" | "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")[];
|
|
4832
4832
|
};
|
|
4833
4833
|
WidgetSessionTokenDto: {
|
|
4834
4834
|
/**
|
|
@@ -6631,14 +6631,6 @@ export interface components {
|
|
|
6631
6631
|
* @example https://auth.workos.com/sso/saml/acs/conn_externalkey
|
|
6632
6632
|
*/
|
|
6633
6633
|
callback_endpoint?: string;
|
|
6634
|
-
/** @description Configuration options for SAML connections. Only present for SAML connection types. */
|
|
6635
|
-
options?: {
|
|
6636
|
-
/**
|
|
6637
|
-
* @description The signing certificate of the SAML connection.
|
|
6638
|
-
* @example null
|
|
6639
|
-
*/
|
|
6640
|
-
signing_cert: string | null;
|
|
6641
|
-
};
|
|
6642
6634
|
/**
|
|
6643
6635
|
* Format: date-time
|
|
6644
6636
|
* @description An ISO 8601 timestamp.
|
|
@@ -8052,6 +8044,34 @@ export interface components {
|
|
|
8052
8044
|
* @constant
|
|
8053
8045
|
*/
|
|
8054
8046
|
object: "event";
|
|
8047
|
+
} | {
|
|
8048
|
+
/**
|
|
8049
|
+
* @description Unique identifier for the event.
|
|
8050
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
8051
|
+
*/
|
|
8052
|
+
id: string;
|
|
8053
|
+
/** @constant */
|
|
8054
|
+
event: "agent.registration.revoked";
|
|
8055
|
+
/** @description The event payload. */
|
|
8056
|
+
data: {
|
|
8057
|
+
/**
|
|
8058
|
+
* @description The agent registration that was revoked.
|
|
8059
|
+
* @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8060
|
+
*/
|
|
8061
|
+
agent_registration_id: string;
|
|
8062
|
+
};
|
|
8063
|
+
/**
|
|
8064
|
+
* Format: date-time
|
|
8065
|
+
* @description An ISO 8601 timestamp.
|
|
8066
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8067
|
+
*/
|
|
8068
|
+
created_at: string;
|
|
8069
|
+
context?: components["schemas"]["EventContextDto"];
|
|
8070
|
+
/**
|
|
8071
|
+
* @description Distinguishes the Event object.
|
|
8072
|
+
* @constant
|
|
8073
|
+
*/
|
|
8074
|
+
object: "event";
|
|
8055
8075
|
} | {
|
|
8056
8076
|
/**
|
|
8057
8077
|
* @description Unique identifier for the event.
|