@workos/openapi-spec 0.40.0 → 0.42.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 +174 -9
- package/dist/services.mjs +5 -0
- package/dist/types.d.ts +135 -0
- package/package.json +3 -3
package/dist/open-api-spec.yaml
CHANGED
|
@@ -10111,7 +10111,6 @@ paths:
|
|
|
10111
10111
|
summary: Create a group
|
|
10112
10112
|
tags:
|
|
10113
10113
|
- groups
|
|
10114
|
-
x-feature-flag: user-groups-enabled
|
|
10115
10114
|
get:
|
|
10116
10115
|
description: Get a paginated list of groups within an organization.
|
|
10117
10116
|
operationId: GroupsController_list
|
|
@@ -10205,7 +10204,6 @@ paths:
|
|
|
10205
10204
|
summary: List groups
|
|
10206
10205
|
tags:
|
|
10207
10206
|
- groups
|
|
10208
|
-
x-feature-flag: user-groups-enabled
|
|
10209
10207
|
/organizations/{organizationId}/groups/{groupId}:
|
|
10210
10208
|
get:
|
|
10211
10209
|
description: Retrieve a group by its ID within an organization.
|
|
@@ -10261,7 +10259,6 @@ paths:
|
|
|
10261
10259
|
summary: Get a group
|
|
10262
10260
|
tags:
|
|
10263
10261
|
- groups
|
|
10264
|
-
x-feature-flag: user-groups-enabled
|
|
10265
10262
|
patch:
|
|
10266
10263
|
description: >-
|
|
10267
10264
|
Update an existing group. Only the fields provided in the request body
|
|
@@ -10356,7 +10353,6 @@ paths:
|
|
|
10356
10353
|
summary: Update a group
|
|
10357
10354
|
tags:
|
|
10358
10355
|
- groups
|
|
10359
|
-
x-feature-flag: user-groups-enabled
|
|
10360
10356
|
delete:
|
|
10361
10357
|
description: Delete a group from an organization.
|
|
10362
10358
|
operationId: GroupsController_delete
|
|
@@ -10407,7 +10403,6 @@ paths:
|
|
|
10407
10403
|
summary: Delete a group
|
|
10408
10404
|
tags:
|
|
10409
10405
|
- groups
|
|
10410
|
-
x-feature-flag: user-groups-enabled
|
|
10411
10406
|
/organizations/{organizationId}/groups/{groupId}/organization-memberships:
|
|
10412
10407
|
post:
|
|
10413
10408
|
description: Add an organization membership to a group.
|
|
@@ -10501,7 +10496,6 @@ paths:
|
|
|
10501
10496
|
summary: Add a member to a Group
|
|
10502
10497
|
tags:
|
|
10503
10498
|
- groups
|
|
10504
|
-
x-feature-flag: user-groups-enabled
|
|
10505
10499
|
get:
|
|
10506
10500
|
description: Get a list of organization memberships in a group.
|
|
10507
10501
|
operationId: GroupMembershipsController_listMembers
|
|
@@ -10603,7 +10597,6 @@ paths:
|
|
|
10603
10597
|
summary: List Group members
|
|
10604
10598
|
tags:
|
|
10605
10599
|
- groups
|
|
10606
|
-
x-feature-flag: user-groups-enabled
|
|
10607
10600
|
/organizations/{organizationId}/groups/{groupId}/organization-memberships/{omId}:
|
|
10608
10601
|
delete:
|
|
10609
10602
|
description: Remove an organization membership from a group.
|
|
@@ -10662,7 +10655,103 @@ paths:
|
|
|
10662
10655
|
summary: Remove a member from a Group
|
|
10663
10656
|
tags:
|
|
10664
10657
|
- groups
|
|
10665
|
-
|
|
10658
|
+
/organizations/{organization_id}/authorized_applications:
|
|
10659
|
+
get:
|
|
10660
|
+
description: >-
|
|
10661
|
+
Get a list of all Connect applications that users in the organization
|
|
10662
|
+
have authorized.
|
|
10663
|
+
operationId: OrganizationAuthorizedApplicationsController_list
|
|
10664
|
+
parameters:
|
|
10665
|
+
- name: organization_id
|
|
10666
|
+
required: true
|
|
10667
|
+
in: path
|
|
10668
|
+
description: The ID of the organization.
|
|
10669
|
+
schema:
|
|
10670
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10671
|
+
type: string
|
|
10672
|
+
- name: before
|
|
10673
|
+
required: false
|
|
10674
|
+
in: query
|
|
10675
|
+
description: >-
|
|
10676
|
+
An object ID that defines your place in the list. When the ID is not
|
|
10677
|
+
present, you are at the end of the list. For example, if you make a
|
|
10678
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
10679
|
+
subsequent call can include `before="obj_123"` to fetch a new batch
|
|
10680
|
+
of objects before `"obj_123"`.
|
|
10681
|
+
schema:
|
|
10682
|
+
example: xxx_01HXYZ123456789ABCDEFGHIJ
|
|
10683
|
+
type: string
|
|
10684
|
+
- name: after
|
|
10685
|
+
required: false
|
|
10686
|
+
in: query
|
|
10687
|
+
description: >-
|
|
10688
|
+
An object ID that defines your place in the list. When the ID is not
|
|
10689
|
+
present, you are at the end of the list. For example, if you make a
|
|
10690
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
10691
|
+
subsequent call can include `after="obj_123"` to fetch a new batch
|
|
10692
|
+
of objects after `"obj_123"`.
|
|
10693
|
+
schema:
|
|
10694
|
+
example: xxx_01HXYZ987654321KJIHGFEDCBA
|
|
10695
|
+
type: string
|
|
10696
|
+
- name: limit
|
|
10697
|
+
required: false
|
|
10698
|
+
in: query
|
|
10699
|
+
description: >-
|
|
10700
|
+
Upper limit on the number of objects to return, between `1` and
|
|
10701
|
+
`100`.
|
|
10702
|
+
schema:
|
|
10703
|
+
minimum: 1
|
|
10704
|
+
maximum: 100
|
|
10705
|
+
default: 10
|
|
10706
|
+
example: 10
|
|
10707
|
+
type: integer
|
|
10708
|
+
- name: order
|
|
10709
|
+
required: false
|
|
10710
|
+
in: query
|
|
10711
|
+
description: >-
|
|
10712
|
+
Order the results by the creation time. Supported values are `"asc"`
|
|
10713
|
+
(ascending), `"desc"` (descending), and `"normal"` (descending with
|
|
10714
|
+
reversed cursor semantics where `before` fetches older records and
|
|
10715
|
+
`after` fetches newer records).
|
|
10716
|
+
schema:
|
|
10717
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
10718
|
+
responses:
|
|
10719
|
+
'200':
|
|
10720
|
+
description: OK
|
|
10721
|
+
content:
|
|
10722
|
+
application/json:
|
|
10723
|
+
schema:
|
|
10724
|
+
$ref: >-
|
|
10725
|
+
#/components/schemas/OrganizationAuthorizedConnectApplicationList
|
|
10726
|
+
'404':
|
|
10727
|
+
description: Not Found
|
|
10728
|
+
content:
|
|
10729
|
+
application/json:
|
|
10730
|
+
schema:
|
|
10731
|
+
type: object
|
|
10732
|
+
properties:
|
|
10733
|
+
message:
|
|
10734
|
+
type: string
|
|
10735
|
+
description: A human-readable description of the error.
|
|
10736
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
10737
|
+
required:
|
|
10738
|
+
- message
|
|
10739
|
+
'422':
|
|
10740
|
+
description: Unprocessable Entity
|
|
10741
|
+
content:
|
|
10742
|
+
application/json:
|
|
10743
|
+
schema:
|
|
10744
|
+
type: object
|
|
10745
|
+
properties:
|
|
10746
|
+
message:
|
|
10747
|
+
type: string
|
|
10748
|
+
description: A human-readable description of the error.
|
|
10749
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
10750
|
+
required:
|
|
10751
|
+
- message
|
|
10752
|
+
summary: List authorized applications
|
|
10753
|
+
tags:
|
|
10754
|
+
- organizations.authorized-applications
|
|
10666
10755
|
/portal/generate_link:
|
|
10667
10756
|
post:
|
|
10668
10757
|
description: Generate a Portal Link scoped to an Organization.
|
|
@@ -15144,7 +15233,6 @@ paths:
|
|
|
15144
15233
|
summary: List groups
|
|
15145
15234
|
tags:
|
|
15146
15235
|
- user-management.organization-membership.groups
|
|
15147
|
-
x-feature-flag: user-groups-enabled
|
|
15148
15236
|
/user_management/password_reset:
|
|
15149
15237
|
post:
|
|
15150
15238
|
description: Creates a one-time token that can be used to reset a user's password.
|
|
@@ -19098,6 +19186,8 @@ tags:
|
|
|
19098
19186
|
description: Manage organizations.
|
|
19099
19187
|
- name: organizations.api_keys
|
|
19100
19188
|
description: Manage organization-scoped API keys.
|
|
19189
|
+
- name: organizations.authorized-applications
|
|
19190
|
+
description: Manage authorized applications for organizations.
|
|
19101
19191
|
- name: organizations.feature-flags
|
|
19102
19192
|
description: Manage organization-scoped feature flags.
|
|
19103
19193
|
- name: permissions
|
|
@@ -22879,6 +22969,81 @@ components:
|
|
|
22879
22969
|
- object
|
|
22880
22970
|
- data
|
|
22881
22971
|
- list_metadata
|
|
22972
|
+
OrganizationAuthorizedConnectApplicationList:
|
|
22973
|
+
type: object
|
|
22974
|
+
properties:
|
|
22975
|
+
object:
|
|
22976
|
+
type: string
|
|
22977
|
+
description: Indicates this is a list response.
|
|
22978
|
+
const: list
|
|
22979
|
+
data:
|
|
22980
|
+
type: array
|
|
22981
|
+
items:
|
|
22982
|
+
type: object
|
|
22983
|
+
properties:
|
|
22984
|
+
object:
|
|
22985
|
+
type: string
|
|
22986
|
+
description: Distinguishes the authorized connect application object.
|
|
22987
|
+
const: authorized_connect_application
|
|
22988
|
+
id:
|
|
22989
|
+
type: string
|
|
22990
|
+
description: The unique ID of the authorized connect application.
|
|
22991
|
+
example: authorized_connect_app_01HXYZ123456789ABCDEFGHIJ
|
|
22992
|
+
granted_scopes:
|
|
22993
|
+
type: array
|
|
22994
|
+
items:
|
|
22995
|
+
type: string
|
|
22996
|
+
description: The scopes granted by the user to the application.
|
|
22997
|
+
example:
|
|
22998
|
+
- openid
|
|
22999
|
+
- profile
|
|
23000
|
+
- email
|
|
23001
|
+
oauth_resource:
|
|
23002
|
+
type: string
|
|
23003
|
+
description: >-
|
|
23004
|
+
The OAuth resource associated with the authorized connect
|
|
23005
|
+
application, if one was requested.
|
|
23006
|
+
example: https://api.example.com/resource
|
|
23007
|
+
application:
|
|
23008
|
+
$ref: '#/components/schemas/ConnectApplication'
|
|
23009
|
+
user_id:
|
|
23010
|
+
type: string
|
|
23011
|
+
description: The ID of the user who authorized the application.
|
|
23012
|
+
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
23013
|
+
required:
|
|
23014
|
+
- object
|
|
23015
|
+
- id
|
|
23016
|
+
- granted_scopes
|
|
23017
|
+
- application
|
|
23018
|
+
- user_id
|
|
23019
|
+
description: The list of records for the current page.
|
|
23020
|
+
list_metadata:
|
|
23021
|
+
type: object
|
|
23022
|
+
properties:
|
|
23023
|
+
before:
|
|
23024
|
+
type:
|
|
23025
|
+
- string
|
|
23026
|
+
- 'null'
|
|
23027
|
+
description: >-
|
|
23028
|
+
An object ID that defines your place in the list. When the ID is
|
|
23029
|
+
not present, you are at the start of the list.
|
|
23030
|
+
example: authorized_connect_app_01HXYZ123456789ABCDEFGHIJ
|
|
23031
|
+
after:
|
|
23032
|
+
type:
|
|
23033
|
+
- string
|
|
23034
|
+
- 'null'
|
|
23035
|
+
description: >-
|
|
23036
|
+
An object ID that defines your place in the list. When the ID is
|
|
23037
|
+
not present, you are at the end of the list.
|
|
23038
|
+
example: authorized_connect_app_01HXYZ987654321KJIHGFEDCBA
|
|
23039
|
+
required:
|
|
23040
|
+
- before
|
|
23041
|
+
- after
|
|
23042
|
+
description: Pagination cursors for navigating between pages of results.
|
|
23043
|
+
required:
|
|
23044
|
+
- object
|
|
23045
|
+
- data
|
|
23046
|
+
- list_metadata
|
|
22882
23047
|
NewConnectApplicationSecret:
|
|
22883
23048
|
type: object
|
|
22884
23049
|
properties:
|
package/dist/services.mjs
CHANGED
|
@@ -645,6 +645,11 @@ const serviceEndpoints = {
|
|
|
645
645
|
"path": "/organizations/{id}/audit_log_configuration",
|
|
646
646
|
"name": "get_audit_log_configuration"
|
|
647
647
|
},
|
|
648
|
+
{
|
|
649
|
+
"method": "GET",
|
|
650
|
+
"path": "/organizations/{organization_id}/authorized_applications",
|
|
651
|
+
"name": "list_authorized_applications"
|
|
652
|
+
},
|
|
648
653
|
{
|
|
649
654
|
"method": "GET",
|
|
650
655
|
"path": "/organizations/external_id/{external_id}",
|
package/dist/types.d.ts
CHANGED
|
@@ -1793,6 +1793,26 @@ export interface paths {
|
|
|
1793
1793
|
patch?: never;
|
|
1794
1794
|
trace?: never;
|
|
1795
1795
|
};
|
|
1796
|
+
"/organizations/{organization_id}/authorized_applications": {
|
|
1797
|
+
parameters: {
|
|
1798
|
+
query?: never;
|
|
1799
|
+
header?: never;
|
|
1800
|
+
path?: never;
|
|
1801
|
+
cookie?: never;
|
|
1802
|
+
};
|
|
1803
|
+
/**
|
|
1804
|
+
* List authorized applications
|
|
1805
|
+
* @description Get a list of all Connect applications that users in the organization have authorized.
|
|
1806
|
+
*/
|
|
1807
|
+
get: operations["OrganizationAuthorizedApplicationsController_list"];
|
|
1808
|
+
put?: never;
|
|
1809
|
+
post?: never;
|
|
1810
|
+
delete?: never;
|
|
1811
|
+
options?: never;
|
|
1812
|
+
head?: never;
|
|
1813
|
+
patch?: never;
|
|
1814
|
+
trace?: never;
|
|
1815
|
+
};
|
|
1796
1816
|
"/portal/generate_link": {
|
|
1797
1817
|
parameters: {
|
|
1798
1818
|
query?: never;
|
|
@@ -5684,6 +5704,59 @@ export interface components {
|
|
|
5684
5704
|
after: string | null;
|
|
5685
5705
|
};
|
|
5686
5706
|
};
|
|
5707
|
+
OrganizationAuthorizedConnectApplicationList: {
|
|
5708
|
+
/**
|
|
5709
|
+
* @description Indicates this is a list response.
|
|
5710
|
+
* @constant
|
|
5711
|
+
*/
|
|
5712
|
+
object: "list";
|
|
5713
|
+
/** @description The list of records for the current page. */
|
|
5714
|
+
data: {
|
|
5715
|
+
/**
|
|
5716
|
+
* @description Distinguishes the authorized connect application object.
|
|
5717
|
+
* @constant
|
|
5718
|
+
*/
|
|
5719
|
+
object: "authorized_connect_application";
|
|
5720
|
+
/**
|
|
5721
|
+
* @description The unique ID of the authorized connect application.
|
|
5722
|
+
* @example authorized_connect_app_01HXYZ123456789ABCDEFGHIJ
|
|
5723
|
+
*/
|
|
5724
|
+
id: string;
|
|
5725
|
+
/**
|
|
5726
|
+
* @description The scopes granted by the user to the application.
|
|
5727
|
+
* @example [
|
|
5728
|
+
* "openid",
|
|
5729
|
+
* "profile",
|
|
5730
|
+
* "email"
|
|
5731
|
+
* ]
|
|
5732
|
+
*/
|
|
5733
|
+
granted_scopes: string[];
|
|
5734
|
+
/**
|
|
5735
|
+
* @description The OAuth resource associated with the authorized connect application, if one was requested.
|
|
5736
|
+
* @example https://api.example.com/resource
|
|
5737
|
+
*/
|
|
5738
|
+
oauth_resource?: string;
|
|
5739
|
+
application: components["schemas"]["ConnectApplication"];
|
|
5740
|
+
/**
|
|
5741
|
+
* @description The ID of the user who authorized the application.
|
|
5742
|
+
* @example user_01E4ZCR3C56J083X43JQXF3JK5
|
|
5743
|
+
*/
|
|
5744
|
+
user_id: string;
|
|
5745
|
+
}[];
|
|
5746
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
5747
|
+
list_metadata: {
|
|
5748
|
+
/**
|
|
5749
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
|
|
5750
|
+
* @example authorized_connect_app_01HXYZ123456789ABCDEFGHIJ
|
|
5751
|
+
*/
|
|
5752
|
+
before: string | null;
|
|
5753
|
+
/**
|
|
5754
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
|
|
5755
|
+
* @example authorized_connect_app_01HXYZ987654321KJIHGFEDCBA
|
|
5756
|
+
*/
|
|
5757
|
+
after: string | null;
|
|
5758
|
+
};
|
|
5759
|
+
};
|
|
5687
5760
|
NewConnectApplicationSecret: {
|
|
5688
5761
|
/**
|
|
5689
5762
|
* @description Distinguishes the connect application secret object.
|
|
@@ -26396,6 +26469,68 @@ export interface operations {
|
|
|
26396
26469
|
};
|
|
26397
26470
|
};
|
|
26398
26471
|
};
|
|
26472
|
+
OrganizationAuthorizedApplicationsController_list: {
|
|
26473
|
+
parameters: {
|
|
26474
|
+
query?: {
|
|
26475
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`. */
|
|
26476
|
+
before?: string;
|
|
26477
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`. */
|
|
26478
|
+
after?: string;
|
|
26479
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
26480
|
+
limit?: number;
|
|
26481
|
+
/** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). */
|
|
26482
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
26483
|
+
};
|
|
26484
|
+
header?: never;
|
|
26485
|
+
path: {
|
|
26486
|
+
/** @description The ID of the organization. */
|
|
26487
|
+
organization_id: string;
|
|
26488
|
+
};
|
|
26489
|
+
cookie?: never;
|
|
26490
|
+
};
|
|
26491
|
+
requestBody?: never;
|
|
26492
|
+
responses: {
|
|
26493
|
+
/** @description OK */
|
|
26494
|
+
200: {
|
|
26495
|
+
headers: {
|
|
26496
|
+
[name: string]: unknown;
|
|
26497
|
+
};
|
|
26498
|
+
content: {
|
|
26499
|
+
"application/json": components["schemas"]["OrganizationAuthorizedConnectApplicationList"];
|
|
26500
|
+
};
|
|
26501
|
+
};
|
|
26502
|
+
/** @description Not Found */
|
|
26503
|
+
404: {
|
|
26504
|
+
headers: {
|
|
26505
|
+
[name: string]: unknown;
|
|
26506
|
+
};
|
|
26507
|
+
content: {
|
|
26508
|
+
"application/json": {
|
|
26509
|
+
/**
|
|
26510
|
+
* @description A human-readable description of the error.
|
|
26511
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26512
|
+
*/
|
|
26513
|
+
message: string;
|
|
26514
|
+
};
|
|
26515
|
+
};
|
|
26516
|
+
};
|
|
26517
|
+
/** @description Unprocessable Entity */
|
|
26518
|
+
422: {
|
|
26519
|
+
headers: {
|
|
26520
|
+
[name: string]: unknown;
|
|
26521
|
+
};
|
|
26522
|
+
content: {
|
|
26523
|
+
"application/json": {
|
|
26524
|
+
/**
|
|
26525
|
+
* @description A human-readable description of the error.
|
|
26526
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26527
|
+
*/
|
|
26528
|
+
message: string;
|
|
26529
|
+
};
|
|
26530
|
+
};
|
|
26531
|
+
};
|
|
26532
|
+
};
|
|
26533
|
+
};
|
|
26399
26534
|
PortalSessionsController_create: {
|
|
26400
26535
|
parameters: {
|
|
26401
26536
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workos/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.42.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.26.1"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|
|
36
36
|
"generate:services": "node scripts/generate-services.mjs",
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"devDependencies": {
|
|
62
62
|
"@types/js-yaml": "^4.0.9",
|
|
63
63
|
"@types/node": "^26.1.1",
|
|
64
|
-
"@workos/oagen-emitters": "^0.
|
|
64
|
+
"@workos/oagen-emitters": "^0.20.1",
|
|
65
65
|
"diff2html": "^3.4.56",
|
|
66
66
|
"husky": "^9.1.7",
|
|
67
67
|
"js-yaml": "^4.1.1",
|