@workos/openapi-spec 0.28.0 → 0.29.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.
@@ -18851,8 +18851,10 @@ paths:
18851
18851
  /widgets/token:
18852
18852
  post:
18853
18853
  description: >-
18854
- Generate a widget token scoped to an organization and user with the
18855
- specified scopes.
18854
+ Generate a widget token for a user, optionally scoped to an
18855
+ organization. When an organization is specified, org-scoped widgets are
18856
+ enabled; omitting it issues a user-only token for widgets like
18857
+ `UserProfile` and `UserSecurity`.
18856
18858
  operationId: WidgetsPublicController_issueWidgetSessionToken
18857
18859
  parameters: []
18858
18860
  requestBody:
@@ -21714,7 +21716,11 @@ components:
21714
21716
  properties:
21715
21717
  organization_id:
21716
21718
  type: string
21717
- description: The ID of the organization to scope the widget session to.
21719
+ description: >-
21720
+ The ID of the organization to scope the widget session to. Required
21721
+ when scopes are provided. Optional when issuing a token for
21722
+ user-only widgets (e.g. `UserProfile`, `UserSecurity`) that do not
21723
+ require organization context.
21718
21724
  example: org_01EHZNVPK3SFK441A1RGBFSHRT
21719
21725
  user_id:
21720
21726
  type: string
@@ -21735,8 +21741,6 @@ components:
21735
21741
  - widgets:pipes:manage
21736
21742
  example:
21737
21743
  - widgets:users-table:manage
21738
- required:
21739
- - organization_id
21740
21744
  ClientApiTokenDto:
21741
21745
  type: object
21742
21746
  properties:
package/dist/types.d.ts CHANGED
@@ -3162,7 +3162,7 @@ export interface paths {
3162
3162
  put?: never;
3163
3163
  /**
3164
3164
  * Generate a widget token
3165
- * @description Generate a widget token scoped to an organization and user with the specified scopes.
3165
+ * @description Generate a widget token for a user, optionally scoped to an organization. When an organization is specified, org-scoped widgets are enabled; omitting it issues a user-only token for widgets like `UserProfile` and `UserSecurity`.
3166
3166
  */
3167
3167
  post: operations["WidgetsPublicController_issueWidgetSessionToken"];
3168
3168
  delete?: never;
@@ -4832,10 +4832,10 @@ export interface components {
4832
4832
  };
4833
4833
  WidgetSessionTokenDto: {
4834
4834
  /**
4835
- * @description The ID of the organization to scope the widget session to.
4835
+ * @description The ID of the organization to scope the widget session to. Required when scopes are provided. Optional when issuing a token for user-only widgets (e.g. `UserProfile`, `UserSecurity`) that do not require organization context.
4836
4836
  * @example org_01EHZNVPK3SFK441A1RGBFSHRT
4837
4837
  */
4838
- organization_id: string;
4838
+ organization_id?: string;
4839
4839
  /**
4840
4840
  * @description The ID of the user to issue the widget session token for.
4841
4841
  * @example user_01E4ZCR3C56J083X43JQXF3JK5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workos/openapi-spec",
3
- "version": "0.28.0",
3
+ "version": "0.29.0",
4
4
  "type": "module",
5
5
  "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
6
6
  "license": "MIT",