@workos/openapi-spec 0.58.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.
@@ -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
@@ -8013,6 +8014,21 @@ paths:
8013
8014
  example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
8014
8015
  required:
8015
8016
  - message
8017
+ '422':
8018
+ description: >-
8019
+ The installation uses an auth method that is not yet supported by
8020
+ this endpoint.
8021
+ content:
8022
+ application/json:
8023
+ schema:
8024
+ type: object
8025
+ properties:
8026
+ message:
8027
+ type: string
8028
+ description: A human-readable description of the error.
8029
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
8030
+ required:
8031
+ - message
8016
8032
  summary: Vend credentials for a connected account
8017
8033
  tags:
8018
8034
  - pipes
@@ -12516,11 +12532,19 @@ paths:
12516
12532
  example: '123456'
12517
12533
  verification_id:
12518
12534
  type: string
12519
- description: The ID of the Radar SMS verification being confirmed.
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.
12520
12540
  example: vrf_01HXYZ123456789ABCDEFGHIJ
12521
12541
  phone_number:
12522
12542
  type: string
12523
- description: The phone number the Radar SMS challenge was sent to.
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.
12524
12548
  example: '+15555550123'
12525
12549
  pending_authentication_token:
12526
12550
  type: string
@@ -12545,8 +12569,6 @@ paths:
12545
12569
  - client_secret
12546
12570
  - grant_type
12547
12571
  - code
12548
- - verification_id
12549
- - phone_number
12550
12572
  - pending_authentication_token
12551
12573
  - type: object
12552
12574
  properties:
@@ -12716,6 +12738,34 @@ paths:
12716
12738
  required:
12717
12739
  - code
12718
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
12719
12769
  - type: object
12720
12770
  properties:
12721
12771
  error:
@@ -13216,6 +13266,20 @@ paths:
13216
13266
  required:
13217
13267
  - code
13218
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
13219
13283
  - type: object
13220
13284
  properties:
13221
13285
  code:
@@ -16633,6 +16697,20 @@ paths:
16633
16697
  required:
16634
16698
  - code
16635
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
16636
16714
  - type: object
16637
16715
  properties:
16638
16716
  code:
@@ -16691,6 +16769,10 @@ paths:
16691
16769
  hashed:
16692
16770
  - password_hash
16693
16771
  - password_hash_type
16772
+ - password_salt_position
16773
+ optionalFields:
16774
+ hashed:
16775
+ - password_salt_position
16694
16776
  /user_management/users/external_id/{external_id}:
16695
16777
  get:
16696
16778
  description: >-
@@ -16837,6 +16919,20 @@ paths:
16837
16919
  required:
16838
16920
  - code
16839
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
16840
16936
  - type: object
16841
16937
  properties:
16842
16938
  code:
@@ -16957,7 +17053,7 @@ paths:
16957
17053
  summary: Update a user
16958
17054
  tags:
16959
17055
  - user-management.users
16960
- x-mutually-exclusive-body-groups: &ref_15
17056
+ x-mutually-exclusive-body-groups: &ref_16
16961
17057
  password:
16962
17058
  optional: true
16963
17059
  variants:
@@ -16966,6 +17062,10 @@ paths:
16966
17062
  hashed:
16967
17063
  - password_hash
16968
17064
  - password_hash_type
17065
+ - password_salt_position
17066
+ optionalFields:
17067
+ hashed:
17068
+ - password_salt_position
16969
17069
  get:
16970
17070
  description: Get the details of an existing user.
16971
17071
  operationId: UserlandUsersController_get[0]
@@ -17717,6 +17817,7 @@ paths:
17717
17817
  - GitLabOAuth
17718
17818
  - GoogleOAuth
17719
17819
  - GrokOAuth
17820
+ - XOAuth
17720
17821
  - IntuitOAuth
17721
17822
  - LinkedInOAuth
17722
17823
  - MicrosoftOAuth
@@ -22110,6 +22211,11 @@ components:
22110
22211
  x-exclude-from-lint: true
22111
22212
  required:
22112
22213
  - password_hash_type
22214
+ - properties:
22215
+ password_salt_position:
22216
+ x-exclude-from-lint: true
22217
+ required:
22218
+ - password_salt_position
22113
22219
  - type: object
22114
22220
  properties:
22115
22221
  password:
@@ -22118,7 +22224,8 @@ components:
22118
22224
  - 'null'
22119
22225
  description: >-
22120
22226
  The password to set for the user. Mutually exclusive with
22121
- `password_hash` and `password_hash_type`.
22227
+ `password_hash`, `password_hash_type`, and
22228
+ `password_salt_position`.
22122
22229
  example: strong_password_123!
22123
22230
  required:
22124
22231
  - password
@@ -22134,6 +22241,11 @@ components:
22134
22241
  x-exclude-from-lint: true
22135
22242
  required:
22136
22243
  - password_hash_type
22244
+ - properties:
22245
+ password_salt_position:
22246
+ x-exclude-from-lint: true
22247
+ required:
22248
+ - password_salt_position
22137
22249
  - type: object
22138
22250
  properties:
22139
22251
  password_hash:
@@ -22157,6 +22269,19 @@ components:
22157
22269
  when providing a `password_hash`. Required with
22158
22270
  `password_hash`. Mutually exclusive with `password`.
22159
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
22160
22285
  required:
22161
22286
  - password_hash
22162
22287
  - password_hash_type
@@ -22238,13 +22363,19 @@ components:
22238
22363
  x-exclude-from-lint: true
22239
22364
  required:
22240
22365
  - password_hash_type
22366
+ - properties:
22367
+ password_salt_position:
22368
+ x-exclude-from-lint: true
22369
+ required:
22370
+ - password_salt_position
22241
22371
  - type: object
22242
22372
  properties:
22243
22373
  password:
22244
22374
  type: string
22245
22375
  description: >-
22246
22376
  The password to set for the user. Mutually exclusive with
22247
- `password_hash` and `password_hash_type`.
22377
+ `password_hash`, `password_hash_type`, and
22378
+ `password_salt_position`.
22248
22379
  example: strong_password_123!
22249
22380
  required:
22250
22381
  - password
@@ -22260,6 +22391,11 @@ components:
22260
22391
  x-exclude-from-lint: true
22261
22392
  required:
22262
22393
  - password_hash_type
22394
+ - properties:
22395
+ password_salt_position:
22396
+ x-exclude-from-lint: true
22397
+ required:
22398
+ - password_salt_position
22263
22399
  - type: object
22264
22400
  properties:
22265
22401
  password_hash:
@@ -22276,6 +22412,17 @@ components:
22276
22412
  when providing a `password_hash`. Required with
22277
22413
  `password_hash`. Mutually exclusive with `password`.
22278
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
22279
22426
  required:
22280
22427
  - password_hash
22281
22428
  - password_hash_type
@@ -22286,7 +22433,7 @@ components:
22286
22433
  x-exclude-from-lint: true
22287
22434
  required:
22288
22435
  - password
22289
- x-mutually-exclusive-body-groups: *ref_15
22436
+ x-mutually-exclusive-body-groups: *ref_16
22290
22437
  VerifyEmailAddressDto:
22291
22438
  type: object
22292
22439
  properties:
@@ -22361,7 +22508,7 @@ components:
22361
22508
  description: The events that the Webhook Endpoint is subscribed to.
22362
22509
  items:
22363
22510
  type: string
22364
- enum: &ref_16
22511
+ enum: &ref_17
22365
22512
  - agent.registration.created
22366
22513
  - agent.registration.claim.attempt.created
22367
22514
  - agent.registration.claim.completed
@@ -22480,7 +22627,7 @@ components:
22480
22627
  description: The events that the Webhook Endpoint is subscribed to.
22481
22628
  items:
22482
22629
  type: string
22483
- enum: *ref_16
22630
+ enum: *ref_17
22484
22631
  example:
22485
22632
  - user.created
22486
22633
  - dsync.user.created
@@ -24813,6 +24960,7 @@ components:
24813
24960
  - GoogleOIDC
24814
24961
  - GoogleSAML
24815
24962
  - GrokOAuth
24963
+ - XOAuth
24816
24964
  - IntuitOAuth
24817
24965
  - JumpCloudSAML
24818
24966
  - KeycloakSAML
@@ -25782,7 +25930,7 @@ components:
25782
25930
  description: >-
25783
25931
  An object containing the custom attribute mapping for the Directory
25784
25932
  Provider.
25785
- example: &ref_19
25933
+ example: &ref_20
25786
25934
  department: Engineering
25787
25935
  job_title: Software Engineer
25788
25936
  role:
@@ -25966,7 +26114,7 @@ components:
25966
26114
  type: object
25967
26115
  additionalProperties: {}
25968
26116
  description: The event payload.
25969
- example: &ref_17
26117
+ example: &ref_18
25970
26118
  id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
25971
26119
  directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
25972
26120
  organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
@@ -26001,11 +26149,11 @@ components:
26001
26149
  - data
26002
26150
  - created_at
26003
26151
  description: An event emitted by WorkOS.
26004
- example: &ref_24
26152
+ example: &ref_25
26005
26153
  object: event
26006
26154
  id: event_01EHZNVPK3SFK441A1RGBFSHRT
26007
26155
  event: dsync.user.created
26008
- data: *ref_17
26156
+ data: *ref_18
26009
26157
  created_at: '2021-06-25T19:07:33.155Z'
26010
26158
  context: {}
26011
26159
  - oneOf:
@@ -26821,7 +26969,7 @@ components:
26821
26969
  items:
26822
26970
  type: string
26823
26971
  description: The permissions granted to the API key.
26824
- example: &ref_18
26972
+ example: &ref_19
26825
26973
  - users:read
26826
26974
  - users:write
26827
26975
  created_at:
@@ -26947,7 +27095,7 @@ components:
26947
27095
  items:
26948
27096
  type: string
26949
27097
  description: The permissions granted to the API key.
26950
- example: *ref_18
27098
+ example: *ref_19
26951
27099
  created_at:
26952
27100
  type: string
26953
27101
  description: The timestamp when the API key was created.
@@ -27071,7 +27219,7 @@ components:
27071
27219
  items:
27072
27220
  type: string
27073
27221
  description: The permissions granted to the API key.
27074
- example: *ref_18
27222
+ example: *ref_19
27075
27223
  created_at:
27076
27224
  type: string
27077
27225
  description: The timestamp when the API key was created.
@@ -28612,6 +28760,7 @@ components:
28612
28760
  - GoogleOIDC
28613
28761
  - GoogleSAML
28614
28762
  - GrokOAuth
28763
+ - XOAuth
28615
28764
  - IntuitOAuth
28616
28765
  - JumpCloudSAML
28617
28766
  - KeycloakSAML
@@ -28778,6 +28927,7 @@ components:
28778
28927
  - GoogleOIDC
28779
28928
  - GoogleSAML
28780
28929
  - GrokOAuth
28930
+ - XOAuth
28781
28931
  - IntuitOAuth
28782
28932
  - JumpCloudSAML
28783
28933
  - KeycloakSAML
@@ -28944,6 +29094,7 @@ components:
28944
29094
  - GoogleOIDC
28945
29095
  - GoogleSAML
28946
29096
  - GrokOAuth
29097
+ - XOAuth
28947
29098
  - IntuitOAuth
28948
29099
  - JumpCloudSAML
28949
29100
  - KeycloakSAML
@@ -29936,7 +30087,7 @@ components:
29936
30087
  description: >-
29937
30088
  An object containing the custom attribute mapping for
29938
30089
  the Directory Provider.
29939
- example: *ref_19
30090
+ example: *ref_20
29940
30091
  role:
29941
30092
  $ref: '#/components/schemas/SlimRole'
29942
30093
  roles:
@@ -30126,7 +30277,7 @@ components:
30126
30277
  description: >-
30127
30278
  Labels assigned to the Feature Flag for categorizing and
30128
30279
  filtering.
30129
- example: &ref_20
30280
+ example: &ref_21
30130
30281
  - reports
30131
30282
  enabled:
30132
30283
  type: boolean
@@ -30287,7 +30438,7 @@ components:
30287
30438
  description: >-
30288
30439
  Labels assigned to the Feature Flag for categorizing and
30289
30440
  filtering.
30290
- example: *ref_20
30441
+ example: *ref_21
30291
30442
  enabled:
30292
30443
  type: boolean
30293
30444
  description: >-
@@ -30447,7 +30598,7 @@ components:
30447
30598
  description: >-
30448
30599
  Labels assigned to the Feature Flag for categorizing and
30449
30600
  filtering.
30450
- example: *ref_20
30601
+ example: *ref_21
30451
30602
  enabled:
30452
30603
  type: boolean
30453
30604
  description: >-
@@ -30727,7 +30878,7 @@ components:
30727
30878
  description: >-
30728
30879
  Labels assigned to the Feature Flag for categorizing and
30729
30880
  filtering.
30730
- example: *ref_20
30881
+ example: *ref_21
30731
30882
  enabled:
30732
30883
  type: boolean
30733
30884
  description: >-
@@ -31715,7 +31866,7 @@ components:
31715
31866
  description: >-
31716
31867
  Object containing [metadata](/authkit/metadata)
31717
31868
  key/value pairs associated with the Organization.
31718
- example: &ref_21
31869
+ example: &ref_22
31719
31870
  tier: diamond
31720
31871
  propertyNames:
31721
31872
  maxLength: 40
@@ -31865,7 +32016,7 @@ components:
31865
32016
  description: >-
31866
32017
  Object containing [metadata](/authkit/metadata)
31867
32018
  key/value pairs associated with the Organization.
31868
- example: *ref_21
32019
+ example: *ref_22
31869
32020
  propertyNames:
31870
32021
  maxLength: 40
31871
32022
  maxProperties: 50
@@ -32692,7 +32843,7 @@ components:
32692
32843
  items:
32693
32844
  type: string
32694
32845
  description: The permissions granted by the role.
32695
- example: &ref_22
32846
+ example: &ref_23
32696
32847
  - users:read
32697
32848
  - users:write
32698
32849
  created_at:
@@ -32776,7 +32927,7 @@ components:
32776
32927
  items:
32777
32928
  type: string
32778
32929
  description: The permissions granted by the role.
32779
- example: *ref_22
32930
+ example: *ref_23
32780
32931
  created_at:
32781
32932
  format: date-time
32782
32933
  type: string
@@ -32858,7 +33009,7 @@ components:
32858
33009
  items:
32859
33010
  type: string
32860
33011
  description: The permissions granted by the role.
32861
- example: *ref_22
33012
+ example: *ref_23
32862
33013
  created_at:
32863
33014
  format: date-time
32864
33015
  type: string
@@ -32995,7 +33146,7 @@ components:
32995
33146
  description: >-
32996
33147
  Object containing [metadata](/authkit/metadata)
32997
33148
  key/value pairs associated with the Organization.
32998
- example: *ref_21
33149
+ example: *ref_22
32999
33150
  propertyNames:
33000
33151
  maxLength: 40
33001
33152
  maxProperties: 50
@@ -33678,7 +33829,7 @@ components:
33678
33829
  items:
33679
33830
  type: string
33680
33831
  description: The permissions granted by the role.
33681
- example: &ref_23
33832
+ example: &ref_24
33682
33833
  - users:read
33683
33834
  - users:write
33684
33835
  created_at:
@@ -33744,7 +33895,7 @@ components:
33744
33895
  items:
33745
33896
  type: string
33746
33897
  description: The permissions granted by the role.
33747
- example: *ref_23
33898
+ example: *ref_24
33748
33899
  created_at:
33749
33900
  format: date-time
33750
33901
  type: string
@@ -33808,7 +33959,7 @@ components:
33808
33959
  items:
33809
33960
  type: string
33810
33961
  description: The permissions granted by the role.
33811
- example: *ref_23
33962
+ example: *ref_24
33812
33963
  created_at:
33813
33964
  format: date-time
33814
33965
  type: string
@@ -34948,7 +35099,7 @@ components:
34948
35099
  - data
34949
35100
  - created_at
34950
35101
  - object
34951
- example: *ref_24
35102
+ example: *ref_25
34952
35103
  description: An event emitted by WorkOS.
34953
35104
  EventList:
34954
35105
  type: object
@@ -34983,7 +35134,7 @@ components:
34983
35134
  example:
34984
35135
  object: list
34985
35136
  data:
34986
- - *ref_24
35137
+ - *ref_25
34987
35138
  list_metadata:
34988
35139
  after: event_01EHZNVPK3SFK441A1RGBFSHRT
34989
35140
  JwtTemplate:
@@ -36294,6 +36445,7 @@ components:
36294
36445
  x-extensible-enum:
36295
36446
  - oauth
36296
36447
  - api_key
36448
+ - client_credentials
36297
36449
  const: oauth
36298
36450
  value:
36299
36451
  type: string
@@ -36356,6 +36508,7 @@ components:
36356
36508
  x-extensible-enum:
36357
36509
  - oauth
36358
36510
  - api_key
36511
+ - client_credentials
36359
36512
  const: api_key
36360
36513
  value:
36361
36514
  type: string
@@ -36369,6 +36522,78 @@ components:
36369
36522
  required:
36370
36523
  - active
36371
36524
  - credential
36525
+ - type: object
36526
+ properties:
36527
+ active:
36528
+ type: boolean
36529
+ description: Indicates credentials are available.
36530
+ const: true
36531
+ credential:
36532
+ type: object
36533
+ properties:
36534
+ object:
36535
+ type: string
36536
+ description: Distinguishes the credential object.
36537
+ const: credential
36538
+ auth_method:
36539
+ type: string
36540
+ description: >-
36541
+ The authentication method for this credential. Additional
36542
+ values may be added in the future; handle unknown values
36543
+ gracefully.
36544
+ x-extensible-enum:
36545
+ - oauth
36546
+ - api_key
36547
+ - client_credentials
36548
+ const: client_credentials
36549
+ value:
36550
+ type: string
36551
+ description: The client-credentials access token.
36552
+ example: 00D5g000000XXXX!AQEAQ...
36553
+ expires_at:
36554
+ type:
36555
+ - string
36556
+ - 'null'
36557
+ description: >-
36558
+ The ISO-8601 formatted timestamp indicating when the
36559
+ credential expires.
36560
+ example: '2025-12-31T23:59:59.000Z'
36561
+ scopes:
36562
+ type: array
36563
+ items:
36564
+ type: string
36565
+ description: The scopes granted to the access token.
36566
+ example:
36567
+ - api
36568
+ missing_scopes:
36569
+ type: array
36570
+ items:
36571
+ type: string
36572
+ description: >-
36573
+ If the integration has requested scopes that aren't present
36574
+ on the access token, they're listed here.
36575
+ example: []
36576
+ metadata:
36577
+ type: object
36578
+ additionalProperties: {}
36579
+ description: >-
36580
+ Non-sensitive fields captured from the provider token
36581
+ response (e.g. Salesforce `instance_url`), as configured for
36582
+ the provider.
36583
+ example:
36584
+ instance_url: https://acme.my.salesforce.com
36585
+ required:
36586
+ - object
36587
+ - auth_method
36588
+ - value
36589
+ - expires_at
36590
+ - scopes
36591
+ - missing_scopes
36592
+ - metadata
36593
+ description: The credential object containing the vended secret.
36594
+ required:
36595
+ - active
36596
+ - credential
36372
36597
  - type: object
36373
36598
  properties:
36374
36599
  active:
@@ -36449,6 +36674,34 @@ components:
36449
36674
  The last four characters of the API key, or `null` for OAuth
36450
36675
  connections.
36451
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
36452
36705
  state:
36453
36706
  type: string
36454
36707
  enum:
@@ -36644,6 +36897,36 @@ components:
36644
36897
  The last four characters of the API key, or `null` for
36645
36898
  OAuth connections.
36646
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
36647
36930
  state:
36648
36931
  type: string
36649
36932
  enum:
@@ -37721,6 +38004,7 @@ components:
37721
38004
  - GitLabOAuth
37722
38005
  - GoogleOAuth
37723
38006
  - GrokOAuth
38007
+ - XOAuth
37724
38008
  - IntuitOAuth
37725
38009
  - LinkedInOAuth
37726
38010
  - MicrosoftOAuth
@@ -38000,6 +38284,7 @@ components:
38000
38284
  - GoogleOIDC
38001
38285
  - GoogleSAML
38002
38286
  - GrokOAuth
38287
+ - XOAuth
38003
38288
  - IntuitOAuth
38004
38289
  - JumpCloudSAML
38005
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 `password_hash_type`.
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 `password_hash_type`.
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
@@ -15672,6 +15684,56 @@ export interface components {
15672
15684
  */
15673
15685
  value: string;
15674
15686
  };
15687
+ } | {
15688
+ /**
15689
+ * @description Indicates credentials are available.
15690
+ * @constant
15691
+ */
15692
+ active: true;
15693
+ /** @description The credential object containing the vended secret. */
15694
+ credential: {
15695
+ /**
15696
+ * @description Distinguishes the credential object.
15697
+ * @constant
15698
+ */
15699
+ object: "credential";
15700
+ /**
15701
+ * @description The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully.
15702
+ * @constant
15703
+ */
15704
+ auth_method: "client_credentials";
15705
+ /**
15706
+ * @description The client-credentials access token.
15707
+ * @example 00D5g000000XXXX!AQEAQ...
15708
+ */
15709
+ value: string;
15710
+ /**
15711
+ * @description The ISO-8601 formatted timestamp indicating when the credential expires.
15712
+ * @example 2025-12-31T23:59:59.000Z
15713
+ */
15714
+ expires_at: string | null;
15715
+ /**
15716
+ * @description The scopes granted to the access token.
15717
+ * @example [
15718
+ * "api"
15719
+ * ]
15720
+ */
15721
+ scopes: string[];
15722
+ /**
15723
+ * @description If the integration has requested scopes that aren't present on the access token, they're listed here.
15724
+ * @example []
15725
+ */
15726
+ missing_scopes: string[];
15727
+ /**
15728
+ * @description Non-sensitive fields captured from the provider token response (e.g. Salesforce `instance_url`), as configured for the provider.
15729
+ * @example {
15730
+ * "instance_url": "https://acme.my.salesforce.com"
15731
+ * }
15732
+ */
15733
+ metadata: {
15734
+ [key: string]: unknown;
15735
+ };
15736
+ };
15675
15737
  } | {
15676
15738
  /**
15677
15739
  * @description Indicates credentials are not available.
@@ -15727,6 +15789,25 @@ export interface components {
15727
15789
  * @example null
15728
15790
  */
15729
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
+ };
15730
15811
  /**
15731
15812
  * @description The state of the connected account:
15732
15813
  * - `connected`: The connection is active and tokens are valid.
@@ -15881,6 +15962,25 @@ export interface components {
15881
15962
  * @example null
15882
15963
  */
15883
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
+ };
15884
15984
  /**
15885
15985
  * @description The state of the connected account:
15886
15986
  * - `connected`: The connection is active and tokens are valid.
@@ -16678,7 +16778,7 @@ export interface components {
16678
16778
  * @example SSO
16679
16779
  * @enum {string}
16680
16780
  */
16681
- 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";
16682
16782
  /** @description Information about the impersonator if this session was created via impersonation. */
16683
16783
  impersonator?: {
16684
16784
  /**
@@ -16878,7 +16978,7 @@ export interface components {
16878
16978
  * @example OktaSAML
16879
16979
  * @enum {string}
16880
16980
  */
16881
- 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";
16882
16982
  /**
16883
16983
  * @description The user's unique identifier from the identity provider.
16884
16984
  * @example 103456789012345678901
@@ -23312,7 +23412,7 @@ export interface operations {
23312
23412
  /** @description Order the results by the creation time. */
23313
23413
  order?: components["schemas"]["PaginationOrder"];
23314
23414
  /** @description Filter Connections by their type. */
23315
- 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";
23316
23416
  /** @description Filter Connections by their associated domain. */
23317
23417
  domain?: string;
23318
23418
  /** @description Filter Connections by their associated organization. */
@@ -24245,6 +24345,21 @@ export interface operations {
24245
24345
  };
24246
24346
  };
24247
24347
  };
24348
+ /** @description The installation uses an auth method that is not yet supported by this endpoint. */
24349
+ 422: {
24350
+ headers: {
24351
+ [name: string]: unknown;
24352
+ };
24353
+ content: {
24354
+ "application/json": {
24355
+ /**
24356
+ * @description A human-readable description of the error.
24357
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
24358
+ */
24359
+ message: string;
24360
+ };
24361
+ };
24362
+ };
24248
24363
  };
24249
24364
  };
24250
24365
  DataIntegrationsController_getUserlandUserToken: {
@@ -28177,15 +28292,15 @@ export interface operations {
28177
28292
  */
28178
28293
  code: string;
28179
28294
  /**
28180
- * @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.
28181
28296
  * @example vrf_01HXYZ123456789ABCDEFGHIJ
28182
28297
  */
28183
- verification_id: string;
28298
+ verification_id?: string;
28184
28299
  /**
28185
- * @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.
28186
28301
  * @example +15555550123
28187
28302
  */
28188
- phone_number: string;
28303
+ phone_number?: string;
28189
28304
  /**
28190
28305
  * @description The pending authentication token from a previous authentication attempt.
28191
28306
  * @example cTDQJTTkTkkVYxbn...
@@ -28361,6 +28476,30 @@ export interface operations {
28361
28476
  * @example Request could not be processed.
28362
28477
  */
28363
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;
28364
28503
  } | {
28365
28504
  /**
28366
28505
  * @description The OAuth error code.
@@ -28770,6 +28909,18 @@ export interface operations {
28770
28909
  * @example Request could not be processed.
28771
28910
  */
28772
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;
28773
28924
  } | {
28774
28925
  /**
28775
28926
  * @description The error code identifying the type of error.
@@ -31645,6 +31796,18 @@ export interface operations {
31645
31796
  * @example Request could not be processed.
31646
31797
  */
31647
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;
31648
31811
  } | {
31649
31812
  /**
31650
31813
  * @description The error code identifying the type of error.
@@ -31866,6 +32029,18 @@ export interface operations {
31866
32029
  * @example Request could not be processed.
31867
32030
  */
31868
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;
31869
32044
  } | {
31870
32045
  /**
31871
32046
  * @description The error code identifying the type of error.
@@ -32654,7 +32829,7 @@ export interface operations {
32654
32829
  * @example MicrosoftOAuth
32655
32830
  * @enum {string}
32656
32831
  */
32657
- 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";
32658
32833
  }[];
32659
32834
  };
32660
32835
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workos/openapi-spec",
3
- "version": "0.58.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": "^4.1.1",
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.28.1",
62
- "@workos/oagen-emitters": "^0.22.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": "^4.1.1",
66
- "openapi-to-postmanv2": "^6.3.1",
64
+ "js-yaml": "^5.2.3",
65
+ "openapi-to-postmanv2": "^6.3.2",
67
66
  "tsdown": "^0.22.14",
68
- "tsx": "^4.23.1",
67
+ "tsx": "^4.23.9",
69
68
  "typescript": "^7.0.2"
70
69
  }
71
70
  }