@workos/openapi-spec 0.41.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 -0
- 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
|
@@ -10655,6 +10655,103 @@ paths:
|
|
|
10655
10655
|
summary: Remove a member from a Group
|
|
10656
10656
|
tags:
|
|
10657
10657
|
- groups
|
|
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
|
|
10658
10755
|
/portal/generate_link:
|
|
10659
10756
|
post:
|
|
10660
10757
|
description: Generate a Portal Link scoped to an Organization.
|
|
@@ -19089,6 +19186,8 @@ tags:
|
|
|
19089
19186
|
description: Manage organizations.
|
|
19090
19187
|
- name: organizations.api_keys
|
|
19091
19188
|
description: Manage organization-scoped API keys.
|
|
19189
|
+
- name: organizations.authorized-applications
|
|
19190
|
+
description: Manage authorized applications for organizations.
|
|
19092
19191
|
- name: organizations.feature-flags
|
|
19093
19192
|
description: Manage organization-scoped feature flags.
|
|
19094
19193
|
- name: permissions
|
|
@@ -22870,6 +22969,81 @@ components:
|
|
|
22870
22969
|
- object
|
|
22871
22970
|
- data
|
|
22872
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
|
|
22873
23047
|
NewConnectApplicationSecret:
|
|
22874
23048
|
type: object
|
|
22875
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",
|