@workos/openapi-spec 0.9.0 → 0.11.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 +197 -1
- package/dist/services.d.mts +7 -1
- package/dist/services.mjs +1001 -1
- package/dist/types.d.ts +121 -4
- package/package.json +7 -6
package/dist/types.d.ts
CHANGED
|
@@ -4350,7 +4350,7 @@ export interface components {
|
|
|
4350
4350
|
* "dsync.user.created"
|
|
4351
4351
|
* ]
|
|
4352
4352
|
*/
|
|
4353
|
-
events: ("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" | "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.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4353
|
+
events: ("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" | "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.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4354
4354
|
};
|
|
4355
4355
|
UpdateWebhookEndpointDto: {
|
|
4356
4356
|
/**
|
|
@@ -4371,7 +4371,7 @@ export interface components {
|
|
|
4371
4371
|
* "dsync.user.created"
|
|
4372
4372
|
* ]
|
|
4373
4373
|
*/
|
|
4374
|
-
events?: ("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" | "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.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4374
|
+
events?: ("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" | "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.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4375
4375
|
};
|
|
4376
4376
|
WidgetSessionTokenDto: {
|
|
4377
4377
|
/**
|
|
@@ -5097,11 +5097,11 @@ export interface components {
|
|
|
5097
5097
|
*/
|
|
5098
5098
|
id: string;
|
|
5099
5099
|
/**
|
|
5100
|
-
* @description The state of the export. Possible values: pending, ready, error.
|
|
5100
|
+
* @description The state of the export. Possible values: pending, ready, error, expired.
|
|
5101
5101
|
* @example ready
|
|
5102
5102
|
* @enum {string}
|
|
5103
5103
|
*/
|
|
5104
|
-
state: "pending" | "ready" | "error";
|
|
5104
|
+
state: "pending" | "ready" | "error" | "expired";
|
|
5105
5105
|
/**
|
|
5106
5106
|
* @description A URL to the CSV file. Only defined when the Audit Log Export is ready.
|
|
5107
5107
|
* @example https://exports.audit-logs.com/audit-log-exports/export.csv
|
|
@@ -12450,6 +12450,108 @@ export interface components {
|
|
|
12450
12450
|
* @constant
|
|
12451
12451
|
*/
|
|
12452
12452
|
object: "event";
|
|
12453
|
+
} | {
|
|
12454
|
+
/**
|
|
12455
|
+
* @description Unique identifier for the event.
|
|
12456
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
12457
|
+
*/
|
|
12458
|
+
id: string;
|
|
12459
|
+
/** @constant */
|
|
12460
|
+
event: "session.reauthenticated";
|
|
12461
|
+
/** @description The event payload. */
|
|
12462
|
+
data: {
|
|
12463
|
+
/**
|
|
12464
|
+
* @description Distinguishes the session object.
|
|
12465
|
+
* @constant
|
|
12466
|
+
*/
|
|
12467
|
+
object: "session";
|
|
12468
|
+
/**
|
|
12469
|
+
* @description The unique ID of the session.
|
|
12470
|
+
* @example session_01H93ZY4F80QPBEZ1R5B2SHQG8
|
|
12471
|
+
*/
|
|
12472
|
+
id: string;
|
|
12473
|
+
/** @description Information about the impersonator if this session was created via impersonation. */
|
|
12474
|
+
impersonator?: {
|
|
12475
|
+
/**
|
|
12476
|
+
* @description The email address of the WorkOS Dashboard user who is impersonating the user.
|
|
12477
|
+
* @example admin@foocorp.com
|
|
12478
|
+
*/
|
|
12479
|
+
email: string;
|
|
12480
|
+
/**
|
|
12481
|
+
* @description The justification the impersonator gave for impersonating the user.
|
|
12482
|
+
* @example Investigating an issue with the customer's account.
|
|
12483
|
+
*/
|
|
12484
|
+
reason: string | null;
|
|
12485
|
+
};
|
|
12486
|
+
/**
|
|
12487
|
+
* @description The IP address from which the session was created.
|
|
12488
|
+
* @example 198.51.100.42
|
|
12489
|
+
*/
|
|
12490
|
+
ip_address: string | null;
|
|
12491
|
+
/**
|
|
12492
|
+
* @description The ID of the organization this session is associated with.
|
|
12493
|
+
* @example org_01H945H0YD4F97JN9MATX7BYAG
|
|
12494
|
+
*/
|
|
12495
|
+
organization_id?: string;
|
|
12496
|
+
/**
|
|
12497
|
+
* @description The user agent string from the device that created the session.
|
|
12498
|
+
* @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
|
|
12499
|
+
*/
|
|
12500
|
+
user_agent: string | null;
|
|
12501
|
+
/**
|
|
12502
|
+
* @description The ID of the user this session belongs to.
|
|
12503
|
+
* @example user_01E4ZCR3C56J083X43JQXF3JK5
|
|
12504
|
+
*/
|
|
12505
|
+
user_id: string;
|
|
12506
|
+
/**
|
|
12507
|
+
* @description The authentication method used to create this session.
|
|
12508
|
+
* @example sso
|
|
12509
|
+
* @enum {string}
|
|
12510
|
+
*/
|
|
12511
|
+
auth_method: "cross_app_auth" | "external_auth" | "impersonation" | "magic_code" | "migrated_session" | "oauth" | "passkey" | "password" | "sso" | "unknown";
|
|
12512
|
+
/**
|
|
12513
|
+
* @description The current status of the session.
|
|
12514
|
+
* @example active
|
|
12515
|
+
* @enum {string}
|
|
12516
|
+
*/
|
|
12517
|
+
status: "active" | "expired" | "revoked";
|
|
12518
|
+
/**
|
|
12519
|
+
* Format: date-time
|
|
12520
|
+
* @description The timestamp when the session expires.
|
|
12521
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12522
|
+
*/
|
|
12523
|
+
expires_at: string;
|
|
12524
|
+
/**
|
|
12525
|
+
* Format: date-time
|
|
12526
|
+
* @description The timestamp when the session ended.
|
|
12527
|
+
* @example null
|
|
12528
|
+
*/
|
|
12529
|
+
ended_at: string | null;
|
|
12530
|
+
/**
|
|
12531
|
+
* Format: date-time
|
|
12532
|
+
* @description An ISO 8601 timestamp.
|
|
12533
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12534
|
+
*/
|
|
12535
|
+
created_at: string;
|
|
12536
|
+
/**
|
|
12537
|
+
* Format: date-time
|
|
12538
|
+
* @description An ISO 8601 timestamp.
|
|
12539
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12540
|
+
*/
|
|
12541
|
+
updated_at: string;
|
|
12542
|
+
};
|
|
12543
|
+
/**
|
|
12544
|
+
* Format: date-time
|
|
12545
|
+
* @description An ISO 8601 timestamp.
|
|
12546
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12547
|
+
*/
|
|
12548
|
+
created_at: string;
|
|
12549
|
+
context?: components["schemas"]["EventContextDto"];
|
|
12550
|
+
/**
|
|
12551
|
+
* @description Distinguishes the Event object.
|
|
12552
|
+
* @constant
|
|
12553
|
+
*/
|
|
12554
|
+
object: "event";
|
|
12453
12555
|
} | {
|
|
12454
12556
|
/**
|
|
12455
12557
|
* @description Unique identifier for the event.
|
|
@@ -14434,6 +14536,8 @@ export interface components {
|
|
|
14434
14536
|
updated_at: string;
|
|
14435
14537
|
/** @description The primary role assigned to the user within the organization. */
|
|
14436
14538
|
role: components["schemas"]["SlimRole"];
|
|
14539
|
+
/** @description The list of roles assigned to the user within the organization. */
|
|
14540
|
+
roles: components["schemas"]["SlimRole"][];
|
|
14437
14541
|
/** @description The user that belongs to the organization through this membership. */
|
|
14438
14542
|
user: components["schemas"]["UserlandUser"];
|
|
14439
14543
|
};
|
|
@@ -21708,6 +21812,10 @@ export interface operations {
|
|
|
21708
21812
|
directory?: string;
|
|
21709
21813
|
/** @description Unique identifier of the WorkOS Directory Group. This value can be obtained from the WorkOS API. */
|
|
21710
21814
|
group?: string;
|
|
21815
|
+
/** @description Filter Directory Users by the identity provider's unique identifier (`idp_id`). Requires the `directory` parameter to also be provided. */
|
|
21816
|
+
idp_id?: string;
|
|
21817
|
+
/** @description Filter Directory Users by their primary email address. Requires the `directory` parameter to also be provided. */
|
|
21818
|
+
email?: string;
|
|
21711
21819
|
};
|
|
21712
21820
|
header?: never;
|
|
21713
21821
|
path?: never;
|
|
@@ -25530,6 +25638,11 @@ export interface operations {
|
|
|
25530
25638
|
* @example user@example.com
|
|
25531
25639
|
*/
|
|
25532
25640
|
email: string;
|
|
25641
|
+
/**
|
|
25642
|
+
* @description A token that links the subsequent SSO authentication back to the pending authentication so the authorization session can be completed.
|
|
25643
|
+
* @example pat_01FVYZ...
|
|
25644
|
+
*/
|
|
25645
|
+
pending_authentication_token?: string;
|
|
25533
25646
|
}));
|
|
25534
25647
|
};
|
|
25535
25648
|
};
|
|
@@ -27000,6 +27113,8 @@ export interface operations {
|
|
|
27000
27113
|
updated_at: string;
|
|
27001
27114
|
/** @description The primary role assigned to the user within the organization. */
|
|
27002
27115
|
role: components["schemas"]["SlimRole"];
|
|
27116
|
+
/** @description The list of roles assigned to the user within the organization. */
|
|
27117
|
+
roles: components["schemas"]["SlimRole"][];
|
|
27003
27118
|
/** @description The user that belongs to the organization through this membership. */
|
|
27004
27119
|
user: components["schemas"]["UserlandUser"];
|
|
27005
27120
|
};
|
|
@@ -27363,6 +27478,8 @@ export interface operations {
|
|
|
27363
27478
|
updated_at: string;
|
|
27364
27479
|
/** @description The primary role assigned to the user within the organization. */
|
|
27365
27480
|
role: components["schemas"]["SlimRole"];
|
|
27481
|
+
/** @description The list of roles assigned to the user within the organization. */
|
|
27482
|
+
roles: components["schemas"]["SlimRole"][];
|
|
27366
27483
|
/** @description The user that belongs to the organization through this membership. */
|
|
27367
27484
|
user: components["schemas"]["UserlandUser"];
|
|
27368
27485
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workos/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.11.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
|
|
6
6
|
"license": "MIT",
|
|
@@ -30,11 +30,12 @@
|
|
|
30
30
|
"./package.json": "./package.json"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@workos/oagen": "^0.
|
|
33
|
+
"@workos/oagen": "^0.23.0"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|
|
36
36
|
"generate:services": "node scripts/generate-services.mjs",
|
|
37
37
|
"build:policy": "npm run generate:services && tsdown",
|
|
38
|
+
"test": "node --test scripts/__tests__/*.spec.mjs",
|
|
38
39
|
"generate:postman": "tsx scripts/postman/generate.ts",
|
|
39
40
|
"generate:postman:local": "tsx scripts/postman/generate.ts --local",
|
|
40
41
|
"sdk:resolve": "npx oagen resolve --spec spec/open-api-spec.yaml",
|
|
@@ -54,16 +55,16 @@
|
|
|
54
55
|
"prepare": "husky"
|
|
55
56
|
},
|
|
56
57
|
"overrides": {
|
|
57
|
-
"js-yaml": "^4.
|
|
58
|
+
"js-yaml": "^4.1.1",
|
|
58
59
|
"lodash": "^4.17.23"
|
|
59
60
|
},
|
|
60
61
|
"devDependencies": {
|
|
61
62
|
"@types/js-yaml": "^4.0.9",
|
|
62
|
-
"@types/node": "^
|
|
63
|
-
"@workos/oagen-emitters": "^0.
|
|
63
|
+
"@types/node": "^26.0.0",
|
|
64
|
+
"@workos/oagen-emitters": "^0.19.0",
|
|
64
65
|
"diff2html": "^3.4.56",
|
|
65
66
|
"husky": "^9.1.7",
|
|
66
|
-
"js-yaml": "^4.
|
|
67
|
+
"js-yaml": "^4.1.1",
|
|
67
68
|
"openapi-to-postmanv2": "^6.1.0",
|
|
68
69
|
"tsdown": "^0.22.3",
|
|
69
70
|
"tsx": "^4.22.4",
|