@workos/openapi-spec 0.59.0 → 0.60.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 +229 -33
- package/dist/types.d.ts +124 -14
- package/package.json +7 -8
package/dist/open-api-spec.yaml
CHANGED
|
@@ -7089,6 +7089,7 @@ paths:
|
|
|
7089
7089
|
- GoogleOIDC
|
|
7090
7090
|
- GoogleSAML
|
|
7091
7091
|
- GrokOAuth
|
|
7092
|
+
- XOAuth
|
|
7092
7093
|
- IntuitOAuth
|
|
7093
7094
|
- JumpCloudSAML
|
|
7094
7095
|
- KeycloakSAML
|
|
@@ -12531,11 +12532,19 @@ paths:
|
|
|
12531
12532
|
example: '123456'
|
|
12532
12533
|
verification_id:
|
|
12533
12534
|
type: string
|
|
12534
|
-
description:
|
|
12535
|
+
description: >-
|
|
12536
|
+
The ID of the Radar SMS verification being confirmed.
|
|
12537
|
+
Required for sign-up challenges; omitted for sign-in
|
|
12538
|
+
challenges, where the verification is resolved
|
|
12539
|
+
server-side.
|
|
12535
12540
|
example: vrf_01HXYZ123456789ABCDEFGHIJ
|
|
12536
12541
|
phone_number:
|
|
12537
12542
|
type: string
|
|
12538
|
-
description:
|
|
12543
|
+
description: >-
|
|
12544
|
+
The phone number the Radar SMS challenge was sent to.
|
|
12545
|
+
Required for sign-up challenges; omitted for sign-in
|
|
12546
|
+
challenges, where the phone number on file is resolved
|
|
12547
|
+
server-side.
|
|
12539
12548
|
example: '+15555550123'
|
|
12540
12549
|
pending_authentication_token:
|
|
12541
12550
|
type: string
|
|
@@ -12560,8 +12569,6 @@ paths:
|
|
|
12560
12569
|
- client_secret
|
|
12561
12570
|
- grant_type
|
|
12562
12571
|
- code
|
|
12563
|
-
- verification_id
|
|
12564
|
-
- phone_number
|
|
12565
12572
|
- pending_authentication_token
|
|
12566
12573
|
- type: object
|
|
12567
12574
|
properties:
|
|
@@ -12731,6 +12738,34 @@ paths:
|
|
|
12731
12738
|
required:
|
|
12732
12739
|
- code
|
|
12733
12740
|
- message
|
|
12741
|
+
- type: object
|
|
12742
|
+
properties:
|
|
12743
|
+
code:
|
|
12744
|
+
type: string
|
|
12745
|
+
description: The error code identifying the type of error.
|
|
12746
|
+
example: phone_number_required
|
|
12747
|
+
const: phone_number_required
|
|
12748
|
+
message:
|
|
12749
|
+
type: string
|
|
12750
|
+
description: A human-readable description of the error.
|
|
12751
|
+
example: Request could not be processed.
|
|
12752
|
+
required:
|
|
12753
|
+
- code
|
|
12754
|
+
- message
|
|
12755
|
+
- type: object
|
|
12756
|
+
properties:
|
|
12757
|
+
code:
|
|
12758
|
+
type: string
|
|
12759
|
+
description: The error code identifying the type of error.
|
|
12760
|
+
example: verification_id_required
|
|
12761
|
+
const: verification_id_required
|
|
12762
|
+
message:
|
|
12763
|
+
type: string
|
|
12764
|
+
description: A human-readable description of the error.
|
|
12765
|
+
example: Request could not be processed.
|
|
12766
|
+
required:
|
|
12767
|
+
- code
|
|
12768
|
+
- message
|
|
12734
12769
|
- type: object
|
|
12735
12770
|
properties:
|
|
12736
12771
|
error:
|
|
@@ -13231,6 +13266,20 @@ paths:
|
|
|
13231
13266
|
required:
|
|
13232
13267
|
- code
|
|
13233
13268
|
- message
|
|
13269
|
+
- type: object
|
|
13270
|
+
properties:
|
|
13271
|
+
code:
|
|
13272
|
+
type: string
|
|
13273
|
+
description: The error code identifying the type of error.
|
|
13274
|
+
example: radar_sms_sign_in_challenge
|
|
13275
|
+
const: radar_sms_sign_in_challenge
|
|
13276
|
+
message:
|
|
13277
|
+
type: string
|
|
13278
|
+
description: A human-readable description of the error.
|
|
13279
|
+
example: Request could not be processed.
|
|
13280
|
+
required:
|
|
13281
|
+
- code
|
|
13282
|
+
- message
|
|
13234
13283
|
- type: object
|
|
13235
13284
|
properties:
|
|
13236
13285
|
code:
|
|
@@ -16648,6 +16697,20 @@ paths:
|
|
|
16648
16697
|
required:
|
|
16649
16698
|
- code
|
|
16650
16699
|
- message
|
|
16700
|
+
- type: object
|
|
16701
|
+
properties:
|
|
16702
|
+
code:
|
|
16703
|
+
type: string
|
|
16704
|
+
description: The error code identifying the type of error.
|
|
16705
|
+
example: password_salt_position_requires_password_hash
|
|
16706
|
+
const: password_salt_position_requires_password_hash
|
|
16707
|
+
message:
|
|
16708
|
+
type: string
|
|
16709
|
+
description: A human-readable description of the error.
|
|
16710
|
+
example: Request could not be processed.
|
|
16711
|
+
required:
|
|
16712
|
+
- code
|
|
16713
|
+
- message
|
|
16651
16714
|
- type: object
|
|
16652
16715
|
properties:
|
|
16653
16716
|
code:
|
|
@@ -16706,6 +16769,10 @@ paths:
|
|
|
16706
16769
|
hashed:
|
|
16707
16770
|
- password_hash
|
|
16708
16771
|
- password_hash_type
|
|
16772
|
+
- password_salt_position
|
|
16773
|
+
optionalFields:
|
|
16774
|
+
hashed:
|
|
16775
|
+
- password_salt_position
|
|
16709
16776
|
/user_management/users/external_id/{external_id}:
|
|
16710
16777
|
get:
|
|
16711
16778
|
description: >-
|
|
@@ -16852,6 +16919,20 @@ paths:
|
|
|
16852
16919
|
required:
|
|
16853
16920
|
- code
|
|
16854
16921
|
- message
|
|
16922
|
+
- type: object
|
|
16923
|
+
properties:
|
|
16924
|
+
code:
|
|
16925
|
+
type: string
|
|
16926
|
+
description: The error code identifying the type of error.
|
|
16927
|
+
example: password_salt_position_requires_password_hash
|
|
16928
|
+
const: password_salt_position_requires_password_hash
|
|
16929
|
+
message:
|
|
16930
|
+
type: string
|
|
16931
|
+
description: A human-readable description of the error.
|
|
16932
|
+
example: Request could not be processed.
|
|
16933
|
+
required:
|
|
16934
|
+
- code
|
|
16935
|
+
- message
|
|
16855
16936
|
- type: object
|
|
16856
16937
|
properties:
|
|
16857
16938
|
code:
|
|
@@ -16972,7 +17053,7 @@ paths:
|
|
|
16972
17053
|
summary: Update a user
|
|
16973
17054
|
tags:
|
|
16974
17055
|
- user-management.users
|
|
16975
|
-
x-mutually-exclusive-body-groups: &
|
|
17056
|
+
x-mutually-exclusive-body-groups: &ref_16
|
|
16976
17057
|
password:
|
|
16977
17058
|
optional: true
|
|
16978
17059
|
variants:
|
|
@@ -16981,6 +17062,10 @@ paths:
|
|
|
16981
17062
|
hashed:
|
|
16982
17063
|
- password_hash
|
|
16983
17064
|
- password_hash_type
|
|
17065
|
+
- password_salt_position
|
|
17066
|
+
optionalFields:
|
|
17067
|
+
hashed:
|
|
17068
|
+
- password_salt_position
|
|
16984
17069
|
get:
|
|
16985
17070
|
description: Get the details of an existing user.
|
|
16986
17071
|
operationId: UserlandUsersController_get[0]
|
|
@@ -17732,6 +17817,7 @@ paths:
|
|
|
17732
17817
|
- GitLabOAuth
|
|
17733
17818
|
- GoogleOAuth
|
|
17734
17819
|
- GrokOAuth
|
|
17820
|
+
- XOAuth
|
|
17735
17821
|
- IntuitOAuth
|
|
17736
17822
|
- LinkedInOAuth
|
|
17737
17823
|
- MicrosoftOAuth
|
|
@@ -22125,6 +22211,11 @@ components:
|
|
|
22125
22211
|
x-exclude-from-lint: true
|
|
22126
22212
|
required:
|
|
22127
22213
|
- password_hash_type
|
|
22214
|
+
- properties:
|
|
22215
|
+
password_salt_position:
|
|
22216
|
+
x-exclude-from-lint: true
|
|
22217
|
+
required:
|
|
22218
|
+
- password_salt_position
|
|
22128
22219
|
- type: object
|
|
22129
22220
|
properties:
|
|
22130
22221
|
password:
|
|
@@ -22133,7 +22224,8 @@ components:
|
|
|
22133
22224
|
- 'null'
|
|
22134
22225
|
description: >-
|
|
22135
22226
|
The password to set for the user. Mutually exclusive with
|
|
22136
|
-
`password_hash` and
|
|
22227
|
+
`password_hash`, `password_hash_type`, and
|
|
22228
|
+
`password_salt_position`.
|
|
22137
22229
|
example: strong_password_123!
|
|
22138
22230
|
required:
|
|
22139
22231
|
- password
|
|
@@ -22149,6 +22241,11 @@ components:
|
|
|
22149
22241
|
x-exclude-from-lint: true
|
|
22150
22242
|
required:
|
|
22151
22243
|
- password_hash_type
|
|
22244
|
+
- properties:
|
|
22245
|
+
password_salt_position:
|
|
22246
|
+
x-exclude-from-lint: true
|
|
22247
|
+
required:
|
|
22248
|
+
- password_salt_position
|
|
22152
22249
|
- type: object
|
|
22153
22250
|
properties:
|
|
22154
22251
|
password_hash:
|
|
@@ -22172,6 +22269,19 @@ components:
|
|
|
22172
22269
|
when providing a `password_hash`. Required with
|
|
22173
22270
|
`password_hash`. Mutually exclusive with `password`.
|
|
22174
22271
|
example: bcrypt
|
|
22272
|
+
password_salt_position:
|
|
22273
|
+
type: string
|
|
22274
|
+
enum: &ref_15
|
|
22275
|
+
- prefix
|
|
22276
|
+
- suffix
|
|
22277
|
+
description: >-
|
|
22278
|
+
The position of the salt relative to the password when the
|
|
22279
|
+
`password_hash` digest was computed: `prefix` for `hash(salt
|
|
22280
|
+
+ password)` or `suffix` for `hash(password + salt)`. Only
|
|
22281
|
+
supported with the `ssha256` hash type and only valid when a
|
|
22282
|
+
`password_hash` is provided. Defaults to `suffix`. Mutually
|
|
22283
|
+
exclusive with `password`.
|
|
22284
|
+
example: prefix
|
|
22175
22285
|
required:
|
|
22176
22286
|
- password_hash
|
|
22177
22287
|
- password_hash_type
|
|
@@ -22253,13 +22363,19 @@ components:
|
|
|
22253
22363
|
x-exclude-from-lint: true
|
|
22254
22364
|
required:
|
|
22255
22365
|
- password_hash_type
|
|
22366
|
+
- properties:
|
|
22367
|
+
password_salt_position:
|
|
22368
|
+
x-exclude-from-lint: true
|
|
22369
|
+
required:
|
|
22370
|
+
- password_salt_position
|
|
22256
22371
|
- type: object
|
|
22257
22372
|
properties:
|
|
22258
22373
|
password:
|
|
22259
22374
|
type: string
|
|
22260
22375
|
description: >-
|
|
22261
22376
|
The password to set for the user. Mutually exclusive with
|
|
22262
|
-
`password_hash` and
|
|
22377
|
+
`password_hash`, `password_hash_type`, and
|
|
22378
|
+
`password_salt_position`.
|
|
22263
22379
|
example: strong_password_123!
|
|
22264
22380
|
required:
|
|
22265
22381
|
- password
|
|
@@ -22275,6 +22391,11 @@ components:
|
|
|
22275
22391
|
x-exclude-from-lint: true
|
|
22276
22392
|
required:
|
|
22277
22393
|
- password_hash_type
|
|
22394
|
+
- properties:
|
|
22395
|
+
password_salt_position:
|
|
22396
|
+
x-exclude-from-lint: true
|
|
22397
|
+
required:
|
|
22398
|
+
- password_salt_position
|
|
22278
22399
|
- type: object
|
|
22279
22400
|
properties:
|
|
22280
22401
|
password_hash:
|
|
@@ -22291,6 +22412,17 @@ components:
|
|
|
22291
22412
|
when providing a `password_hash`. Required with
|
|
22292
22413
|
`password_hash`. Mutually exclusive with `password`.
|
|
22293
22414
|
example: bcrypt
|
|
22415
|
+
password_salt_position:
|
|
22416
|
+
type: string
|
|
22417
|
+
enum: *ref_15
|
|
22418
|
+
description: >-
|
|
22419
|
+
The position of the salt relative to the password when the
|
|
22420
|
+
`password_hash` digest was computed: `prefix` for `hash(salt
|
|
22421
|
+
+ password)` or `suffix` for `hash(password + salt)`. Only
|
|
22422
|
+
supported with the `ssha256` hash type and only valid when a
|
|
22423
|
+
`password_hash` is provided. Defaults to `suffix`. Mutually
|
|
22424
|
+
exclusive with `password`.
|
|
22425
|
+
example: prefix
|
|
22294
22426
|
required:
|
|
22295
22427
|
- password_hash
|
|
22296
22428
|
- password_hash_type
|
|
@@ -22301,7 +22433,7 @@ components:
|
|
|
22301
22433
|
x-exclude-from-lint: true
|
|
22302
22434
|
required:
|
|
22303
22435
|
- password
|
|
22304
|
-
x-mutually-exclusive-body-groups: *
|
|
22436
|
+
x-mutually-exclusive-body-groups: *ref_16
|
|
22305
22437
|
VerifyEmailAddressDto:
|
|
22306
22438
|
type: object
|
|
22307
22439
|
properties:
|
|
@@ -22376,7 +22508,7 @@ components:
|
|
|
22376
22508
|
description: The events that the Webhook Endpoint is subscribed to.
|
|
22377
22509
|
items:
|
|
22378
22510
|
type: string
|
|
22379
|
-
enum: &
|
|
22511
|
+
enum: &ref_17
|
|
22380
22512
|
- agent.registration.created
|
|
22381
22513
|
- agent.registration.claim.attempt.created
|
|
22382
22514
|
- agent.registration.claim.completed
|
|
@@ -22495,7 +22627,7 @@ components:
|
|
|
22495
22627
|
description: The events that the Webhook Endpoint is subscribed to.
|
|
22496
22628
|
items:
|
|
22497
22629
|
type: string
|
|
22498
|
-
enum: *
|
|
22630
|
+
enum: *ref_17
|
|
22499
22631
|
example:
|
|
22500
22632
|
- user.created
|
|
22501
22633
|
- dsync.user.created
|
|
@@ -24828,6 +24960,7 @@ components:
|
|
|
24828
24960
|
- GoogleOIDC
|
|
24829
24961
|
- GoogleSAML
|
|
24830
24962
|
- GrokOAuth
|
|
24963
|
+
- XOAuth
|
|
24831
24964
|
- IntuitOAuth
|
|
24832
24965
|
- JumpCloudSAML
|
|
24833
24966
|
- KeycloakSAML
|
|
@@ -25797,7 +25930,7 @@ components:
|
|
|
25797
25930
|
description: >-
|
|
25798
25931
|
An object containing the custom attribute mapping for the Directory
|
|
25799
25932
|
Provider.
|
|
25800
|
-
example: &
|
|
25933
|
+
example: &ref_20
|
|
25801
25934
|
department: Engineering
|
|
25802
25935
|
job_title: Software Engineer
|
|
25803
25936
|
role:
|
|
@@ -25981,7 +26114,7 @@ components:
|
|
|
25981
26114
|
type: object
|
|
25982
26115
|
additionalProperties: {}
|
|
25983
26116
|
description: The event payload.
|
|
25984
|
-
example: &
|
|
26117
|
+
example: &ref_18
|
|
25985
26118
|
id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
|
|
25986
26119
|
directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
|
|
25987
26120
|
organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
|
|
@@ -26016,11 +26149,11 @@ components:
|
|
|
26016
26149
|
- data
|
|
26017
26150
|
- created_at
|
|
26018
26151
|
description: An event emitted by WorkOS.
|
|
26019
|
-
example: &
|
|
26152
|
+
example: &ref_25
|
|
26020
26153
|
object: event
|
|
26021
26154
|
id: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
26022
26155
|
event: dsync.user.created
|
|
26023
|
-
data: *
|
|
26156
|
+
data: *ref_18
|
|
26024
26157
|
created_at: '2021-06-25T19:07:33.155Z'
|
|
26025
26158
|
context: {}
|
|
26026
26159
|
- oneOf:
|
|
@@ -26836,7 +26969,7 @@ components:
|
|
|
26836
26969
|
items:
|
|
26837
26970
|
type: string
|
|
26838
26971
|
description: The permissions granted to the API key.
|
|
26839
|
-
example: &
|
|
26972
|
+
example: &ref_19
|
|
26840
26973
|
- users:read
|
|
26841
26974
|
- users:write
|
|
26842
26975
|
created_at:
|
|
@@ -26962,7 +27095,7 @@ components:
|
|
|
26962
27095
|
items:
|
|
26963
27096
|
type: string
|
|
26964
27097
|
description: The permissions granted to the API key.
|
|
26965
|
-
example: *
|
|
27098
|
+
example: *ref_19
|
|
26966
27099
|
created_at:
|
|
26967
27100
|
type: string
|
|
26968
27101
|
description: The timestamp when the API key was created.
|
|
@@ -27086,7 +27219,7 @@ components:
|
|
|
27086
27219
|
items:
|
|
27087
27220
|
type: string
|
|
27088
27221
|
description: The permissions granted to the API key.
|
|
27089
|
-
example: *
|
|
27222
|
+
example: *ref_19
|
|
27090
27223
|
created_at:
|
|
27091
27224
|
type: string
|
|
27092
27225
|
description: The timestamp when the API key was created.
|
|
@@ -28627,6 +28760,7 @@ components:
|
|
|
28627
28760
|
- GoogleOIDC
|
|
28628
28761
|
- GoogleSAML
|
|
28629
28762
|
- GrokOAuth
|
|
28763
|
+
- XOAuth
|
|
28630
28764
|
- IntuitOAuth
|
|
28631
28765
|
- JumpCloudSAML
|
|
28632
28766
|
- KeycloakSAML
|
|
@@ -28793,6 +28927,7 @@ components:
|
|
|
28793
28927
|
- GoogleOIDC
|
|
28794
28928
|
- GoogleSAML
|
|
28795
28929
|
- GrokOAuth
|
|
28930
|
+
- XOAuth
|
|
28796
28931
|
- IntuitOAuth
|
|
28797
28932
|
- JumpCloudSAML
|
|
28798
28933
|
- KeycloakSAML
|
|
@@ -28959,6 +29094,7 @@ components:
|
|
|
28959
29094
|
- GoogleOIDC
|
|
28960
29095
|
- GoogleSAML
|
|
28961
29096
|
- GrokOAuth
|
|
29097
|
+
- XOAuth
|
|
28962
29098
|
- IntuitOAuth
|
|
28963
29099
|
- JumpCloudSAML
|
|
28964
29100
|
- KeycloakSAML
|
|
@@ -29951,7 +30087,7 @@ components:
|
|
|
29951
30087
|
description: >-
|
|
29952
30088
|
An object containing the custom attribute mapping for
|
|
29953
30089
|
the Directory Provider.
|
|
29954
|
-
example: *
|
|
30090
|
+
example: *ref_20
|
|
29955
30091
|
role:
|
|
29956
30092
|
$ref: '#/components/schemas/SlimRole'
|
|
29957
30093
|
roles:
|
|
@@ -30141,7 +30277,7 @@ components:
|
|
|
30141
30277
|
description: >-
|
|
30142
30278
|
Labels assigned to the Feature Flag for categorizing and
|
|
30143
30279
|
filtering.
|
|
30144
|
-
example: &
|
|
30280
|
+
example: &ref_21
|
|
30145
30281
|
- reports
|
|
30146
30282
|
enabled:
|
|
30147
30283
|
type: boolean
|
|
@@ -30302,7 +30438,7 @@ components:
|
|
|
30302
30438
|
description: >-
|
|
30303
30439
|
Labels assigned to the Feature Flag for categorizing and
|
|
30304
30440
|
filtering.
|
|
30305
|
-
example: *
|
|
30441
|
+
example: *ref_21
|
|
30306
30442
|
enabled:
|
|
30307
30443
|
type: boolean
|
|
30308
30444
|
description: >-
|
|
@@ -30462,7 +30598,7 @@ components:
|
|
|
30462
30598
|
description: >-
|
|
30463
30599
|
Labels assigned to the Feature Flag for categorizing and
|
|
30464
30600
|
filtering.
|
|
30465
|
-
example: *
|
|
30601
|
+
example: *ref_21
|
|
30466
30602
|
enabled:
|
|
30467
30603
|
type: boolean
|
|
30468
30604
|
description: >-
|
|
@@ -30742,7 +30878,7 @@ components:
|
|
|
30742
30878
|
description: >-
|
|
30743
30879
|
Labels assigned to the Feature Flag for categorizing and
|
|
30744
30880
|
filtering.
|
|
30745
|
-
example: *
|
|
30881
|
+
example: *ref_21
|
|
30746
30882
|
enabled:
|
|
30747
30883
|
type: boolean
|
|
30748
30884
|
description: >-
|
|
@@ -31730,7 +31866,7 @@ components:
|
|
|
31730
31866
|
description: >-
|
|
31731
31867
|
Object containing [metadata](/authkit/metadata)
|
|
31732
31868
|
key/value pairs associated with the Organization.
|
|
31733
|
-
example: &
|
|
31869
|
+
example: &ref_22
|
|
31734
31870
|
tier: diamond
|
|
31735
31871
|
propertyNames:
|
|
31736
31872
|
maxLength: 40
|
|
@@ -31880,7 +32016,7 @@ components:
|
|
|
31880
32016
|
description: >-
|
|
31881
32017
|
Object containing [metadata](/authkit/metadata)
|
|
31882
32018
|
key/value pairs associated with the Organization.
|
|
31883
|
-
example: *
|
|
32019
|
+
example: *ref_22
|
|
31884
32020
|
propertyNames:
|
|
31885
32021
|
maxLength: 40
|
|
31886
32022
|
maxProperties: 50
|
|
@@ -32707,7 +32843,7 @@ components:
|
|
|
32707
32843
|
items:
|
|
32708
32844
|
type: string
|
|
32709
32845
|
description: The permissions granted by the role.
|
|
32710
|
-
example: &
|
|
32846
|
+
example: &ref_23
|
|
32711
32847
|
- users:read
|
|
32712
32848
|
- users:write
|
|
32713
32849
|
created_at:
|
|
@@ -32791,7 +32927,7 @@ components:
|
|
|
32791
32927
|
items:
|
|
32792
32928
|
type: string
|
|
32793
32929
|
description: The permissions granted by the role.
|
|
32794
|
-
example: *
|
|
32930
|
+
example: *ref_23
|
|
32795
32931
|
created_at:
|
|
32796
32932
|
format: date-time
|
|
32797
32933
|
type: string
|
|
@@ -32873,7 +33009,7 @@ components:
|
|
|
32873
33009
|
items:
|
|
32874
33010
|
type: string
|
|
32875
33011
|
description: The permissions granted by the role.
|
|
32876
|
-
example: *
|
|
33012
|
+
example: *ref_23
|
|
32877
33013
|
created_at:
|
|
32878
33014
|
format: date-time
|
|
32879
33015
|
type: string
|
|
@@ -33010,7 +33146,7 @@ components:
|
|
|
33010
33146
|
description: >-
|
|
33011
33147
|
Object containing [metadata](/authkit/metadata)
|
|
33012
33148
|
key/value pairs associated with the Organization.
|
|
33013
|
-
example: *
|
|
33149
|
+
example: *ref_22
|
|
33014
33150
|
propertyNames:
|
|
33015
33151
|
maxLength: 40
|
|
33016
33152
|
maxProperties: 50
|
|
@@ -33693,7 +33829,7 @@ components:
|
|
|
33693
33829
|
items:
|
|
33694
33830
|
type: string
|
|
33695
33831
|
description: The permissions granted by the role.
|
|
33696
|
-
example: &
|
|
33832
|
+
example: &ref_24
|
|
33697
33833
|
- users:read
|
|
33698
33834
|
- users:write
|
|
33699
33835
|
created_at:
|
|
@@ -33759,7 +33895,7 @@ components:
|
|
|
33759
33895
|
items:
|
|
33760
33896
|
type: string
|
|
33761
33897
|
description: The permissions granted by the role.
|
|
33762
|
-
example: *
|
|
33898
|
+
example: *ref_24
|
|
33763
33899
|
created_at:
|
|
33764
33900
|
format: date-time
|
|
33765
33901
|
type: string
|
|
@@ -33823,7 +33959,7 @@ components:
|
|
|
33823
33959
|
items:
|
|
33824
33960
|
type: string
|
|
33825
33961
|
description: The permissions granted by the role.
|
|
33826
|
-
example: *
|
|
33962
|
+
example: *ref_24
|
|
33827
33963
|
created_at:
|
|
33828
33964
|
format: date-time
|
|
33829
33965
|
type: string
|
|
@@ -34963,7 +35099,7 @@ components:
|
|
|
34963
35099
|
- data
|
|
34964
35100
|
- created_at
|
|
34965
35101
|
- object
|
|
34966
|
-
example: *
|
|
35102
|
+
example: *ref_25
|
|
34967
35103
|
description: An event emitted by WorkOS.
|
|
34968
35104
|
EventList:
|
|
34969
35105
|
type: object
|
|
@@ -34998,7 +35134,7 @@ components:
|
|
|
34998
35134
|
example:
|
|
34999
35135
|
object: list
|
|
35000
35136
|
data:
|
|
35001
|
-
- *
|
|
35137
|
+
- *ref_25
|
|
35002
35138
|
list_metadata:
|
|
35003
35139
|
after: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
35004
35140
|
JwtTemplate:
|
|
@@ -36538,6 +36674,34 @@ components:
|
|
|
36538
36674
|
The last four characters of the API key, or `null` for OAuth
|
|
36539
36675
|
connections.
|
|
36540
36676
|
example: null
|
|
36677
|
+
client_id:
|
|
36678
|
+
type:
|
|
36679
|
+
- string
|
|
36680
|
+
- 'null'
|
|
36681
|
+
description: >-
|
|
36682
|
+
The client ID supplied for this connection. Only present when
|
|
36683
|
+
`auth_method` is `client_credentials`.
|
|
36684
|
+
example: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
36685
|
+
client_secret_last_4:
|
|
36686
|
+
type:
|
|
36687
|
+
- string
|
|
36688
|
+
- 'null'
|
|
36689
|
+
description: >-
|
|
36690
|
+
The last four characters of the client secret supplied for this
|
|
36691
|
+
connection, or `null` when it can't be read. Only present when
|
|
36692
|
+
`auth_method` is `client_credentials`.
|
|
36693
|
+
example: cdef
|
|
36694
|
+
config:
|
|
36695
|
+
type: object
|
|
36696
|
+
additionalProperties:
|
|
36697
|
+
type: string
|
|
36698
|
+
description: >-
|
|
36699
|
+
The connection-level configuration values stored for this connection
|
|
36700
|
+
— the fields the provider declares at `installation` scope,
|
|
36701
|
+
excluding any it declares as secret. Only present when `auth_method`
|
|
36702
|
+
is `client_credentials`.
|
|
36703
|
+
example:
|
|
36704
|
+
instance_url: https://example.my.salesforce.com
|
|
36541
36705
|
state:
|
|
36542
36706
|
type: string
|
|
36543
36707
|
enum:
|
|
@@ -36733,6 +36897,36 @@ components:
|
|
|
36733
36897
|
The last four characters of the API key, or `null` for
|
|
36734
36898
|
OAuth connections.
|
|
36735
36899
|
example: null
|
|
36900
|
+
client_id:
|
|
36901
|
+
type:
|
|
36902
|
+
- string
|
|
36903
|
+
- 'null'
|
|
36904
|
+
description: >-
|
|
36905
|
+
The client ID supplied for this connection. Only
|
|
36906
|
+
present when `auth_method` is `client_credentials`.
|
|
36907
|
+
example: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
36908
|
+
client_secret_last_4:
|
|
36909
|
+
type:
|
|
36910
|
+
- string
|
|
36911
|
+
- 'null'
|
|
36912
|
+
description: >-
|
|
36913
|
+
The last four characters of the client secret supplied
|
|
36914
|
+
for this connection, or `null` when it can't be read.
|
|
36915
|
+
Only present when `auth_method` is
|
|
36916
|
+
`client_credentials`.
|
|
36917
|
+
example: cdef
|
|
36918
|
+
config:
|
|
36919
|
+
type: object
|
|
36920
|
+
additionalProperties:
|
|
36921
|
+
type: string
|
|
36922
|
+
description: >-
|
|
36923
|
+
The connection-level configuration values stored for
|
|
36924
|
+
this connection — the fields the provider declares at
|
|
36925
|
+
`installation` scope, excluding any it declares as
|
|
36926
|
+
secret. Only present when `auth_method` is
|
|
36927
|
+
`client_credentials`.
|
|
36928
|
+
example:
|
|
36929
|
+
instance_url: https://example.my.salesforce.com
|
|
36736
36930
|
state:
|
|
36737
36931
|
type: string
|
|
36738
36932
|
enum:
|
|
@@ -37810,6 +38004,7 @@ components:
|
|
|
37810
38004
|
- GitLabOAuth
|
|
37811
38005
|
- GoogleOAuth
|
|
37812
38006
|
- GrokOAuth
|
|
38007
|
+
- XOAuth
|
|
37813
38008
|
- IntuitOAuth
|
|
37814
38009
|
- LinkedInOAuth
|
|
37815
38010
|
- MicrosoftOAuth
|
|
@@ -38089,6 +38284,7 @@ components:
|
|
|
38089
38284
|
- GoogleOIDC
|
|
38090
38285
|
- GoogleSAML
|
|
38091
38286
|
- GrokOAuth
|
|
38287
|
+
- XOAuth
|
|
38092
38288
|
- IntuitOAuth
|
|
38093
38289
|
- JumpCloudSAML
|
|
38094
38290
|
- KeycloakSAML
|
package/dist/types.d.ts
CHANGED
|
@@ -4781,7 +4781,7 @@ export interface components {
|
|
|
4781
4781
|
signals_id?: string;
|
|
4782
4782
|
} & (Record<string, never> | {
|
|
4783
4783
|
/**
|
|
4784
|
-
* @description The password to set for the user. Mutually exclusive with `password_hash` and `
|
|
4784
|
+
* @description The password to set for the user. Mutually exclusive with `password_hash`, `password_hash_type`, and `password_salt_position`.
|
|
4785
4785
|
* @example strong_password_123!
|
|
4786
4786
|
*/
|
|
4787
4787
|
password: string | null;
|
|
@@ -4797,6 +4797,12 @@ export interface components {
|
|
|
4797
4797
|
* @enum {string}
|
|
4798
4798
|
*/
|
|
4799
4799
|
password_hash_type: "bcrypt" | "firebase-scrypt" | "ssha" | "ssha256" | "scrypt" | "pbkdf2" | "argon2";
|
|
4800
|
+
/**
|
|
4801
|
+
* @description The position of the salt relative to the password when the `password_hash` digest was computed: `prefix` for `hash(salt + password)` or `suffix` for `hash(password + salt)`. Only supported with the `ssha256` hash type and only valid when a `password_hash` is provided. Defaults to `suffix`. Mutually exclusive with `password`.
|
|
4802
|
+
* @example prefix
|
|
4803
|
+
* @enum {string}
|
|
4804
|
+
*/
|
|
4805
|
+
password_salt_position?: "prefix" | "suffix";
|
|
4800
4806
|
});
|
|
4801
4807
|
UpdateUserlandUserDto: {
|
|
4802
4808
|
/**
|
|
@@ -4846,7 +4852,7 @@ export interface components {
|
|
|
4846
4852
|
locale?: string | null;
|
|
4847
4853
|
} & (Record<string, never> | {
|
|
4848
4854
|
/**
|
|
4849
|
-
* @description The password to set for the user. Mutually exclusive with `password_hash` and `
|
|
4855
|
+
* @description The password to set for the user. Mutually exclusive with `password_hash`, `password_hash_type`, and `password_salt_position`.
|
|
4850
4856
|
* @example strong_password_123!
|
|
4851
4857
|
*/
|
|
4852
4858
|
password: string;
|
|
@@ -4862,6 +4868,12 @@ export interface components {
|
|
|
4862
4868
|
* @enum {string}
|
|
4863
4869
|
*/
|
|
4864
4870
|
password_hash_type: "bcrypt" | "firebase-scrypt" | "ssha" | "ssha256" | "scrypt" | "pbkdf2" | "argon2";
|
|
4871
|
+
/**
|
|
4872
|
+
* @description The position of the salt relative to the password when the `password_hash` digest was computed: `prefix` for `hash(salt + password)` or `suffix` for `hash(password + salt)`. Only supported with the `ssha256` hash type and only valid when a `password_hash` is provided. Defaults to `suffix`. Mutually exclusive with `password`.
|
|
4873
|
+
* @example prefix
|
|
4874
|
+
* @enum {string}
|
|
4875
|
+
*/
|
|
4876
|
+
password_salt_position?: "prefix" | "suffix";
|
|
4865
4877
|
});
|
|
4866
4878
|
VerifyEmailAddressDto: {
|
|
4867
4879
|
/**
|
|
@@ -6789,7 +6801,7 @@ export interface components {
|
|
|
6789
6801
|
* @example OktaSAML
|
|
6790
6802
|
* @enum {string}
|
|
6791
6803
|
*/
|
|
6792
|
-
connection_type: "Pending" | "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
6804
|
+
connection_type: "Pending" | "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "XOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
6793
6805
|
/**
|
|
6794
6806
|
* @description A human-readable name for the Connection. This will most commonly be the organization's name.
|
|
6795
6807
|
* @example Foo Corp
|
|
@@ -9683,7 +9695,7 @@ export interface components {
|
|
|
9683
9695
|
* @example OktaSAML
|
|
9684
9696
|
* @enum {string}
|
|
9685
9697
|
*/
|
|
9686
|
-
connection_type: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
9698
|
+
connection_type: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "XOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
9687
9699
|
/**
|
|
9688
9700
|
* @description The ID of the organization the connection belongs to.
|
|
9689
9701
|
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
@@ -9779,7 +9791,7 @@ export interface components {
|
|
|
9779
9791
|
* @example OktaSAML
|
|
9780
9792
|
* @enum {string}
|
|
9781
9793
|
*/
|
|
9782
|
-
connection_type: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
9794
|
+
connection_type: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "XOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
9783
9795
|
/**
|
|
9784
9796
|
* @description The ID of the organization the connection belongs to.
|
|
9785
9797
|
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
@@ -9875,7 +9887,7 @@ export interface components {
|
|
|
9875
9887
|
* @example OktaSAML
|
|
9876
9888
|
* @enum {string}
|
|
9877
9889
|
*/
|
|
9878
|
-
connection_type: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
9890
|
+
connection_type: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "XOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
9879
9891
|
/**
|
|
9880
9892
|
* @description The ID of the organization the connection belongs to.
|
|
9881
9893
|
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
@@ -15777,6 +15789,25 @@ export interface components {
|
|
|
15777
15789
|
* @example null
|
|
15778
15790
|
*/
|
|
15779
15791
|
api_key_last_4?: string | null;
|
|
15792
|
+
/**
|
|
15793
|
+
* @description The client ID supplied for this connection. Only present when `auth_method` is `client_credentials`.
|
|
15794
|
+
* @example 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
15795
|
+
*/
|
|
15796
|
+
client_id?: string | null;
|
|
15797
|
+
/**
|
|
15798
|
+
* @description The last four characters of the client secret supplied for this connection, or `null` when it can't be read. Only present when `auth_method` is `client_credentials`.
|
|
15799
|
+
* @example cdef
|
|
15800
|
+
*/
|
|
15801
|
+
client_secret_last_4?: string | null;
|
|
15802
|
+
/**
|
|
15803
|
+
* @description The connection-level configuration values stored for this connection — the fields the provider declares at `installation` scope, excluding any it declares as secret. Only present when `auth_method` is `client_credentials`.
|
|
15804
|
+
* @example {
|
|
15805
|
+
* "instance_url": "https://example.my.salesforce.com"
|
|
15806
|
+
* }
|
|
15807
|
+
*/
|
|
15808
|
+
config?: {
|
|
15809
|
+
[key: string]: string;
|
|
15810
|
+
};
|
|
15780
15811
|
/**
|
|
15781
15812
|
* @description The state of the connected account:
|
|
15782
15813
|
* - `connected`: The connection is active and tokens are valid.
|
|
@@ -15931,6 +15962,25 @@ export interface components {
|
|
|
15931
15962
|
* @example null
|
|
15932
15963
|
*/
|
|
15933
15964
|
api_key_last_4?: string | null;
|
|
15965
|
+
/**
|
|
15966
|
+
* @description The client ID supplied for this connection. Only present when `auth_method` is `client_credentials`.
|
|
15967
|
+
* @example 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
15968
|
+
*/
|
|
15969
|
+
client_id?: string | null;
|
|
15970
|
+
/**
|
|
15971
|
+
* @description The last four characters of the client secret supplied for this connection, or `null` when it can't be read. Only present when `auth_method` is `client_credentials`.
|
|
15972
|
+
* @example cdef
|
|
15973
|
+
*/
|
|
15974
|
+
client_secret_last_4?: string | null;
|
|
15975
|
+
/**
|
|
15976
|
+
* @description The connection-level configuration values stored for this connection — the fields the provider declares at `installation` scope, excluding any it declares as secret. Only present when `auth_method` is `client_credentials`.
|
|
15977
|
+
* @example {
|
|
15978
|
+
* "instance_url": "https://example.my.salesforce.com"
|
|
15979
|
+
* }
|
|
15980
|
+
*/
|
|
15981
|
+
config?: {
|
|
15982
|
+
[key: string]: string;
|
|
15983
|
+
};
|
|
15934
15984
|
/**
|
|
15935
15985
|
* @description The state of the connected account:
|
|
15936
15986
|
* - `connected`: The connection is active and tokens are valid.
|
|
@@ -16728,7 +16778,7 @@ export interface components {
|
|
|
16728
16778
|
* @example SSO
|
|
16729
16779
|
* @enum {string}
|
|
16730
16780
|
*/
|
|
16731
|
-
authentication_method?: "SSO" | "Password" | "Passkey" | "AppleOAuth" | "BitbucketOAuth" | "CrossAppAuth" | "DiscordOAuth" | "ExternalAuth" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GrokOAuth" | "IntuitOAuth" | "LinkedInOAuth" | "MicrosoftOAuth" | "SalesforceOAuth" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "XeroOAuth" | "MagicAuth" | "Impersonation" | "MigratedSession";
|
|
16781
|
+
authentication_method?: "SSO" | "Password" | "Passkey" | "AppleOAuth" | "BitbucketOAuth" | "CrossAppAuth" | "DiscordOAuth" | "ExternalAuth" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GrokOAuth" | "XOAuth" | "IntuitOAuth" | "LinkedInOAuth" | "MicrosoftOAuth" | "SalesforceOAuth" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "XeroOAuth" | "MagicAuth" | "Impersonation" | "MigratedSession";
|
|
16732
16782
|
/** @description Information about the impersonator if this session was created via impersonation. */
|
|
16733
16783
|
impersonator?: {
|
|
16734
16784
|
/**
|
|
@@ -16928,7 +16978,7 @@ export interface components {
|
|
|
16928
16978
|
* @example OktaSAML
|
|
16929
16979
|
* @enum {string}
|
|
16930
16980
|
*/
|
|
16931
|
-
connection_type: "Pending" | "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
16981
|
+
connection_type: "Pending" | "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "XOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
16932
16982
|
/**
|
|
16933
16983
|
* @description The user's unique identifier from the identity provider.
|
|
16934
16984
|
* @example 103456789012345678901
|
|
@@ -23362,7 +23412,7 @@ export interface operations {
|
|
|
23362
23412
|
/** @description Order the results by the creation time. */
|
|
23363
23413
|
order?: components["schemas"]["PaginationOrder"];
|
|
23364
23414
|
/** @description Filter Connections by their type. */
|
|
23365
|
-
connection_type?: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "CloudflareSAML" | "ClassLinkSAML" | "CleverOIDC" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GithubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
23415
|
+
connection_type?: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "CloudflareSAML" | "ClassLinkSAML" | "CleverOIDC" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GithubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "XOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
23366
23416
|
/** @description Filter Connections by their associated domain. */
|
|
23367
23417
|
domain?: string;
|
|
23368
23418
|
/** @description Filter Connections by their associated organization. */
|
|
@@ -28242,15 +28292,15 @@ export interface operations {
|
|
|
28242
28292
|
*/
|
|
28243
28293
|
code: string;
|
|
28244
28294
|
/**
|
|
28245
|
-
* @description The ID of the Radar SMS verification being confirmed.
|
|
28295
|
+
* @description The ID of the Radar SMS verification being confirmed. Required for sign-up challenges; omitted for sign-in challenges, where the verification is resolved server-side.
|
|
28246
28296
|
* @example vrf_01HXYZ123456789ABCDEFGHIJ
|
|
28247
28297
|
*/
|
|
28248
|
-
verification_id
|
|
28298
|
+
verification_id?: string;
|
|
28249
28299
|
/**
|
|
28250
|
-
* @description The phone number the Radar SMS challenge was sent to.
|
|
28300
|
+
* @description The phone number the Radar SMS challenge was sent to. Required for sign-up challenges; omitted for sign-in challenges, where the phone number on file is resolved server-side.
|
|
28251
28301
|
* @example +15555550123
|
|
28252
28302
|
*/
|
|
28253
|
-
phone_number
|
|
28303
|
+
phone_number?: string;
|
|
28254
28304
|
/**
|
|
28255
28305
|
* @description The pending authentication token from a previous authentication attempt.
|
|
28256
28306
|
* @example cTDQJTTkTkkVYxbn...
|
|
@@ -28426,6 +28476,30 @@ export interface operations {
|
|
|
28426
28476
|
* @example Request could not be processed.
|
|
28427
28477
|
*/
|
|
28428
28478
|
message: string;
|
|
28479
|
+
} | {
|
|
28480
|
+
/**
|
|
28481
|
+
* @description The error code identifying the type of error.
|
|
28482
|
+
* @example phone_number_required
|
|
28483
|
+
* @constant
|
|
28484
|
+
*/
|
|
28485
|
+
code: "phone_number_required";
|
|
28486
|
+
/**
|
|
28487
|
+
* @description A human-readable description of the error.
|
|
28488
|
+
* @example Request could not be processed.
|
|
28489
|
+
*/
|
|
28490
|
+
message: string;
|
|
28491
|
+
} | {
|
|
28492
|
+
/**
|
|
28493
|
+
* @description The error code identifying the type of error.
|
|
28494
|
+
* @example verification_id_required
|
|
28495
|
+
* @constant
|
|
28496
|
+
*/
|
|
28497
|
+
code: "verification_id_required";
|
|
28498
|
+
/**
|
|
28499
|
+
* @description A human-readable description of the error.
|
|
28500
|
+
* @example Request could not be processed.
|
|
28501
|
+
*/
|
|
28502
|
+
message: string;
|
|
28429
28503
|
} | {
|
|
28430
28504
|
/**
|
|
28431
28505
|
* @description The OAuth error code.
|
|
@@ -28835,6 +28909,18 @@ export interface operations {
|
|
|
28835
28909
|
* @example Request could not be processed.
|
|
28836
28910
|
*/
|
|
28837
28911
|
message: string;
|
|
28912
|
+
} | {
|
|
28913
|
+
/**
|
|
28914
|
+
* @description The error code identifying the type of error.
|
|
28915
|
+
* @example radar_sms_sign_in_challenge
|
|
28916
|
+
* @constant
|
|
28917
|
+
*/
|
|
28918
|
+
code: "radar_sms_sign_in_challenge";
|
|
28919
|
+
/**
|
|
28920
|
+
* @description A human-readable description of the error.
|
|
28921
|
+
* @example Request could not be processed.
|
|
28922
|
+
*/
|
|
28923
|
+
message: string;
|
|
28838
28924
|
} | {
|
|
28839
28925
|
/**
|
|
28840
28926
|
* @description The error code identifying the type of error.
|
|
@@ -31710,6 +31796,18 @@ export interface operations {
|
|
|
31710
31796
|
* @example Request could not be processed.
|
|
31711
31797
|
*/
|
|
31712
31798
|
message: string;
|
|
31799
|
+
} | {
|
|
31800
|
+
/**
|
|
31801
|
+
* @description The error code identifying the type of error.
|
|
31802
|
+
* @example password_salt_position_requires_password_hash
|
|
31803
|
+
* @constant
|
|
31804
|
+
*/
|
|
31805
|
+
code: "password_salt_position_requires_password_hash";
|
|
31806
|
+
/**
|
|
31807
|
+
* @description A human-readable description of the error.
|
|
31808
|
+
* @example Request could not be processed.
|
|
31809
|
+
*/
|
|
31810
|
+
message: string;
|
|
31713
31811
|
} | {
|
|
31714
31812
|
/**
|
|
31715
31813
|
* @description The error code identifying the type of error.
|
|
@@ -31931,6 +32029,18 @@ export interface operations {
|
|
|
31931
32029
|
* @example Request could not be processed.
|
|
31932
32030
|
*/
|
|
31933
32031
|
message: string;
|
|
32032
|
+
} | {
|
|
32033
|
+
/**
|
|
32034
|
+
* @description The error code identifying the type of error.
|
|
32035
|
+
* @example password_salt_position_requires_password_hash
|
|
32036
|
+
* @constant
|
|
32037
|
+
*/
|
|
32038
|
+
code: "password_salt_position_requires_password_hash";
|
|
32039
|
+
/**
|
|
32040
|
+
* @description A human-readable description of the error.
|
|
32041
|
+
* @example Request could not be processed.
|
|
32042
|
+
*/
|
|
32043
|
+
message: string;
|
|
31934
32044
|
} | {
|
|
31935
32045
|
/**
|
|
31936
32046
|
* @description The error code identifying the type of error.
|
|
@@ -32719,7 +32829,7 @@ export interface operations {
|
|
|
32719
32829
|
* @example MicrosoftOAuth
|
|
32720
32830
|
* @enum {string}
|
|
32721
32831
|
*/
|
|
32722
|
-
provider: "AppleOAuth" | "BitbucketOAuth" | "DiscordOAuth" | "GithubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GrokOAuth" | "IntuitOAuth" | "LinkedInOAuth" | "MicrosoftOAuth" | "SalesforceOAuth" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "XeroOAuth";
|
|
32832
|
+
provider: "AppleOAuth" | "BitbucketOAuth" | "DiscordOAuth" | "GithubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GrokOAuth" | "XOAuth" | "IntuitOAuth" | "LinkedInOAuth" | "MicrosoftOAuth" | "SalesforceOAuth" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "XeroOAuth";
|
|
32723
32833
|
}[];
|
|
32724
32834
|
};
|
|
32725
32835
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workos/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.60.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
|
|
6
6
|
"license": "MIT",
|
|
@@ -52,20 +52,19 @@
|
|
|
52
52
|
"prepare": "husky"
|
|
53
53
|
},
|
|
54
54
|
"overrides": {
|
|
55
|
-
"js-yaml": "^
|
|
55
|
+
"js-yaml": "^5.2.3",
|
|
56
56
|
"lodash": "^4.17.23"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
|
-
"@types/js-yaml": "^4.0.9",
|
|
60
59
|
"@types/node": "^26.1.2",
|
|
61
|
-
"@workos/oagen": "^0.
|
|
62
|
-
"@workos/oagen-emitters": "^0.
|
|
60
|
+
"@workos/oagen": "^0.29.2",
|
|
61
|
+
"@workos/oagen-emitters": "^0.24.0",
|
|
63
62
|
"diff2html": "^3.4.56",
|
|
64
63
|
"husky": "^9.1.7",
|
|
65
|
-
"js-yaml": "^
|
|
66
|
-
"openapi-to-postmanv2": "^6.3.
|
|
64
|
+
"js-yaml": "^5.2.3",
|
|
65
|
+
"openapi-to-postmanv2": "^6.3.2",
|
|
67
66
|
"tsdown": "^0.22.14",
|
|
68
|
-
"tsx": "^4.23.
|
|
67
|
+
"tsx": "^4.23.9",
|
|
69
68
|
"typescript": "^7.0.2"
|
|
70
69
|
}
|
|
71
70
|
}
|