@workos/openapi-spec 0.32.0 → 0.34.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 +57 -0
- package/dist/policy.d.mts +8 -0
- package/dist/policy.mjs +11 -14
- package/dist/types.d.ts +45 -0
- package/package.json +4 -4
package/dist/open-api-spec.yaml
CHANGED
|
@@ -33777,6 +33777,63 @@ components:
|
|
|
33777
33777
|
- data
|
|
33778
33778
|
- created_at
|
|
33779
33779
|
- object
|
|
33780
|
+
- type: object
|
|
33781
|
+
properties:
|
|
33782
|
+
id:
|
|
33783
|
+
type: string
|
|
33784
|
+
description: Unique identifier for the event.
|
|
33785
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
33786
|
+
event:
|
|
33787
|
+
type: string
|
|
33788
|
+
const: vault.kek.deleted
|
|
33789
|
+
data:
|
|
33790
|
+
type: object
|
|
33791
|
+
properties:
|
|
33792
|
+
actor_id:
|
|
33793
|
+
type: string
|
|
33794
|
+
description: The unique identifier of the actor.
|
|
33795
|
+
example: user_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
33796
|
+
actor_source:
|
|
33797
|
+
type: string
|
|
33798
|
+
enum:
|
|
33799
|
+
- api
|
|
33800
|
+
- dashboard
|
|
33801
|
+
actor_name:
|
|
33802
|
+
type: string
|
|
33803
|
+
description: The name of the actor.
|
|
33804
|
+
example: Jane Doe
|
|
33805
|
+
key_name:
|
|
33806
|
+
type: string
|
|
33807
|
+
description: The name of the key encryption key.
|
|
33808
|
+
example: production-kek
|
|
33809
|
+
key_id:
|
|
33810
|
+
type: string
|
|
33811
|
+
description: The unique identifier of the key encryption key.
|
|
33812
|
+
example: key_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
33813
|
+
required:
|
|
33814
|
+
- actor_id
|
|
33815
|
+
- actor_source
|
|
33816
|
+
- actor_name
|
|
33817
|
+
- key_name
|
|
33818
|
+
- key_id
|
|
33819
|
+
description: The event payload.
|
|
33820
|
+
created_at:
|
|
33821
|
+
format: date-time
|
|
33822
|
+
type: string
|
|
33823
|
+
description: An ISO 8601 timestamp.
|
|
33824
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
33825
|
+
context:
|
|
33826
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
33827
|
+
object:
|
|
33828
|
+
type: string
|
|
33829
|
+
description: Distinguishes the Event object.
|
|
33830
|
+
const: event
|
|
33831
|
+
required:
|
|
33832
|
+
- id
|
|
33833
|
+
- event
|
|
33834
|
+
- data
|
|
33835
|
+
- created_at
|
|
33836
|
+
- object
|
|
33780
33837
|
- type: object
|
|
33781
33838
|
properties:
|
|
33782
33839
|
id:
|
package/dist/policy.d.mts
CHANGED
|
@@ -56,6 +56,14 @@ declare const operationHints: Record<string, OperationHint>;
|
|
|
56
56
|
* Service-level remounting. Maps IR service name → target service/namespace
|
|
57
57
|
* (PascalCase). All operations in the source service are mounted on the
|
|
58
58
|
* target unless overridden per-operation in {@link operationHints}.
|
|
59
|
+
*
|
|
60
|
+
* Keys may be exact service names or trailing-`*` prefix patterns
|
|
61
|
+
* (requires @workos/oagen >= 0.25.0). Precedence: an exact key always wins;
|
|
62
|
+
* among wildcards the longest prefix wins. Matching is plain `startsWith` —
|
|
63
|
+
* no regex. Note that a wildcard also absorbs future spec tags under its
|
|
64
|
+
* prefix, so review `oagen diff` output when tags are added: a new tag that
|
|
65
|
+
* does not belong to its prefix family (cf. UserManagementDataProviders →
|
|
66
|
+
* Pipes) needs its own exact entry here.
|
|
59
67
|
*/
|
|
60
68
|
declare const mountRules: Record<string, string>;
|
|
61
69
|
//#endregion
|
package/dist/policy.mjs
CHANGED
|
@@ -326,6 +326,14 @@ const operationHints = {
|
|
|
326
326
|
* Service-level remounting. Maps IR service name → target service/namespace
|
|
327
327
|
* (PascalCase). All operations in the source service are mounted on the
|
|
328
328
|
* target unless overridden per-operation in {@link operationHints}.
|
|
329
|
+
*
|
|
330
|
+
* Keys may be exact service names or trailing-`*` prefix patterns
|
|
331
|
+
* (requires @workos/oagen >= 0.25.0). Precedence: an exact key always wins;
|
|
332
|
+
* among wildcards the longest prefix wins. Matching is plain `startsWith` —
|
|
333
|
+
* no regex. Note that a wildcard also absorbs future spec tags under its
|
|
334
|
+
* prefix, so review `oagen diff` output when tags are added: a new tag that
|
|
335
|
+
* does not belong to its prefix family (cf. UserManagementDataProviders →
|
|
336
|
+
* Pipes) needs its own exact entry here.
|
|
329
337
|
*/
|
|
330
338
|
const mountRules = {
|
|
331
339
|
Client: "ClientApi",
|
|
@@ -335,24 +343,13 @@ const mountRules = {
|
|
|
335
343
|
Applications: "Connect",
|
|
336
344
|
ApplicationClientSecrets: "Connect",
|
|
337
345
|
Connections: "SSO",
|
|
338
|
-
|
|
339
|
-
DirectoryGroups: "DirectorySync",
|
|
340
|
-
DirectoryUsers: "DirectorySync",
|
|
346
|
+
"Director*": "DirectorySync",
|
|
341
347
|
FeatureFlagsTargets: "FeatureFlags",
|
|
342
348
|
OrganizationsFeatureFlags: "FeatureFlags",
|
|
343
349
|
UserManagementUsersFeatureFlags: "FeatureFlags",
|
|
344
350
|
OrganizationsApiKeys: "ApiKeys",
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
UserManagementCorsOrigins: "UserManagement",
|
|
348
|
-
UserManagementUsers: "UserManagement",
|
|
349
|
-
UserManagementInvitations: "UserManagement",
|
|
350
|
-
UserManagementJWTTemplate: "UserManagement",
|
|
351
|
-
UserManagementMagicAuth: "UserManagement",
|
|
352
|
-
UserManagementOrganizationMembership: "OrganizationMembership",
|
|
353
|
-
UserManagementOrganizationMembershipGroups: "OrganizationMembership",
|
|
354
|
-
UserManagementRedirectUris: "UserManagement",
|
|
355
|
-
UserManagementUsersAuthorizedApplications: "UserManagement",
|
|
351
|
+
"UserManagement*": "UserManagement",
|
|
352
|
+
"UserManagementOrganizationMembership*": "OrganizationMembership",
|
|
356
353
|
UserManagementDataProviders: "Pipes",
|
|
357
354
|
UserManagementMultiFactorAuthentication: "MultiFactorAuth"
|
|
358
355
|
};
|
package/dist/types.d.ts
CHANGED
|
@@ -14202,6 +14202,51 @@ export interface components {
|
|
|
14202
14202
|
* @constant
|
|
14203
14203
|
*/
|
|
14204
14204
|
object: "event";
|
|
14205
|
+
} | {
|
|
14206
|
+
/**
|
|
14207
|
+
* @description Unique identifier for the event.
|
|
14208
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14209
|
+
*/
|
|
14210
|
+
id: string;
|
|
14211
|
+
/** @constant */
|
|
14212
|
+
event: "vault.kek.deleted";
|
|
14213
|
+
/** @description The event payload. */
|
|
14214
|
+
data: {
|
|
14215
|
+
/**
|
|
14216
|
+
* @description The unique identifier of the actor.
|
|
14217
|
+
* @example user_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
14218
|
+
*/
|
|
14219
|
+
actor_id: string;
|
|
14220
|
+
/** @enum {string} */
|
|
14221
|
+
actor_source: "api" | "dashboard";
|
|
14222
|
+
/**
|
|
14223
|
+
* @description The name of the actor.
|
|
14224
|
+
* @example Jane Doe
|
|
14225
|
+
*/
|
|
14226
|
+
actor_name: string;
|
|
14227
|
+
/**
|
|
14228
|
+
* @description The name of the key encryption key.
|
|
14229
|
+
* @example production-kek
|
|
14230
|
+
*/
|
|
14231
|
+
key_name: string;
|
|
14232
|
+
/**
|
|
14233
|
+
* @description The unique identifier of the key encryption key.
|
|
14234
|
+
* @example key_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
14235
|
+
*/
|
|
14236
|
+
key_id: string;
|
|
14237
|
+
};
|
|
14238
|
+
/**
|
|
14239
|
+
* Format: date-time
|
|
14240
|
+
* @description An ISO 8601 timestamp.
|
|
14241
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
14242
|
+
*/
|
|
14243
|
+
created_at: string;
|
|
14244
|
+
context?: components["schemas"]["EventContextDto"];
|
|
14245
|
+
/**
|
|
14246
|
+
* @description Distinguishes the Event object.
|
|
14247
|
+
* @constant
|
|
14248
|
+
*/
|
|
14249
|
+
object: "event";
|
|
14205
14250
|
} | {
|
|
14206
14251
|
/**
|
|
14207
14252
|
* @description Unique identifier for the event.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workos/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.34.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
|
|
6
6
|
"license": "MIT",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"./package.json": "./package.json"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@workos/oagen": "^0.
|
|
33
|
+
"@workos/oagen": "^0.25.0"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|
|
36
36
|
"generate:services": "node scripts/generate-services.mjs",
|
|
@@ -60,8 +60,8 @@
|
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
|
62
62
|
"@types/js-yaml": "^4.0.9",
|
|
63
|
-
"@types/node": "^26.1.
|
|
64
|
-
"@workos/oagen-emitters": "^0.19.
|
|
63
|
+
"@types/node": "^26.1.1",
|
|
64
|
+
"@workos/oagen-emitters": "^0.19.10",
|
|
65
65
|
"diff2html": "^3.4.56",
|
|
66
66
|
"husky": "^9.1.7",
|
|
67
67
|
"js-yaml": "^4.1.1",
|