@workos/openapi-spec 0.116.0 → 0.118.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.
@@ -3767,7 +3767,7 @@ paths:
3767
3767
  summary: Check authorization
3768
3768
  tags:
3769
3769
  - authorization
3770
- x-mutually-exclusive-body-groups: &ref_6
3770
+ x-mutually-exclusive-body-groups: &ref_7
3771
3771
  resource_target:
3772
3772
  optional: false
3773
3773
  variants:
@@ -4411,7 +4411,7 @@ paths:
4411
4411
  summary: Assign a role
4412
4412
  tags:
4413
4413
  - authorization
4414
- x-mutually-exclusive-body-groups: &ref_7
4414
+ x-mutually-exclusive-body-groups: &ref_8
4415
4415
  resource_target:
4416
4416
  optional: false
4417
4417
  variants:
@@ -4482,7 +4482,7 @@ paths:
4482
4482
  summary: Remove a role assignment
4483
4483
  tags:
4484
4484
  - authorization
4485
- x-mutually-exclusive-body-groups: &ref_8
4485
+ x-mutually-exclusive-body-groups: &ref_9
4486
4486
  resource_target:
4487
4487
  optional: false
4488
4488
  variants:
@@ -6905,7 +6905,7 @@ paths:
6905
6905
  summary: Create an authorization resource
6906
6906
  tags:
6907
6907
  - authorization
6908
- x-mutually-exclusive-body-groups: &ref_9
6908
+ x-mutually-exclusive-body-groups: &ref_10
6909
6909
  parent_resource:
6910
6910
  optional: true
6911
6911
  variants:
@@ -9073,7 +9073,7 @@ paths:
9073
9073
  tags:
9074
9074
  - connections
9075
9075
  x-feature-flag: connections-api-migrations-capabilities-api
9076
- x-mutually-exclusive-body-groups: &ref_10
9076
+ x-mutually-exclusive-body-groups: &ref_11
9077
9077
  protocol_options:
9078
9078
  optional: false
9079
9079
  variants:
@@ -10315,7 +10315,7 @@ paths:
10315
10315
  tags:
10316
10316
  - connections
10317
10317
  x-feature-flag: connections-api-migrations-capabilities-api
10318
- x-mutually-exclusive-body-groups: &ref_13
10318
+ x-mutually-exclusive-body-groups: &ref_14
10319
10319
  protocol_options:
10320
10320
  optional: true
10321
10321
  variants:
@@ -11185,18 +11185,37 @@ paths:
11185
11185
  required:
11186
11186
  - message
11187
11187
  '404':
11188
- description: The data integration or selected connected account was not found.
11188
+ description: >-
11189
+ The data integration or selected connected account was not found
11190
+ (`entity_not_found`).
11189
11191
  content:
11190
11192
  application/json:
11191
11193
  schema:
11192
- type: object
11193
- properties:
11194
- message:
11195
- type: string
11196
- description: A human-readable description of the error.
11197
- example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
11198
- required:
11199
- - message
11194
+ anyOf:
11195
+ - type: object
11196
+ properties:
11197
+ code:
11198
+ type: string
11199
+ description: The error code identifying the type of error.
11200
+ example: entity_not_found
11201
+ const: entity_not_found
11202
+ message:
11203
+ type: string
11204
+ description: A human-readable description of the error.
11205
+ example: Request could not be processed.
11206
+ required:
11207
+ - code
11208
+ - message
11209
+ - type: object
11210
+ properties:
11211
+ message:
11212
+ type: string
11213
+ description: A human-readable description of the error.
11214
+ example: >-
11215
+ Organization not found:
11216
+ 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
11217
+ required:
11218
+ - message
11200
11219
  '409':
11201
11220
  description: >-
11202
11221
  Several connected accounts match the connection owner for the
@@ -11238,54 +11257,187 @@ paths:
11238
11257
  content:
11239
11258
  application/json:
11240
11259
  schema:
11241
- type: object
11242
- properties:
11243
- user_id:
11244
- type: string
11245
- description: >-
11246
- The ID of the user to authorize. When `connection_owner` is
11247
- `organization`, this is the user authorizing on behalf of
11248
- the organization; they must be an active member of the
11249
- organization and do not become the owner of the resulting
11250
- connected account.
11251
- example: user_01EHZNVPK3SFK441A1RGBFSHRT
11252
- organization_id:
11253
- type: string
11254
- description: >-
11255
- An organization ID to scope the authorization to a specific
11256
- organization. Required when `connection_owner` is
11257
- `organization`.
11258
- example: org_01EHZNVPK3SFK441A1RGBFSHRT
11259
- connection_owner:
11260
- type: string
11261
- enum:
11262
- - user
11263
- - organization
11264
- description: >-
11265
- Who will own the connected account. `user` (the default)
11266
- connects the user's own account. `organization` connects the
11267
- organization's shared account and requires
11268
- `organization_id`.
11269
- example: user
11270
- return_to:
11271
- type: string
11272
- format: uri
11273
- description: The URL to redirect the user to after authorization.
11274
- example: https://example.com/callback
11275
- config:
11276
- type: object
11277
- additionalProperties:
11278
- type: string
11279
- description: >-
11280
- Connect-time config values for the provider-declared
11281
- `installation`-scope fields (e.g. a Zendesk `subdomain`),
11282
- keyed by the config field. Only fields the provider declares
11283
- may be supplied, and required fields must be provided unless
11284
- already pinned on the integration.
11285
- example:
11286
- subdomain: acme
11287
- required:
11288
- - user_id
11260
+ oneOf:
11261
+ - type: object
11262
+ properties:
11263
+ user_id:
11264
+ type: string
11265
+ description: >-
11266
+ The ID of the user to authorize. When `connection_owner`
11267
+ is `organization`, this is the user authorizing on
11268
+ behalf of the organization; they must be an active
11269
+ member of the organization and do not become the owner
11270
+ of the resulting connected account.
11271
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
11272
+ organization_id:
11273
+ type: string
11274
+ description: >-
11275
+ An organization ID to scope the authorization to a
11276
+ specific organization. Required when `connection_owner`
11277
+ is `organization`.
11278
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
11279
+ connection_owner:
11280
+ type: string
11281
+ enum:
11282
+ - user
11283
+ - organization
11284
+ description: >-
11285
+ Who will own the connected account. `user` (the default)
11286
+ connects the user's own account. `organization` connects
11287
+ the organization's shared account and requires
11288
+ `organization_id`.
11289
+ example: user
11290
+ return_to:
11291
+ type: string
11292
+ format: uri
11293
+ description: The URL to redirect the user to after authorization.
11294
+ example: https://example.com/callback
11295
+ config:
11296
+ type: object
11297
+ additionalProperties:
11298
+ type: string
11299
+ description: >-
11300
+ Connect-time config values for the provider-declared
11301
+ `installation`-scope fields (e.g. a Zendesk
11302
+ `subdomain`), keyed by the config field. Only fields the
11303
+ provider declares may be supplied, and required fields
11304
+ must be provided unless already pinned on the
11305
+ integration.
11306
+ example: &ref_1
11307
+ subdomain: acme
11308
+ required:
11309
+ - user_id
11310
+ additionalProperties: false
11311
+ - type: object
11312
+ properties:
11313
+ user_id:
11314
+ type: string
11315
+ description: >-
11316
+ The ID of the user to authorize. When `connection_owner`
11317
+ is `organization`, this is the user authorizing on
11318
+ behalf of the organization; they must be an active
11319
+ member of the organization and do not become the owner
11320
+ of the resulting connected account.
11321
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
11322
+ organization_id:
11323
+ type: string
11324
+ description: >-
11325
+ An organization ID to scope the authorization to a
11326
+ specific organization. Required when `connection_owner`
11327
+ is `organization`.
11328
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
11329
+ connection_owner:
11330
+ type: string
11331
+ enum:
11332
+ - user
11333
+ - organization
11334
+ description: >-
11335
+ Who will own the connected account. `user` (the default)
11336
+ connects the user's own account. `organization` connects
11337
+ the organization's shared account and requires
11338
+ `organization_id`.
11339
+ example: user
11340
+ return_to:
11341
+ type: string
11342
+ format: uri
11343
+ description: The URL to redirect the user to after authorization.
11344
+ example: https://example.com/callback
11345
+ config:
11346
+ type: object
11347
+ additionalProperties:
11348
+ type: string
11349
+ description: >-
11350
+ Connect-time config values for the provider-declared
11351
+ `installation`-scope fields (e.g. a Zendesk
11352
+ `subdomain`), keyed by the config field. Only fields the
11353
+ provider declares may be supplied, and required fields
11354
+ must be provided unless already pinned on the
11355
+ integration.
11356
+ example: *ref_1
11357
+ connection_intent:
11358
+ type: string
11359
+ description: >-
11360
+ Create another connection. The first connection for an
11361
+ owner shape fills the compatibility slot; later
11362
+ connections are standard. Creating an additional
11363
+ connection is not yet available: until it is, `add`
11364
+ succeeds only when the owner has no connection for this
11365
+ integration and otherwise returns 404
11366
+ `multiple_connections_unavailable`. Omit
11367
+ `connection_intent` to use the compatibility connection,
11368
+ or send `reauthorize` with `connected_account_id` to
11369
+ reauthorize one exact connection.
11370
+ example: add
11371
+ const: add
11372
+ required:
11373
+ - user_id
11374
+ - connection_intent
11375
+ additionalProperties: false
11376
+ - type: object
11377
+ properties:
11378
+ user_id:
11379
+ type: string
11380
+ description: >-
11381
+ The ID of the user to authorize. When `connection_owner`
11382
+ is `organization`, this is the user authorizing on
11383
+ behalf of the organization; they must be an active
11384
+ member of the organization and do not become the owner
11385
+ of the resulting connected account.
11386
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
11387
+ organization_id:
11388
+ type: string
11389
+ description: >-
11390
+ An organization ID to scope the authorization to a
11391
+ specific organization. Required when `connection_owner`
11392
+ is `organization`.
11393
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
11394
+ connection_owner:
11395
+ type: string
11396
+ enum:
11397
+ - user
11398
+ - organization
11399
+ description: >-
11400
+ Who will own the connected account. `user` (the default)
11401
+ connects the user's own account. `organization` connects
11402
+ the organization's shared account and requires
11403
+ `organization_id`.
11404
+ example: user
11405
+ return_to:
11406
+ type: string
11407
+ format: uri
11408
+ description: The URL to redirect the user to after authorization.
11409
+ example: https://example.com/callback
11410
+ config:
11411
+ type: object
11412
+ additionalProperties:
11413
+ type: string
11414
+ description: >-
11415
+ Connect-time config values for the provider-declared
11416
+ `installation`-scope fields (e.g. a Zendesk
11417
+ `subdomain`), keyed by the config field. Only fields the
11418
+ provider declares may be supplied, and required fields
11419
+ must be provided unless already pinned on the
11420
+ integration.
11421
+ example: *ref_1
11422
+ connection_intent:
11423
+ type: string
11424
+ description: >-
11425
+ Reauthorize exactly the connection named by
11426
+ `connected_account_id`.
11427
+ example: reauthorize
11428
+ const: reauthorize
11429
+ connected_account_id:
11430
+ type: string
11431
+ pattern: ^data_installation_.+$
11432
+ description: >-
11433
+ The exact connected account to reauthorize. Required
11434
+ with `connection_intent: reauthorize`.
11435
+ example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
11436
+ required:
11437
+ - user_id
11438
+ - connection_intent
11439
+ - connected_account_id
11440
+ additionalProperties: false
11289
11441
  responses:
11290
11442
  '200':
11291
11443
  description: OK
@@ -11322,18 +11474,50 @@ paths:
11322
11474
  required:
11323
11475
  - message
11324
11476
  '404':
11325
- description: Not Found
11477
+ description: >-
11478
+ The integration or user was not found (`entity_not_found`);
11479
+ `connected_account_not_found` when `connected_account_id` does not
11480
+ name a connection for this owner and integration; or
11481
+ `multiple_connections_unavailable` when `connection_intent: add`
11482
+ would create an additional connection before that capability is
11483
+ available.
11326
11484
  content:
11327
11485
  application/json:
11328
11486
  schema:
11329
- type: object
11330
- properties:
11331
- message:
11332
- type: string
11333
- description: A human-readable description of the error.
11334
- example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
11335
- required:
11336
- - message
11487
+ anyOf:
11488
+ - type: object
11489
+ properties:
11490
+ code:
11491
+ type: string
11492
+ enum:
11493
+ - multiple_connections_unavailable
11494
+ - connected_account_not_found
11495
+ - entity_not_found
11496
+ description: The error code identifying the type of error.
11497
+ example: multiple_connections_unavailable
11498
+ message:
11499
+ type: string
11500
+ description: A human-readable description of the error.
11501
+ example: Request could not be processed.
11502
+ required:
11503
+ - code
11504
+ - message
11505
+ - type: object
11506
+ properties:
11507
+ message:
11508
+ type: string
11509
+ description: A human-readable description of the error.
11510
+ example: >-
11511
+ Organization not found:
11512
+ 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
11513
+ required:
11514
+ - message
11515
+ '422':
11516
+ description: The selected connected account does not use OAuth authentication.
11517
+ content:
11518
+ application/json:
11519
+ schema:
11520
+ $ref: '#/components/schemas/AuthMethodMismatchError'
11337
11521
  summary: Get authorization URL
11338
11522
  tags:
11339
11523
  - pipes
@@ -11605,7 +11789,7 @@ paths:
11605
11789
  Provider-specific configuration values collected for
11606
11790
  this installation, keyed by the provider's config field
11607
11791
  descriptors.
11608
- example: &ref_1
11792
+ example: &ref_2
11609
11793
  salesforce_host: acme.my.salesforce.com
11610
11794
  required:
11611
11795
  - user_id
@@ -11657,7 +11841,7 @@ paths:
11657
11841
  Provider-specific configuration values collected for
11658
11842
  this installation, keyed by the provider's config field
11659
11843
  descriptors.
11660
- example: *ref_1
11844
+ example: *ref_2
11661
11845
  connection_intent:
11662
11846
  type: string
11663
11847
  description: >-
@@ -11724,7 +11908,7 @@ paths:
11724
11908
  Provider-specific configuration values collected for
11725
11909
  this installation, keyed by the provider's config field
11726
11910
  descriptors.
11727
- example: *ref_1
11911
+ example: *ref_2
11728
11912
  connected_account_id:
11729
11913
  type: string
11730
11914
  pattern: ^data_installation_.+$
@@ -11787,18 +11971,37 @@ paths:
11787
11971
  required:
11788
11972
  - message
11789
11973
  '404':
11790
- description: The data integration or selected connected account was not found.
11974
+ description: >-
11975
+ The data integration or selected connected account was not found
11976
+ (`entity_not_found`).
11791
11977
  content:
11792
11978
  application/json:
11793
11979
  schema:
11794
- type: object
11795
- properties:
11796
- message:
11797
- type: string
11798
- description: A human-readable description of the error.
11799
- example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
11800
- required:
11801
- - message
11980
+ anyOf:
11981
+ - type: object
11982
+ properties:
11983
+ code:
11984
+ type: string
11985
+ description: The error code identifying the type of error.
11986
+ example: entity_not_found
11987
+ const: entity_not_found
11988
+ message:
11989
+ type: string
11990
+ description: A human-readable description of the error.
11991
+ example: Request could not be processed.
11992
+ required:
11993
+ - code
11994
+ - message
11995
+ - type: object
11996
+ properties:
11997
+ message:
11998
+ type: string
11999
+ description: A human-readable description of the error.
12000
+ example: >-
12001
+ Organization not found:
12002
+ 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
12003
+ required:
12004
+ - message
11802
12005
  '409':
11803
12006
  description: >-
11804
12007
  Several connected accounts match the connection owner for the
@@ -12557,6 +12760,129 @@ paths:
12557
12760
  summary: Delete a Directory
12558
12761
  tags:
12559
12762
  - directories
12763
+ /directories/{id}/sync:
12764
+ post:
12765
+ description: >-
12766
+ Request an asynchronous sync from the directory provider. Currently
12767
+ supports Google Workspace directories in linked or validating state.
12768
+ Manual requests share a five-minute per-directory cooldown across the
12769
+ API, Dashboard, Admin Portal, and MCP. Acceptance means the request was
12770
+ queued, not that the sync has started or completed. A running sync
12771
+ prevents another request from being queued.
12772
+ operationId: DirectoriesController_syncDirectory
12773
+ parameters:
12774
+ - name: id
12775
+ required: true
12776
+ in: path
12777
+ description: Unique identifier for the Directory.
12778
+ schema:
12779
+ example: directory_01ECAZ4NV9QMV47GW873HDCX74
12780
+ type: string
12781
+ responses:
12782
+ '202':
12783
+ description: ''
12784
+ content:
12785
+ application/json:
12786
+ schema:
12787
+ $ref: '#/components/schemas/DirectorySyncResponse'
12788
+ '403':
12789
+ description: Forbidden
12790
+ content:
12791
+ application/json:
12792
+ schema:
12793
+ type: object
12794
+ properties:
12795
+ message:
12796
+ type: string
12797
+ description: A human-readable description of the error.
12798
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
12799
+ required:
12800
+ - message
12801
+ '404':
12802
+ description: Not Found
12803
+ content:
12804
+ application/json:
12805
+ schema:
12806
+ type: object
12807
+ properties:
12808
+ message:
12809
+ type: string
12810
+ description: A human-readable description of the error.
12811
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
12812
+ required:
12813
+ - message
12814
+ '409':
12815
+ description: A sync is already in progress. No additional sync was queued.
12816
+ content:
12817
+ application/json:
12818
+ schema:
12819
+ type: object
12820
+ properties:
12821
+ code:
12822
+ type: string
12823
+ description: The error code identifying the type of error.
12824
+ example: directory_sync_in_progress
12825
+ const: directory_sync_in_progress
12826
+ message:
12827
+ type: string
12828
+ description: A human-readable description of the error.
12829
+ example: Request could not be processed.
12830
+ required:
12831
+ - code
12832
+ - message
12833
+ '422':
12834
+ description: The directory provider or state does not support manual sync.
12835
+ content:
12836
+ application/json:
12837
+ schema:
12838
+ type: object
12839
+ properties:
12840
+ code:
12841
+ type: string
12842
+ description: The error code identifying the type of error.
12843
+ example: directory_sync_unsupported
12844
+ const: directory_sync_unsupported
12845
+ message:
12846
+ type: string
12847
+ description: A human-readable description of the error.
12848
+ example: Request could not be processed.
12849
+ required:
12850
+ - code
12851
+ - message
12852
+ '429':
12853
+ description: The directory is within the manual-sync cooldown window.
12854
+ headers:
12855
+ Retry-After:
12856
+ description: Seconds to wait before requesting another manual sync.
12857
+ schema:
12858
+ type: integer
12859
+ minimum: 1
12860
+ content:
12861
+ application/json:
12862
+ schema:
12863
+ $ref: '#/components/schemas/DirectorySyncRateLimitError'
12864
+ '503':
12865
+ description: Directory syncing is temporarily paused. No sync was queued.
12866
+ content:
12867
+ application/json:
12868
+ schema:
12869
+ type: object
12870
+ properties:
12871
+ code:
12872
+ type: string
12873
+ description: The error code identifying the type of error.
12874
+ example: directory_sync_disabled
12875
+ const: directory_sync_disabled
12876
+ message:
12877
+ type: string
12878
+ description: A human-readable description of the error.
12879
+ example: Request could not be processed.
12880
+ required:
12881
+ - code
12882
+ - message
12883
+ summary: Sync a Directory
12884
+ tags:
12885
+ - directories
12560
12886
  /directory_groups:
12561
12887
  get:
12562
12888
  description: >-
@@ -14383,7 +14709,7 @@ paths:
14383
14709
  summary: Set Retention
14384
14710
  tags:
14385
14711
  - audit-logs
14386
- x-mutually-exclusive-body-groups: &ref_5
14712
+ x-mutually-exclusive-body-groups: &ref_6
14387
14713
  retention:
14388
14714
  optional: false
14389
14715
  variants:
@@ -16142,7 +16468,7 @@ paths:
16142
16468
  credentialsType: oauth2
16143
16469
  createdAt: '2024-01-15T10:30:00.000Z'
16144
16470
  updatedAt: '2024-01-15T10:30:00.000Z'
16145
- connected_account: &ref_2
16471
+ connected_account: &ref_3
16146
16472
  object: connected_account
16147
16473
  id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
16148
16474
  user_id: null
@@ -16167,7 +16493,7 @@ paths:
16167
16493
  createdAt: '2024-01-16T14:20:00.000Z'
16168
16494
  updatedAt: '2024-01-16T14:20:00.000Z'
16169
16495
  connected_accounts:
16170
- - *ref_2
16496
+ - *ref_3
16171
16497
  '401':
16172
16498
  description: The request is missing a valid API key.
16173
16499
  '404':
@@ -21065,7 +21391,7 @@ paths:
21065
21391
  summary: Create an organization membership
21066
21392
  tags:
21067
21393
  - user-management.organization-membership
21068
- x-mutually-exclusive-body-groups: &ref_19
21394
+ x-mutually-exclusive-body-groups: &ref_20
21069
21395
  role:
21070
21396
  optional: true
21071
21397
  variants:
@@ -21249,7 +21575,7 @@ paths:
21249
21575
  summary: Update an organization membership
21250
21576
  tags:
21251
21577
  - user-management.organization-membership
21252
- x-mutually-exclusive-body-groups: &ref_20
21578
+ x-mutually-exclusive-body-groups: &ref_21
21253
21579
  role:
21254
21580
  optional: true
21255
21581
  variants:
@@ -22569,7 +22895,7 @@ paths:
22569
22895
  summary: Create a user
22570
22896
  tags:
22571
22897
  - user-management.users
22572
- x-mutually-exclusive-body-groups: &ref_21
22898
+ x-mutually-exclusive-body-groups: &ref_22
22573
22899
  password:
22574
22900
  optional: true
22575
22901
  variants:
@@ -22881,7 +23207,7 @@ paths:
22881
23207
  summary: Update a user
22882
23208
  tags:
22883
23209
  - user-management.users
22884
- x-mutually-exclusive-body-groups: &ref_25
23210
+ x-mutually-exclusive-body-groups: &ref_26
22885
23211
  password:
22886
23212
  optional: true
22887
23213
  variants:
@@ -26857,7 +27183,7 @@ components:
26857
27183
  example: An application for managing user access
26858
27184
  scopes:
26859
27185
  description: The OAuth scopes granted to the application.
26860
- example: &ref_3
27186
+ example: &ref_4
26861
27187
  - openid
26862
27188
  - profile
26863
27189
  - email
@@ -26919,7 +27245,7 @@ components:
26919
27245
  example: An application for managing user access
26920
27246
  scopes:
26921
27247
  description: The OAuth scopes granted to the application.
26922
- example: *ref_3
27248
+ example: *ref_4
26923
27249
  type:
26924
27250
  - array
26925
27251
  - 'null'
@@ -26992,7 +27318,7 @@ components:
26992
27318
  owner: user_01GBTCQ2
26993
27319
  maxProperties: 50
26994
27320
  additionalProperties: false
26995
- patternProperties: &ref_4
27321
+ patternProperties: &ref_5
26996
27322
  ^[a-zA-Z0-9_-]{0,40}$:
26997
27323
  anyOf:
26998
27324
  - type: string
@@ -27024,7 +27350,7 @@ components:
27024
27350
  owner: user_01GBTCQ2
27025
27351
  maxProperties: 50
27026
27352
  additionalProperties: false
27027
- patternProperties: *ref_4
27353
+ patternProperties: *ref_5
27028
27354
  required:
27029
27355
  - id
27030
27356
  - type
@@ -27071,7 +27397,7 @@ components:
27071
27397
  owner: user_01GBTCQ2
27072
27398
  maxProperties: 50
27073
27399
  additionalProperties: false
27074
- patternProperties: *ref_4
27400
+ patternProperties: *ref_5
27075
27401
  version:
27076
27402
  type: integer
27077
27403
  description: What schema version the event is associated with.
@@ -27153,7 +27479,7 @@ components:
27153
27479
  - range_start
27154
27480
  - range_end
27155
27481
  UpdateAuditLogsRetentionDto:
27156
- x-mutually-exclusive-body-groups: *ref_5
27482
+ x-mutually-exclusive-body-groups: *ref_6
27157
27483
  oneOf:
27158
27484
  - type: object
27159
27485
  properties:
@@ -27338,7 +27664,7 @@ components:
27338
27664
  x-exclude-from-lint: true
27339
27665
  required:
27340
27666
  - resource_id
27341
- x-mutually-exclusive-body-groups: *ref_6
27667
+ x-mutually-exclusive-body-groups: *ref_7
27342
27668
  CreateGroupRoleAssignmentDto:
27343
27669
  type: object
27344
27670
  properties:
@@ -27479,7 +27805,7 @@ components:
27479
27805
  x-exclude-from-lint: true
27480
27806
  required:
27481
27807
  - resource_id
27482
- x-mutually-exclusive-body-groups: *ref_7
27808
+ x-mutually-exclusive-body-groups: *ref_8
27483
27809
  RemoveRoleDto:
27484
27810
  allOf:
27485
27811
  - type: object
@@ -27538,7 +27864,7 @@ components:
27538
27864
  x-exclude-from-lint: true
27539
27865
  required:
27540
27866
  - resource_id
27541
- x-mutually-exclusive-body-groups: *ref_8
27867
+ x-mutually-exclusive-body-groups: *ref_9
27542
27868
  SetRolePermissionsDto:
27543
27869
  type: object
27544
27870
  properties:
@@ -27888,7 +28214,7 @@ components:
27888
28214
  x-exclude-from-lint: true
27889
28215
  required:
27890
28216
  - parent_resource_id
27891
- x-mutually-exclusive-body-groups: *ref_9
28217
+ x-mutually-exclusive-body-groups: *ref_10
27892
28218
  CreateConnectionKeyPairDto:
27893
28219
  type: object
27894
28220
  properties:
@@ -28006,7 +28332,7 @@ components:
28006
28332
  default: true
28007
28333
  token_authentication_method:
28008
28334
  type: string
28009
- enum: &ref_11
28335
+ enum: &ref_12
28010
28336
  - client_secret_post
28011
28337
  - client_secret_basic
28012
28338
  - private_key_jwt
@@ -28022,7 +28348,7 @@ components:
28022
28348
  $ref: '#/components/schemas/CreateConnectionKeyPairDto'
28023
28349
  id_token_signature_algorithm:
28024
28350
  type: string
28025
- enum: &ref_12
28351
+ enum: &ref_13
28026
28352
  - ES256
28027
28353
  - ES384
28028
28354
  - ES512
@@ -28178,7 +28504,7 @@ components:
28178
28504
  x-exclude-from-lint: true
28179
28505
  required:
28180
28506
  - saml_options
28181
- x-mutually-exclusive-body-groups: *ref_10
28507
+ x-mutually-exclusive-body-groups: *ref_11
28182
28508
  PatchConnectionSamlOptionsDto:
28183
28509
  type: object
28184
28510
  properties:
@@ -28254,7 +28580,7 @@ components:
28254
28580
  example: true
28255
28581
  token_authentication_method:
28256
28582
  type: string
28257
- enum: *ref_11
28583
+ enum: *ref_12
28258
28584
  description: >-
28259
28585
  The token-endpoint client authentication method. Moving to
28260
28586
  `private_key_jwt` generates a signing key pair if the connection has
@@ -28264,7 +28590,7 @@ components:
28264
28590
  example: client_secret_basic
28265
28591
  id_token_signature_algorithm:
28266
28592
  type: string
28267
- enum: *ref_12
28593
+ enum: *ref_13
28268
28594
  description: The ID-token signing algorithm.
28269
28595
  example: RS256
28270
28596
  fetch_user_info:
@@ -28408,7 +28734,7 @@ components:
28408
28734
  x-exclude-from-lint: true
28409
28735
  required:
28410
28736
  - saml_options
28411
- x-mutually-exclusive-body-groups: *ref_13
28737
+ x-mutually-exclusive-body-groups: *ref_14
28412
28738
  CreateCorsOriginDto:
28413
28739
  type: object
28414
28740
  properties:
@@ -28590,11 +28916,11 @@ components:
28590
28916
  type:
28591
28917
  - object
28592
28918
  - 'null'
28593
- additionalProperties: &ref_14
28919
+ additionalProperties: &ref_15
28594
28920
  type: string
28595
28921
  maxLength: 600
28596
28922
  maxProperties: 50
28597
- example: &ref_15
28923
+ example: &ref_16
28598
28924
  tier: diamond
28599
28925
  description: >-
28600
28926
  Object containing [metadata](/authkit/metadata) key/value pairs
@@ -28649,9 +28975,9 @@ components:
28649
28975
  type:
28650
28976
  - object
28651
28977
  - 'null'
28652
- additionalProperties: *ref_14
28978
+ additionalProperties: *ref_15
28653
28979
  maxProperties: 50
28654
- example: *ref_15
28980
+ example: *ref_16
28655
28981
  description: >-
28656
28982
  Object containing [metadata](/authkit/metadata) key/value pairs
28657
28983
  associated with the Organization.
@@ -28785,7 +29111,7 @@ components:
28785
29111
  example: application/x-www-form-urlencoded
28786
29112
  authenticate_via:
28787
29113
  type: string
28788
- enum: &ref_16
29114
+ enum: &ref_17
28789
29115
  - request_body
28790
29116
  - basic_auth_header
28791
29117
  description: >-
@@ -28953,7 +29279,7 @@ components:
28953
29279
  example: application/x-www-form-urlencoded
28954
29280
  authenticate_via:
28955
29281
  type: string
28956
- enum: *ref_16
29282
+ enum: *ref_17
28957
29283
  description: >-
28958
29284
  How client credentials are sent when exchanging authorization codes
28959
29285
  and refreshing tokens.
@@ -29019,7 +29345,7 @@ components:
29019
29345
  format: date-time
29020
29346
  scopes:
29021
29347
  description: The OAuth scopes granted for this connection.
29022
- example: &ref_17
29348
+ example: &ref_18
29023
29349
  - repo
29024
29350
  - user:email
29025
29351
  type: array
@@ -29027,7 +29353,7 @@ components:
29027
29353
  type: string
29028
29354
  state:
29029
29355
  type: string
29030
- enum: &ref_18
29356
+ enum: &ref_19
29031
29357
  - connected
29032
29358
  - needs_reauthorization
29033
29359
  description: >-
@@ -29074,13 +29400,13 @@ components:
29074
29400
  format: date-time
29075
29401
  scopes:
29076
29402
  description: The OAuth scopes granted for this connection.
29077
- example: *ref_17
29403
+ example: *ref_18
29078
29404
  type: array
29079
29405
  items:
29080
29406
  type: string
29081
29407
  state:
29082
29408
  type: string
29083
- enum: *ref_18
29409
+ enum: *ref_19
29084
29410
  description: >-
29085
29411
  Explicitly set the state of the connected account. When omitted, the
29086
29412
  state is derived from the token combination provided.
@@ -29114,13 +29440,13 @@ components:
29114
29440
  format: date-time
29115
29441
  scopes:
29116
29442
  description: The OAuth scopes granted for this connection.
29117
- example: *ref_17
29443
+ example: *ref_18
29118
29444
  type: array
29119
29445
  items:
29120
29446
  type: string
29121
29447
  state:
29122
29448
  type: string
29123
- enum: *ref_18
29449
+ enum: *ref_19
29124
29450
  description: >-
29125
29451
  Explicitly set the state of the connected account. When omitted, the
29126
29452
  state is derived from the token combination provided.
@@ -29156,13 +29482,13 @@ components:
29156
29482
  format: date-time
29157
29483
  scopes:
29158
29484
  description: The OAuth scopes granted for this connection.
29159
- example: *ref_17
29485
+ example: *ref_18
29160
29486
  type: array
29161
29487
  items:
29162
29488
  type: string
29163
29489
  state:
29164
29490
  type: string
29165
- enum: *ref_18
29491
+ enum: *ref_19
29166
29492
  description: >-
29167
29493
  Explicitly set the state of the connected account. When omitted, the
29168
29494
  state is derived from the token combination provided.
@@ -29672,9 +29998,9 @@ components:
29672
29998
  x-exclude-from-lint: true
29673
29999
  required:
29674
30000
  - role_slug
29675
- x-mutually-exclusive-body-groups: *ref_19
29676
- UpdateUserlandUserOrganizationMembershipDto:
29677
30001
  x-mutually-exclusive-body-groups: *ref_20
30002
+ UpdateUserlandUserOrganizationMembershipDto:
30003
+ x-mutually-exclusive-body-groups: *ref_21
29678
30004
  oneOf:
29679
30005
  - type: object
29680
30006
  not:
@@ -29798,9 +30124,9 @@ components:
29798
30124
  type:
29799
30125
  - object
29800
30126
  - 'null'
29801
- additionalProperties: *ref_14
30127
+ additionalProperties: *ref_15
29802
30128
  maxProperties: 50
29803
- example: &ref_22
30129
+ example: &ref_23
29804
30130
  timezone: America/New_York
29805
30131
  description: >-
29806
30132
  Object containing metadata key/value pairs associated with the
@@ -29899,7 +30225,7 @@ components:
29899
30225
  example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
29900
30226
  password_hash_type:
29901
30227
  type: string
29902
- enum: &ref_23
30228
+ enum: &ref_24
29903
30229
  - bcrypt
29904
30230
  - firebase-scrypt
29905
30231
  - ssha
@@ -29914,7 +30240,7 @@ components:
29914
30240
  example: bcrypt
29915
30241
  password_salt_position:
29916
30242
  type: string
29917
- enum: &ref_24
30243
+ enum: &ref_25
29918
30244
  - prefix
29919
30245
  - suffix
29920
30246
  description: >-
@@ -29935,7 +30261,7 @@ components:
29935
30261
  x-exclude-from-lint: true
29936
30262
  required:
29937
30263
  - password
29938
- x-mutually-exclusive-body-groups: *ref_21
30264
+ x-mutually-exclusive-body-groups: *ref_22
29939
30265
  UpdateUserlandUserDto:
29940
30266
  allOf:
29941
30267
  - type: object
@@ -29965,9 +30291,9 @@ components:
29965
30291
  type:
29966
30292
  - object
29967
30293
  - 'null'
29968
- additionalProperties: *ref_14
30294
+ additionalProperties: *ref_15
29969
30295
  maxProperties: 50
29970
- example: *ref_22
30296
+ example: *ref_23
29971
30297
  description: >-
29972
30298
  Object containing metadata key/value pairs associated with the
29973
30299
  user.
@@ -30049,7 +30375,7 @@ components:
30049
30375
  example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
30050
30376
  password_hash_type:
30051
30377
  type: string
30052
- enum: *ref_23
30378
+ enum: *ref_24
30053
30379
  description: >-
30054
30380
  The algorithm originally used to hash the password, used
30055
30381
  when providing a `password_hash`. Required with
@@ -30057,7 +30383,7 @@ components:
30057
30383
  example: bcrypt
30058
30384
  password_salt_position:
30059
30385
  type: string
30060
- enum: *ref_24
30386
+ enum: *ref_25
30061
30387
  description: >-
30062
30388
  The position of the salt relative to the password when the
30063
30389
  `password_hash` digest was computed: `prefix` for `hash(salt
@@ -30076,7 +30402,7 @@ components:
30076
30402
  x-exclude-from-lint: true
30077
30403
  required:
30078
30404
  - password
30079
- x-mutually-exclusive-body-groups: *ref_25
30405
+ x-mutually-exclusive-body-groups: *ref_26
30080
30406
  VerifyEmailAddressDto:
30081
30407
  type: object
30082
30408
  properties:
@@ -30185,7 +30511,7 @@ components:
30185
30511
  description: The events that the Webhook Endpoint is subscribed to.
30186
30512
  items:
30187
30513
  type: string
30188
- enum: &ref_26
30514
+ enum: &ref_27
30189
30515
  - agent.blueprint.created
30190
30516
  - agent.blueprint.deleted
30191
30517
  - agent.blueprint.updated
@@ -30316,7 +30642,7 @@ components:
30316
30642
  description: The events that the Webhook Endpoint is subscribed to.
30317
30643
  items:
30318
30644
  type: string
30319
- enum: *ref_26
30645
+ enum: *ref_27
30320
30646
  example:
30321
30647
  - user.created
30322
30648
  - dsync.user.created
@@ -33367,6 +33693,41 @@ components:
33367
33693
  - data
33368
33694
  - list_metadata
33369
33695
  - list_metadata
33696
+ DirectorySyncResponse:
33697
+ type: object
33698
+ properties:
33699
+ status:
33700
+ type: string
33701
+ description: >-
33702
+ The sync request was queued for asynchronous processing. This does
33703
+ not indicate that the sync has started or completed.
33704
+ example: queued
33705
+ const: queued
33706
+ required:
33707
+ - status
33708
+ DirectorySyncRateLimitError:
33709
+ type: object
33710
+ properties:
33711
+ code:
33712
+ type: string
33713
+ description: The error code identifying the type of error.
33714
+ example: directory_sync_rate_limited
33715
+ const: directory_sync_rate_limited
33716
+ message:
33717
+ type: string
33718
+ description: A human-readable description of the error.
33719
+ example: Request could not be processed.
33720
+ retry_after_seconds:
33721
+ type: integer
33722
+ exclusiveMinimum: 0
33723
+ description: >-
33724
+ The number of seconds to wait before requesting another manual sync
33725
+ of this directory.
33726
+ example: 120
33727
+ required:
33728
+ - code
33729
+ - message
33730
+ - retry_after_seconds
33370
33731
  DirectoryGroup:
33371
33732
  type: object
33372
33733
  properties:
@@ -34010,7 +34371,7 @@ components:
34010
34371
  description: >-
34011
34372
  An object containing the custom attribute mapping for the Directory
34012
34373
  Provider.
34013
- example: &ref_33
34374
+ example: &ref_34
34014
34375
  department: Engineering
34015
34376
  job_title: Software Engineer
34016
34377
  role:
@@ -34249,7 +34610,7 @@ components:
34249
34610
  type: object
34250
34611
  additionalProperties: {}
34251
34612
  description: The event payload.
34252
- example: &ref_27
34613
+ example: &ref_28
34253
34614
  id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
34254
34615
  directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
34255
34616
  organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
@@ -34284,11 +34645,11 @@ components:
34284
34645
  - data
34285
34646
  - created_at
34286
34647
  description: An event emitted by WorkOS.
34287
- example: &ref_38
34648
+ example: &ref_39
34288
34649
  object: event
34289
34650
  id: event_01EHZNVPK3SFK441A1RGBFSHRT
34290
34651
  event: dsync.user.created
34291
- data: *ref_27
34652
+ data: *ref_28
34292
34653
  created_at: '2021-06-25T19:07:33.155Z'
34293
34654
  context: {}
34294
34655
  - oneOf:
@@ -34488,7 +34849,7 @@ components:
34488
34849
  description: >-
34489
34850
  Permission slugs forming the ceiling on what sessions
34490
34851
  minted from this blueprint may do.
34491
- example: &ref_28
34852
+ example: &ref_29
34492
34853
  - crm:read
34493
34854
  - email:send
34494
34855
  invocable_by:
@@ -34501,7 +34862,7 @@ components:
34501
34862
  description: >-
34502
34863
  Role slugs whose members may mint user-delegated
34503
34864
  sessions from this blueprint.
34504
- example: &ref_29
34865
+ example: &ref_30
34505
34866
  - manager
34506
34867
  organization_ids:
34507
34868
  type: array
@@ -34510,7 +34871,7 @@ components:
34510
34871
  description: >-
34511
34872
  Organizations in which autonomous sessions may be
34512
34873
  minted from this blueprint.
34513
- example: &ref_30
34874
+ example: &ref_31
34514
34875
  - org_01EHWNCE74X7JSDV0X3SZ3KJNY
34515
34876
  required:
34516
34877
  - role_slugs
@@ -34530,7 +34891,7 @@ components:
34530
34891
  Instance types that may be minted from this
34531
34892
  blueprint: `delegated` (acting for a user) and/or
34532
34893
  `autonomous` (acting as the agent itself).
34533
- example: &ref_31
34894
+ example: &ref_32
34534
34895
  - delegated
34535
34896
  - autonomous
34536
34897
  required:
@@ -34690,7 +35051,7 @@ components:
34690
35051
  description: >-
34691
35052
  Permission slugs forming the ceiling on what sessions
34692
35053
  minted from this blueprint may do.
34693
- example: *ref_28
35054
+ example: *ref_29
34694
35055
  invocable_by:
34695
35056
  type: object
34696
35057
  properties:
@@ -34701,7 +35062,7 @@ components:
34701
35062
  description: >-
34702
35063
  Role slugs whose members may mint user-delegated
34703
35064
  sessions from this blueprint.
34704
- example: *ref_29
35065
+ example: *ref_30
34705
35066
  organization_ids:
34706
35067
  type: array
34707
35068
  items:
@@ -34709,7 +35070,7 @@ components:
34709
35070
  description: >-
34710
35071
  Organizations in which autonomous sessions may be
34711
35072
  minted from this blueprint.
34712
- example: *ref_30
35073
+ example: *ref_31
34713
35074
  required:
34714
35075
  - role_slugs
34715
35076
  - organization_ids
@@ -34728,7 +35089,7 @@ components:
34728
35089
  Instance types that may be minted from this
34729
35090
  blueprint: `delegated` (acting for a user) and/or
34730
35091
  `autonomous` (acting as the agent itself).
34731
- example: *ref_31
35092
+ example: *ref_32
34732
35093
  required:
34733
35094
  - instance_types
34734
35095
  description: How sessions may be minted from this blueprint.
@@ -35764,7 +36125,7 @@ components:
35764
36125
  items:
35765
36126
  type: string
35766
36127
  description: The permissions granted to the API key.
35767
- example: &ref_32
36128
+ example: &ref_33
35768
36129
  - users:read
35769
36130
  - users:write
35770
36131
  created_at:
@@ -35890,7 +36251,7 @@ components:
35890
36251
  items:
35891
36252
  type: string
35892
36253
  description: The permissions granted to the API key.
35893
- example: *ref_32
36254
+ example: *ref_33
35894
36255
  created_at:
35895
36256
  type: string
35896
36257
  description: The timestamp when the API key was created.
@@ -36014,7 +36375,7 @@ components:
36014
36375
  items:
36015
36376
  type: string
36016
36377
  description: The permissions granted to the API key.
36017
- example: *ref_32
36378
+ example: *ref_33
36018
36379
  created_at:
36019
36380
  type: string
36020
36381
  description: The timestamp when the API key was created.
@@ -38881,7 +39242,7 @@ components:
38881
39242
  description: >-
38882
39243
  An object containing the custom attribute mapping for
38883
39244
  the Directory Provider.
38884
- example: *ref_33
39245
+ example: *ref_34
38885
39246
  role:
38886
39247
  $ref: '#/components/schemas/SlimRole'
38887
39248
  roles:
@@ -39071,7 +39432,7 @@ components:
39071
39432
  description: >-
39072
39433
  Labels assigned to the Feature Flag for categorizing and
39073
39434
  filtering.
39074
- example: &ref_34
39435
+ example: &ref_35
39075
39436
  - reports
39076
39437
  enabled:
39077
39438
  type: boolean
@@ -39232,7 +39593,7 @@ components:
39232
39593
  description: >-
39233
39594
  Labels assigned to the Feature Flag for categorizing and
39234
39595
  filtering.
39235
- example: *ref_34
39596
+ example: *ref_35
39236
39597
  enabled:
39237
39598
  type: boolean
39238
39599
  description: >-
@@ -39392,7 +39753,7 @@ components:
39392
39753
  description: >-
39393
39754
  Labels assigned to the Feature Flag for categorizing and
39394
39755
  filtering.
39395
- example: *ref_34
39756
+ example: *ref_35
39396
39757
  enabled:
39397
39758
  type: boolean
39398
39759
  description: >-
@@ -39672,7 +40033,7 @@ components:
39672
40033
  description: >-
39673
40034
  Labels assigned to the Feature Flag for categorizing and
39674
40035
  filtering.
39675
- example: *ref_34
40036
+ example: *ref_35
39676
40037
  enabled:
39677
40038
  type: boolean
39678
40039
  description: >-
@@ -40660,7 +41021,7 @@ components:
40660
41021
  description: >-
40661
41022
  Object containing [metadata](/authkit/metadata)
40662
41023
  key/value pairs associated with the Organization.
40663
- example: &ref_35
41024
+ example: &ref_36
40664
41025
  tier: diamond
40665
41026
  propertyNames:
40666
41027
  maxLength: 40
@@ -40810,7 +41171,7 @@ components:
40810
41171
  description: >-
40811
41172
  Object containing [metadata](/authkit/metadata)
40812
41173
  key/value pairs associated with the Organization.
40813
- example: *ref_35
41174
+ example: *ref_36
40814
41175
  propertyNames:
40815
41176
  maxLength: 40
40816
41177
  maxProperties: 50
@@ -41637,7 +41998,7 @@ components:
41637
41998
  items:
41638
41999
  type: string
41639
42000
  description: The permissions granted by the role.
41640
- example: &ref_36
42001
+ example: &ref_37
41641
42002
  - users:read
41642
42003
  - users:write
41643
42004
  created_at:
@@ -41721,7 +42082,7 @@ components:
41721
42082
  items:
41722
42083
  type: string
41723
42084
  description: The permissions granted by the role.
41724
- example: *ref_36
42085
+ example: *ref_37
41725
42086
  created_at:
41726
42087
  format: date-time
41727
42088
  type: string
@@ -41803,7 +42164,7 @@ components:
41803
42164
  items:
41804
42165
  type: string
41805
42166
  description: The permissions granted by the role.
41806
- example: *ref_36
42167
+ example: *ref_37
41807
42168
  created_at:
41808
42169
  format: date-time
41809
42170
  type: string
@@ -41940,7 +42301,7 @@ components:
41940
42301
  description: >-
41941
42302
  Object containing [metadata](/authkit/metadata)
41942
42303
  key/value pairs associated with the Organization.
41943
- example: *ref_35
42304
+ example: *ref_36
41944
42305
  propertyNames:
41945
42306
  maxLength: 40
41946
42307
  maxProperties: 50
@@ -43136,7 +43497,7 @@ components:
43136
43497
  items:
43137
43498
  type: string
43138
43499
  description: The permissions granted by the role.
43139
- example: &ref_37
43500
+ example: &ref_38
43140
43501
  - users:read
43141
43502
  - users:write
43142
43503
  created_at:
@@ -43202,7 +43563,7 @@ components:
43202
43563
  items:
43203
43564
  type: string
43204
43565
  description: The permissions granted by the role.
43205
- example: *ref_37
43566
+ example: *ref_38
43206
43567
  created_at:
43207
43568
  format: date-time
43208
43569
  type: string
@@ -43266,7 +43627,7 @@ components:
43266
43627
  items:
43267
43628
  type: string
43268
43629
  description: The permissions granted by the role.
43269
- example: *ref_37
43630
+ example: *ref_38
43270
43631
  created_at:
43271
43632
  format: date-time
43272
43633
  type: string
@@ -44468,7 +44829,7 @@ components:
44468
44829
  - data
44469
44830
  - created_at
44470
44831
  - object
44471
- example: *ref_38
44832
+ example: *ref_39
44472
44833
  description: An event emitted by WorkOS.
44473
44834
  EventList:
44474
44835
  type: object
@@ -44503,7 +44864,7 @@ components:
44503
44864
  example:
44504
44865
  object: list
44505
44866
  data:
44506
- - *ref_38
44867
+ - *ref_39
44507
44868
  list_metadata:
44508
44869
  after: event_01EHZNVPK3SFK441A1RGBFSHRT
44509
44870
  JwtTemplate:
@@ -45810,6 +46171,25 @@ components:
45810
46171
  https://api.workos.com/data-integrations/q2czJKmVAraSBg8xFpT7M9uR/authorize-redirect
45811
46172
  required:
45812
46173
  - url
46174
+ AuthMethodMismatchError:
46175
+ type: object
46176
+ properties:
46177
+ code:
46178
+ type: string
46179
+ description: >-
46180
+ Error code indicating the endpoint does not match the installation
46181
+ auth method.
46182
+ example: auth_method_mismatch
46183
+ const: auth_method_mismatch
46184
+ message:
46185
+ type: string
46186
+ description: A human-readable explanation of the mismatch.
46187
+ example: >-
46188
+ This installation uses oauth authentication. Use the POST
46189
+ /:slug/token endpoint instead.
46190
+ required:
46191
+ - code
46192
+ - message
45813
46193
  DataIntegrationAccessTokenResponse:
45814
46194
  oneOf:
45815
46195
  - type: object
@@ -45909,25 +46289,6 @@ components:
45909
46289
  required:
45910
46290
  - code
45911
46291
  - message
45912
- AuthMethodMismatchError:
45913
- type: object
45914
- properties:
45915
- code:
45916
- type: string
45917
- description: >-
45918
- Error code indicating the endpoint does not match the installation
45919
- auth method.
45920
- example: auth_method_mismatch
45921
- const: auth_method_mismatch
45922
- message:
45923
- type: string
45924
- description: A human-readable explanation of the mismatch.
45925
- example: >-
45926
- This installation uses oauth authentication. Use the POST
45927
- /:slug/token endpoint instead.
45928
- required:
45929
- - code
45930
- - message
45931
46292
  DataIntegrationVendedCredential:
45932
46293
  discriminator:
45933
46294
  propertyName: auth_method
@@ -45998,7 +46359,7 @@ components:
45998
46359
  integration or organization pins require reconnecting or
45999
46360
  explicitly rebinding the connection. Defaults are live and can
46000
46361
  differ from a cached token's audience until refresh or re-mint.
46001
- example: &ref_39
46362
+ example: &ref_40
46002
46363
  account: myorg-myaccount
46003
46364
  required:
46004
46365
  - object
@@ -46043,7 +46404,7 @@ components:
46043
46404
  integration or organization pins require reconnecting or
46044
46405
  explicitly rebinding the connection. Defaults are live and can
46045
46406
  differ from a cached token's audience until refresh or re-mint.
46046
- example: *ref_39
46407
+ example: *ref_40
46047
46408
  required:
46048
46409
  - object
46049
46410
  - auth_method
@@ -46120,7 +46481,7 @@ components:
46120
46481
  integration or organization pins require reconnecting or
46121
46482
  explicitly rebinding the connection. Defaults are live and can
46122
46483
  differ from a cached token's audience until refresh or re-mint.
46123
- example: *ref_39
46484
+ example: *ref_40
46124
46485
  required:
46125
46486
  - object
46126
46487
  - auth_method
@@ -46500,7 +46861,7 @@ components:
46500
46861
  items:
46501
46862
  type: string
46502
46863
  description: The OAuth scopes granted for this connection.
46503
- example: &ref_40
46864
+ example: &ref_41
46504
46865
  - repo
46505
46866
  - user:email
46506
46867
  auth_method:
@@ -46550,7 +46911,7 @@ components:
46550
46911
  `installation` scope, excluding secret and undeclared
46551
46912
  fields. Returned for every authentication method;
46552
46913
  empty when no stored values can be disclosed.
46553
- example: &ref_41
46914
+ example: &ref_42
46554
46915
  instance_url: https://example.my.salesforce.com
46555
46916
  state:
46556
46917
  type: string
@@ -46679,7 +47040,7 @@ components:
46679
47040
  items:
46680
47041
  type: string
46681
47042
  description: The OAuth scopes granted for this connection.
46682
- example: *ref_40
47043
+ example: *ref_41
46683
47044
  auth_method:
46684
47045
  type: string
46685
47046
  enum:
@@ -46726,7 +47087,7 @@ components:
46726
47087
  `installation` scope, excluding secret and undeclared
46727
47088
  fields. Returned for every authentication method; empty
46728
47089
  when no stored values can be disclosed.
46729
- example: *ref_41
47090
+ example: *ref_42
46730
47091
  state:
46731
47092
  type: string
46732
47093
  enum: