@workos/openapi-spec 0.21.0 → 0.23.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 -30
- package/dist/types.d.ts +19 -4
- package/package.json +2 -2
package/dist/open-api-spec.yaml
CHANGED
|
@@ -13,36 +13,56 @@ paths:
|
|
|
13
13
|
content:
|
|
14
14
|
application/json:
|
|
15
15
|
schema:
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
16
|
+
discriminator:
|
|
17
|
+
propertyName: type
|
|
18
|
+
oneOf:
|
|
19
|
+
- type: object
|
|
20
|
+
properties:
|
|
21
|
+
type:
|
|
22
|
+
type: string
|
|
23
|
+
description: >-
|
|
24
|
+
The kind of credential being validated — an agent API
|
|
25
|
+
key or an agent access token.
|
|
26
|
+
const: api_key
|
|
27
|
+
credential:
|
|
28
|
+
type: string
|
|
29
|
+
minLength: 1
|
|
30
|
+
description: >-
|
|
31
|
+
The credential value to validate: the API key value for
|
|
32
|
+
`api_key`, or the access token (JWT) for `access_token`.
|
|
33
|
+
example: sk_agent_example_1234567890
|
|
34
|
+
required:
|
|
35
|
+
- type
|
|
36
|
+
- credential
|
|
37
|
+
- type: object
|
|
38
|
+
properties:
|
|
39
|
+
type:
|
|
40
|
+
type: string
|
|
41
|
+
description: >-
|
|
42
|
+
The kind of credential being validated — an agent API
|
|
43
|
+
key or an agent access token.
|
|
44
|
+
const: access_token
|
|
45
|
+
credential:
|
|
46
|
+
type: string
|
|
47
|
+
minLength: 1
|
|
48
|
+
description: >-
|
|
49
|
+
The credential value to validate: the API key value for
|
|
50
|
+
`api_key`, or the access token (JWT) for `access_token`.
|
|
51
|
+
example: eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
52
|
+
audience:
|
|
53
|
+
type: string
|
|
54
|
+
minLength: 1
|
|
55
|
+
description: >-
|
|
56
|
+
When provided, the access token's `aud` claim is
|
|
57
|
+
verified against this value. Tokens issued for a
|
|
58
|
+
different resource are rejected.
|
|
59
|
+
example: https://api.example.com
|
|
60
|
+
required:
|
|
61
|
+
- type
|
|
62
|
+
- credential
|
|
63
|
+
description: >-
|
|
64
|
+
The agent credential to validate. Either an `api_key` or an
|
|
65
|
+
`access_token`, discriminated by `type`.
|
|
46
66
|
responses:
|
|
47
67
|
'200':
|
|
48
68
|
description: OK
|
|
@@ -23939,6 +23959,13 @@ components:
|
|
|
23939
23959
|
- object
|
|
23940
23960
|
- domain
|
|
23941
23961
|
description: List of Organization Domains.
|
|
23962
|
+
callback_endpoint:
|
|
23963
|
+
type: string
|
|
23964
|
+
description: >-
|
|
23965
|
+
The immutable callback endpoint for this Connection. For SAML
|
|
23966
|
+
connections this is the ACS URL; for OIDC connections this is the
|
|
23967
|
+
redirect URI.
|
|
23968
|
+
example: https://auth.workos.com/sso/saml/acs/conn_externalkey
|
|
23942
23969
|
options:
|
|
23943
23970
|
type: object
|
|
23944
23971
|
properties:
|
package/dist/types.d.ts
CHANGED
|
@@ -6606,6 +6606,11 @@ export interface components {
|
|
|
6606
6606
|
*/
|
|
6607
6607
|
domain: string;
|
|
6608
6608
|
}[];
|
|
6609
|
+
/**
|
|
6610
|
+
* @description The immutable callback endpoint for this Connection. For SAML connections this is the ACS URL; for OIDC connections this is the redirect URI.
|
|
6611
|
+
* @example https://auth.workos.com/sso/saml/acs/conn_externalkey
|
|
6612
|
+
*/
|
|
6613
|
+
callback_endpoint?: string;
|
|
6609
6614
|
/** @description Configuration options for SAML connections. Only present for SAML connection types. */
|
|
6610
6615
|
options?: {
|
|
6611
6616
|
/**
|
|
@@ -16527,17 +16532,27 @@ export interface operations {
|
|
|
16527
16532
|
"application/json": {
|
|
16528
16533
|
/**
|
|
16529
16534
|
* @description The kind of credential being validated — an agent API key or an agent access token.
|
|
16530
|
-
* @
|
|
16531
|
-
* @enum {string}
|
|
16535
|
+
* @constant
|
|
16532
16536
|
*/
|
|
16533
|
-
type: "api_key"
|
|
16537
|
+
type: "api_key";
|
|
16534
16538
|
/**
|
|
16535
16539
|
* @description The credential value to validate: the API key value for `api_key`, or the access token (JWT) for `access_token`.
|
|
16536
16540
|
* @example sk_agent_example_1234567890
|
|
16537
16541
|
*/
|
|
16538
16542
|
credential: string;
|
|
16543
|
+
} | {
|
|
16544
|
+
/**
|
|
16545
|
+
* @description The kind of credential being validated — an agent API key or an agent access token.
|
|
16546
|
+
* @constant
|
|
16547
|
+
*/
|
|
16548
|
+
type: "access_token";
|
|
16549
|
+
/**
|
|
16550
|
+
* @description The credential value to validate: the API key value for `api_key`, or the access token (JWT) for `access_token`.
|
|
16551
|
+
* @example eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
16552
|
+
*/
|
|
16553
|
+
credential: string;
|
|
16539
16554
|
/**
|
|
16540
|
-
* @description
|
|
16555
|
+
* @description When provided, the access token's `aud` claim is verified against this value. Tokens issued for a different resource are rejected.
|
|
16541
16556
|
* @example https://api.example.com
|
|
16542
16557
|
*/
|
|
16543
16558
|
audience?: string;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workos/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.23.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
|
|
6
6
|
"license": "MIT",
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"devDependencies": {
|
|
62
62
|
"@types/js-yaml": "^4.0.9",
|
|
63
63
|
"@types/node": "^26.1.0",
|
|
64
|
-
"@workos/oagen-emitters": "^0.19.
|
|
64
|
+
"@workos/oagen-emitters": "^0.19.9",
|
|
65
65
|
"diff2html": "^3.4.56",
|
|
66
66
|
"husky": "^9.1.7",
|
|
67
67
|
"js-yaml": "^4.1.1",
|