@workos/openapi-spec 0.73.0 → 0.75.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 +70 -2
- package/dist/types.d.ts +62 -2
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -15404,7 +15404,7 @@ paths:
|
|
|
15404
15404
|
content:
|
|
15405
15405
|
application/json:
|
|
15406
15406
|
schema:
|
|
15407
|
-
$ref: '#/components/schemas/
|
|
15407
|
+
$ref: '#/components/schemas/TokenQueryDto'
|
|
15408
15408
|
responses:
|
|
15409
15409
|
'200':
|
|
15410
15410
|
description: OK
|
|
@@ -15794,6 +15794,53 @@ paths:
|
|
|
15794
15794
|
- code
|
|
15795
15795
|
- pending_authentication_token
|
|
15796
15796
|
- authentication_challenge_id
|
|
15797
|
+
- type: object
|
|
15798
|
+
properties:
|
|
15799
|
+
client_id:
|
|
15800
|
+
type: string
|
|
15801
|
+
description: The client ID of the application.
|
|
15802
|
+
example: client_01HXYZ123456789ABCDEFGHIJ
|
|
15803
|
+
client_secret:
|
|
15804
|
+
type: string
|
|
15805
|
+
description: The client secret of the application.
|
|
15806
|
+
example: sk_test_....
|
|
15807
|
+
grant_type:
|
|
15808
|
+
type: string
|
|
15809
|
+
const: urn:workos:oauth:grant-type:email-completion
|
|
15810
|
+
email_completion_token:
|
|
15811
|
+
type: string
|
|
15812
|
+
description: The token from the `email_completion_required` response.
|
|
15813
|
+
example: JZ8kQ2mR5vT7wX1yA3bC6dE9f
|
|
15814
|
+
email:
|
|
15815
|
+
type: string
|
|
15816
|
+
description: >-
|
|
15817
|
+
The email address the user supplied for a profile the
|
|
15818
|
+
identity provider left without one.
|
|
15819
|
+
example: marcelina@example.com
|
|
15820
|
+
ip_address:
|
|
15821
|
+
type: string
|
|
15822
|
+
description: The IP address of the user's request.
|
|
15823
|
+
example: 203.0.113.42
|
|
15824
|
+
device_id:
|
|
15825
|
+
type: string
|
|
15826
|
+
description: A unique identifier for the device.
|
|
15827
|
+
example: device_01HXYZ123456789ABCDEFGHIJ
|
|
15828
|
+
user_agent:
|
|
15829
|
+
type: string
|
|
15830
|
+
description: The user agent string from the user's browser.
|
|
15831
|
+
example: Mozilla/5.0
|
|
15832
|
+
signals_id:
|
|
15833
|
+
type: string
|
|
15834
|
+
description: >-
|
|
15835
|
+
An optional Radar signals ID to correlate client-side
|
|
15836
|
+
signals with this authentication attempt.
|
|
15837
|
+
example: 01JBS0GN92GC2RJQS4X9DBPQ2A
|
|
15838
|
+
required:
|
|
15839
|
+
- client_id
|
|
15840
|
+
- client_secret
|
|
15841
|
+
- grant_type
|
|
15842
|
+
- email_completion_token
|
|
15843
|
+
- email
|
|
15797
15844
|
- type: object
|
|
15798
15845
|
properties:
|
|
15799
15846
|
client_id:
|
|
@@ -16550,6 +16597,27 @@ paths:
|
|
|
16550
16597
|
required:
|
|
16551
16598
|
- code
|
|
16552
16599
|
- message
|
|
16600
|
+
- type: object
|
|
16601
|
+
properties:
|
|
16602
|
+
code:
|
|
16603
|
+
type: string
|
|
16604
|
+
description: The error code identifying the type of error.
|
|
16605
|
+
example: email_completion_required
|
|
16606
|
+
const: email_completion_required
|
|
16607
|
+
message:
|
|
16608
|
+
type: string
|
|
16609
|
+
description: A human-readable description of the error.
|
|
16610
|
+
example: Request could not be processed.
|
|
16611
|
+
email_completion_token:
|
|
16612
|
+
type: string
|
|
16613
|
+
description: >-
|
|
16614
|
+
Pass this to the `email-completion` grant, with the
|
|
16615
|
+
address the user supplies, to finish authenticating.
|
|
16616
|
+
example: JZ8kQ2mR5vT7wX1yA3bC6dE9f
|
|
16617
|
+
required:
|
|
16618
|
+
- code
|
|
16619
|
+
- message
|
|
16620
|
+
- email_completion_token
|
|
16553
16621
|
- type: object
|
|
16554
16622
|
properties:
|
|
16555
16623
|
code:
|
|
@@ -27385,7 +27453,7 @@ components:
|
|
|
27385
27453
|
required:
|
|
27386
27454
|
- organization_id
|
|
27387
27455
|
- user_id
|
|
27388
|
-
|
|
27456
|
+
TokenQueryDto:
|
|
27389
27457
|
type: object
|
|
27390
27458
|
properties:
|
|
27391
27459
|
client_id:
|
package/dist/types.d.ts
CHANGED
|
@@ -5955,7 +5955,7 @@ export interface components {
|
|
|
5955
5955
|
*/
|
|
5956
5956
|
user_id: string;
|
|
5957
5957
|
};
|
|
5958
|
-
|
|
5958
|
+
TokenQueryDto: {
|
|
5959
5959
|
/**
|
|
5960
5960
|
* @description The client ID of the WorkOS environment.
|
|
5961
5961
|
* @example client_01HZBC6N1EB1ZY7KG32X
|
|
@@ -32938,7 +32938,7 @@ export interface operations {
|
|
|
32938
32938
|
};
|
|
32939
32939
|
requestBody: {
|
|
32940
32940
|
content: {
|
|
32941
|
-
"application/json": components["schemas"]["
|
|
32941
|
+
"application/json": components["schemas"]["TokenQueryDto"];
|
|
32942
32942
|
};
|
|
32943
32943
|
};
|
|
32944
32944
|
responses: {
|
|
@@ -33308,6 +33308,49 @@ export interface operations {
|
|
|
33308
33308
|
* @example Mozilla/5.0
|
|
33309
33309
|
*/
|
|
33310
33310
|
user_agent?: string;
|
|
33311
|
+
} | {
|
|
33312
|
+
/**
|
|
33313
|
+
* @description The client ID of the application.
|
|
33314
|
+
* @example client_01HXYZ123456789ABCDEFGHIJ
|
|
33315
|
+
*/
|
|
33316
|
+
client_id: string;
|
|
33317
|
+
/**
|
|
33318
|
+
* @description The client secret of the application.
|
|
33319
|
+
* @example sk_test_....
|
|
33320
|
+
*/
|
|
33321
|
+
client_secret: string;
|
|
33322
|
+
/** @constant */
|
|
33323
|
+
grant_type: "urn:workos:oauth:grant-type:email-completion";
|
|
33324
|
+
/**
|
|
33325
|
+
* @description The token from the `email_completion_required` response.
|
|
33326
|
+
* @example JZ8kQ2mR5vT7wX1yA3bC6dE9f
|
|
33327
|
+
*/
|
|
33328
|
+
email_completion_token: string;
|
|
33329
|
+
/**
|
|
33330
|
+
* @description The email address the user supplied for a profile the identity provider left without one.
|
|
33331
|
+
* @example marcelina@example.com
|
|
33332
|
+
*/
|
|
33333
|
+
email: string;
|
|
33334
|
+
/**
|
|
33335
|
+
* @description The IP address of the user's request.
|
|
33336
|
+
* @example 203.0.113.42
|
|
33337
|
+
*/
|
|
33338
|
+
ip_address?: string;
|
|
33339
|
+
/**
|
|
33340
|
+
* @description A unique identifier for the device.
|
|
33341
|
+
* @example device_01HXYZ123456789ABCDEFGHIJ
|
|
33342
|
+
*/
|
|
33343
|
+
device_id?: string;
|
|
33344
|
+
/**
|
|
33345
|
+
* @description The user agent string from the user's browser.
|
|
33346
|
+
* @example Mozilla/5.0
|
|
33347
|
+
*/
|
|
33348
|
+
user_agent?: string;
|
|
33349
|
+
/**
|
|
33350
|
+
* @description An optional Radar signals ID to correlate client-side signals with this authentication attempt.
|
|
33351
|
+
* @example 01JBS0GN92GC2RJQS4X9DBPQ2A
|
|
33352
|
+
*/
|
|
33353
|
+
signals_id?: string;
|
|
33311
33354
|
} | {
|
|
33312
33355
|
/**
|
|
33313
33356
|
* @description The client ID of the application.
|
|
@@ -33953,6 +33996,23 @@ export interface operations {
|
|
|
33953
33996
|
* @example Request could not be processed.
|
|
33954
33997
|
*/
|
|
33955
33998
|
message: string;
|
|
33999
|
+
} | {
|
|
34000
|
+
/**
|
|
34001
|
+
* @description The error code identifying the type of error.
|
|
34002
|
+
* @example email_completion_required
|
|
34003
|
+
* @constant
|
|
34004
|
+
*/
|
|
34005
|
+
code: "email_completion_required";
|
|
34006
|
+
/**
|
|
34007
|
+
* @description A human-readable description of the error.
|
|
34008
|
+
* @example Request could not be processed.
|
|
34009
|
+
*/
|
|
34010
|
+
message: string;
|
|
34011
|
+
/**
|
|
34012
|
+
* @description Pass this to the `email-completion` grant, with the address the user supplies, to finish authenticating.
|
|
34013
|
+
* @example JZ8kQ2mR5vT7wX1yA3bC6dE9f
|
|
34014
|
+
*/
|
|
34015
|
+
email_completion_token: string;
|
|
33956
34016
|
} | {
|
|
33957
34017
|
/**
|
|
33958
34018
|
* @description The error code identifying the type of error.
|