@workos/openapi-spec 0.51.0 → 0.53.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 +41 -2
- package/dist/types.d.ts +31 -3
- package/package.json +3 -3
package/dist/open-api-spec.yaml
CHANGED
|
@@ -11606,8 +11606,8 @@ paths:
|
|
|
11606
11606
|
const: login
|
|
11607
11607
|
description: >-
|
|
11608
11608
|
If set to `login`, forces re-authentication at the identity
|
|
11609
|
-
provider. For SAML
|
|
11610
|
-
SAML request.
|
|
11609
|
+
provider. For supported SAML providers this sets `ForceAuthn="true"`
|
|
11610
|
+
in the SAML request; providers that don't support it are unaffected.
|
|
11611
11611
|
responses:
|
|
11612
11612
|
'200':
|
|
11613
11613
|
description: OK
|
|
@@ -22230,6 +22230,7 @@ components:
|
|
|
22230
22230
|
- agent.registration.claim.completed
|
|
22231
22231
|
- agent.registration.credential.issued
|
|
22232
22232
|
- agent.registration.deleted
|
|
22233
|
+
- agent.registration.refreshed
|
|
22233
22234
|
- agent.registration.expired
|
|
22234
22235
|
- agent.registration.organization.switched
|
|
22235
22236
|
- agent.registration.revoked
|
|
@@ -26516,6 +26517,44 @@ components:
|
|
|
26516
26517
|
- data
|
|
26517
26518
|
- created_at
|
|
26518
26519
|
- object
|
|
26520
|
+
- type: object
|
|
26521
|
+
properties:
|
|
26522
|
+
id:
|
|
26523
|
+
type: string
|
|
26524
|
+
description: Unique identifier for the event.
|
|
26525
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
26526
|
+
event:
|
|
26527
|
+
type: string
|
|
26528
|
+
const: agent.registration.refreshed
|
|
26529
|
+
data:
|
|
26530
|
+
type: object
|
|
26531
|
+
properties:
|
|
26532
|
+
agent_registration_id:
|
|
26533
|
+
type: string
|
|
26534
|
+
description: >-
|
|
26535
|
+
The agent registration whose identity assertion was
|
|
26536
|
+
refreshed.
|
|
26537
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
26538
|
+
required:
|
|
26539
|
+
- agent_registration_id
|
|
26540
|
+
description: The event payload.
|
|
26541
|
+
created_at:
|
|
26542
|
+
format: date-time
|
|
26543
|
+
type: string
|
|
26544
|
+
description: An ISO 8601 timestamp.
|
|
26545
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
26546
|
+
context:
|
|
26547
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
26548
|
+
object:
|
|
26549
|
+
type: string
|
|
26550
|
+
description: Distinguishes the Event object.
|
|
26551
|
+
const: event
|
|
26552
|
+
required:
|
|
26553
|
+
- id
|
|
26554
|
+
- event
|
|
26555
|
+
- data
|
|
26556
|
+
- created_at
|
|
26557
|
+
- object
|
|
26519
26558
|
- type: object
|
|
26520
26559
|
properties:
|
|
26521
26560
|
id:
|
package/dist/types.d.ts
CHANGED
|
@@ -4904,7 +4904,7 @@ export interface components {
|
|
|
4904
4904
|
* "dsync.user.created"
|
|
4905
4905
|
* ]
|
|
4906
4906
|
*/
|
|
4907
|
-
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")[];
|
|
4907
|
+
events: ("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")[];
|
|
4908
4908
|
};
|
|
4909
4909
|
UpdateWebhookEndpointDto: {
|
|
4910
4910
|
/**
|
|
@@ -4925,7 +4925,7 @@ export interface components {
|
|
|
4925
4925
|
* "dsync.user.created"
|
|
4926
4926
|
* ]
|
|
4927
4927
|
*/
|
|
4928
|
-
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")[];
|
|
4928
|
+
events?: ("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")[];
|
|
4929
4929
|
};
|
|
4930
4930
|
WidgetSessionTokenDto: {
|
|
4931
4931
|
/**
|
|
@@ -8219,6 +8219,34 @@ export interface components {
|
|
|
8219
8219
|
* @constant
|
|
8220
8220
|
*/
|
|
8221
8221
|
object: "event";
|
|
8222
|
+
} | {
|
|
8223
|
+
/**
|
|
8224
|
+
* @description Unique identifier for the event.
|
|
8225
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
8226
|
+
*/
|
|
8227
|
+
id: string;
|
|
8228
|
+
/** @constant */
|
|
8229
|
+
event: "agent.registration.refreshed";
|
|
8230
|
+
/** @description The event payload. */
|
|
8231
|
+
data: {
|
|
8232
|
+
/**
|
|
8233
|
+
* @description The agent registration whose identity assertion was refreshed.
|
|
8234
|
+
* @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8235
|
+
*/
|
|
8236
|
+
agent_registration_id: string;
|
|
8237
|
+
};
|
|
8238
|
+
/**
|
|
8239
|
+
* Format: date-time
|
|
8240
|
+
* @description An ISO 8601 timestamp.
|
|
8241
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8242
|
+
*/
|
|
8243
|
+
created_at: string;
|
|
8244
|
+
context?: components["schemas"]["EventContextDto"];
|
|
8245
|
+
/**
|
|
8246
|
+
* @description Distinguishes the Event object.
|
|
8247
|
+
* @constant
|
|
8248
|
+
*/
|
|
8249
|
+
object: "event";
|
|
8222
8250
|
} | {
|
|
8223
8251
|
/**
|
|
8224
8252
|
* @description Unique identifier for the event.
|
|
@@ -27273,7 +27301,7 @@ export interface operations {
|
|
|
27273
27301
|
login_hint?: string;
|
|
27274
27302
|
/** @description A random string generated by the client that is used to mitigate replay attacks. */
|
|
27275
27303
|
nonce?: string;
|
|
27276
|
-
/** @description If set to `login`, forces re-authentication at the identity provider. For SAML
|
|
27304
|
+
/** @description If set to `login`, forces re-authentication at the identity provider. For supported SAML providers this sets `ForceAuthn="true"` in the SAML request; providers that don't support it are unaffected. */
|
|
27277
27305
|
prompt?: "login";
|
|
27278
27306
|
};
|
|
27279
27307
|
header?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workos/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.53.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
|
|
6
6
|
"license": "MIT",
|
|
@@ -57,8 +57,8 @@
|
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
59
|
"@types/js-yaml": "^4.0.9",
|
|
60
|
-
"@types/node": "^26.1.
|
|
61
|
-
"@workos/oagen": "^0.28.
|
|
60
|
+
"@types/node": "^26.1.2",
|
|
61
|
+
"@workos/oagen": "^0.28.1",
|
|
62
62
|
"@workos/oagen-emitters": "^0.22.0",
|
|
63
63
|
"diff2html": "^3.4.56",
|
|
64
64
|
"husky": "^9.1.7",
|