@workos/openapi-spec 0.105.0 → 0.107.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_5
3770
+ x-mutually-exclusive-body-groups: &ref_6
3771
3771
  resource_target:
3772
3772
  optional: false
3773
3773
  variants:
@@ -4410,7 +4410,7 @@ paths:
4410
4410
  summary: Assign a role
4411
4411
  tags:
4412
4412
  - authorization
4413
- x-mutually-exclusive-body-groups: &ref_6
4413
+ x-mutually-exclusive-body-groups: &ref_7
4414
4414
  resource_target:
4415
4415
  optional: false
4416
4416
  variants:
@@ -4481,7 +4481,7 @@ paths:
4481
4481
  summary: Remove a role assignment
4482
4482
  tags:
4483
4483
  - authorization
4484
- x-mutually-exclusive-body-groups: &ref_7
4484
+ x-mutually-exclusive-body-groups: &ref_8
4485
4485
  resource_target:
4486
4486
  optional: false
4487
4487
  variants:
@@ -6904,7 +6904,7 @@ paths:
6904
6904
  summary: Create an authorization resource
6905
6905
  tags:
6906
6906
  - authorization
6907
- x-mutually-exclusive-body-groups: &ref_8
6907
+ x-mutually-exclusive-body-groups: &ref_9
6908
6908
  parent_resource:
6909
6909
  optional: true
6910
6910
  variants:
@@ -9043,7 +9043,7 @@ paths:
9043
9043
  tags:
9044
9044
  - connections
9045
9045
  x-feature-flag: connections-api-migrations-capabilities-api
9046
- x-mutually-exclusive-body-groups: &ref_9
9046
+ x-mutually-exclusive-body-groups: &ref_10
9047
9047
  protocol_options:
9048
9048
  optional: false
9049
9049
  variants:
@@ -10271,7 +10271,7 @@ paths:
10271
10271
  tags:
10272
10272
  - connections
10273
10273
  x-feature-flag: connections-api-migrations-capabilities-api
10274
- x-mutually-exclusive-body-groups: &ref_12
10274
+ x-mutually-exclusive-body-groups: &ref_13
10275
10275
  protocol_options:
10276
10276
  optional: true
10277
10277
  variants:
@@ -10472,7 +10472,6 @@ paths:
10472
10472
  summary: Create a data integration
10473
10473
  tags:
10474
10474
  - pipes
10475
- x-feature-flag: pipes-management-api
10476
10475
  get:
10477
10476
  description: >-
10478
10477
  Lists the environment's data integrations configured with `custom` or
@@ -10581,7 +10580,6 @@ paths:
10581
10580
  summary: List data integrations
10582
10581
  tags:
10583
10582
  - pipes
10584
- x-feature-flag: pipes-management-api
10585
10583
  /data-integrations/{slug}:
10586
10584
  get:
10587
10585
  description: Retrieves the user-owned data integration by its slug.
@@ -10619,7 +10617,6 @@ paths:
10619
10617
  summary: Get a data integration
10620
10618
  tags:
10621
10619
  - pipes
10622
- x-feature-flag: pipes-management-api
10623
10620
  put:
10624
10621
  description: >-
10625
10622
  Updates the description, enabled state, or custom credentials of the
@@ -10719,7 +10716,6 @@ paths:
10719
10716
  summary: Update a data integration
10720
10717
  tags:
10721
10718
  - pipes
10722
- x-feature-flag: pipes-management-api
10723
10719
  delete:
10724
10720
  description: >-
10725
10721
  Deletes the user-owned data integration and all of its connected
@@ -10755,7 +10751,6 @@ paths:
10755
10751
  summary: Delete a data integration
10756
10752
  tags:
10757
10753
  - pipes
10758
- x-feature-flag: pipes-management-api
10759
10754
  /data-integrations/{slug}/api-key:
10760
10755
  put:
10761
10756
  description: >-
@@ -10777,49 +10772,184 @@ paths:
10777
10772
  content:
10778
10773
  application/json:
10779
10774
  schema:
10780
- type: object
10781
- properties:
10782
- user_id:
10783
- type: string
10784
- description: A [User](/reference/authkit/user) identifier.
10785
- example: user_01EHZNVPK3SFK441A1RGBFSHRT
10786
- organization_id:
10787
- type: string
10788
- description: >-
10789
- An [Organization](/reference/organization) identifier.
10790
- Optional parameter to scope the connection to a specific
10791
- organization. Required when `connection_owner` is
10792
- `organization`.
10793
- example: org_01EHZNVPK3SFK441A1RGBFSHRT
10794
- connected_account_id:
10795
- type: string
10796
- pattern: ^data_installation_.+$
10797
- description: >-
10798
- A [connected account](/reference/pipes/connected-account)
10799
- identifier. Use this to rotate a specific existing
10800
- connection.
10801
- example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
10802
- connection_owner:
10803
- type: string
10804
- enum:
10805
- - user
10806
- - organization
10807
- description: >-
10808
- Whose connection to create or rotate. `user` (the default)
10809
- addresses the connection owned by `user_id`. `organization`
10810
- addresses the connection shared by every member of
10811
- `organization_id`; `user_id` then identifies the member
10812
- performing the request and must be an active member of the
10813
- organization.
10814
- example: user
10815
- secret:
10816
- type: string
10817
- minLength: 1
10818
- description: The API key secret to store for this integration.
10819
- example: sk-1234567890abcdef
10820
- required:
10821
- - user_id
10822
- - secret
10775
+ oneOf:
10776
+ - type: object
10777
+ properties:
10778
+ user_id:
10779
+ type: string
10780
+ description: A [User](/reference/authkit/user) identifier.
10781
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
10782
+ organization_id:
10783
+ type: string
10784
+ description: >-
10785
+ An [Organization](/reference/organization) identifier.
10786
+ Optional parameter to scope the connection to a specific
10787
+ organization. Required when `connection_owner` is
10788
+ `organization`.
10789
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
10790
+ connection_owner:
10791
+ type: string
10792
+ enum:
10793
+ - user
10794
+ - organization
10795
+ description: >-
10796
+ Whose connection to create or rotate. `user` (the
10797
+ default) addresses the connection owned by `user_id`.
10798
+ `organization` addresses the connection shared by every
10799
+ member of `organization_id`; `user_id` then identifies
10800
+ the member performing the request and must be an active
10801
+ member of the organization.
10802
+ example: user
10803
+ secret:
10804
+ type: string
10805
+ minLength: 1
10806
+ description: The API key secret to store for this integration.
10807
+ example: sk-1234567890abcdef
10808
+ required:
10809
+ - user_id
10810
+ - secret
10811
+ additionalProperties: false
10812
+ - type: object
10813
+ properties:
10814
+ user_id:
10815
+ type: string
10816
+ description: A [User](/reference/authkit/user) identifier.
10817
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
10818
+ organization_id:
10819
+ type: string
10820
+ description: >-
10821
+ An [Organization](/reference/organization) identifier.
10822
+ Optional parameter to scope the connection to a specific
10823
+ organization. Required when `connection_owner` is
10824
+ `organization`.
10825
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
10826
+ connection_owner:
10827
+ type: string
10828
+ enum:
10829
+ - user
10830
+ - organization
10831
+ description: >-
10832
+ Whose connection to create or rotate. `user` (the
10833
+ default) addresses the connection owned by `user_id`.
10834
+ `organization` addresses the connection shared by every
10835
+ member of `organization_id`; `user_id` then identifies
10836
+ the member performing the request and must be an active
10837
+ member of the organization.
10838
+ example: user
10839
+ secret:
10840
+ type: string
10841
+ minLength: 1
10842
+ description: The API key secret to store for this integration.
10843
+ example: sk-1234567890abcdef
10844
+ connection_intent:
10845
+ type: string
10846
+ description: >-
10847
+ Create another connection. The first connection for an
10848
+ owner shape fills the compatibility slot; later
10849
+ connections are standard.
10850
+ example: add
10851
+ const: add
10852
+ required:
10853
+ - user_id
10854
+ - secret
10855
+ - connection_intent
10856
+ additionalProperties: false
10857
+ - type: object
10858
+ properties:
10859
+ user_id:
10860
+ type: string
10861
+ description: A [User](/reference/authkit/user) identifier.
10862
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
10863
+ organization_id:
10864
+ type: string
10865
+ description: >-
10866
+ An [Organization](/reference/organization) identifier.
10867
+ Optional parameter to scope the connection to a specific
10868
+ organization. Required when `connection_owner` is
10869
+ `organization`.
10870
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
10871
+ connection_owner:
10872
+ type: string
10873
+ enum:
10874
+ - user
10875
+ - organization
10876
+ description: >-
10877
+ Whose connection to create or rotate. `user` (the
10878
+ default) addresses the connection owned by `user_id`.
10879
+ `organization` addresses the connection shared by every
10880
+ member of `organization_id`; `user_id` then identifies
10881
+ the member performing the request and must be an active
10882
+ member of the organization.
10883
+ example: user
10884
+ secret:
10885
+ type: string
10886
+ minLength: 1
10887
+ description: The API key secret to store for this integration.
10888
+ example: sk-1234567890abcdef
10889
+ connection_intent:
10890
+ type: string
10891
+ description: >-
10892
+ Reauthorize exactly the connection named by
10893
+ `connected_account_id`.
10894
+ example: reauthorize
10895
+ const: reauthorize
10896
+ connected_account_id:
10897
+ type: string
10898
+ pattern: ^data_installation_.+$
10899
+ description: >-
10900
+ The exact connected account to reauthorize. Required
10901
+ with `connection_intent: reauthorize`.
10902
+ example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
10903
+ required:
10904
+ - user_id
10905
+ - secret
10906
+ - connection_intent
10907
+ - connected_account_id
10908
+ additionalProperties: false
10909
+ - type: object
10910
+ properties:
10911
+ user_id:
10912
+ type: string
10913
+ description: A [User](/reference/authkit/user) identifier.
10914
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
10915
+ organization_id:
10916
+ type: string
10917
+ description: >-
10918
+ An [Organization](/reference/organization) identifier.
10919
+ Optional parameter to scope the connection to a specific
10920
+ organization. Required when `connection_owner` is
10921
+ `organization`.
10922
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
10923
+ connection_owner:
10924
+ type: string
10925
+ enum:
10926
+ - user
10927
+ - organization
10928
+ description: >-
10929
+ Whose connection to create or rotate. `user` (the
10930
+ default) addresses the connection owned by `user_id`.
10931
+ `organization` addresses the connection shared by every
10932
+ member of `organization_id`; `user_id` then identifies
10933
+ the member performing the request and must be an active
10934
+ member of the organization.
10935
+ example: user
10936
+ secret:
10937
+ type: string
10938
+ minLength: 1
10939
+ description: The API key secret to store for this integration.
10940
+ example: sk-1234567890abcdef
10941
+ connected_account_id:
10942
+ type: string
10943
+ pattern: ^data_installation_.+$
10944
+ description: >-
10945
+ The exact connected account to reauthorize. The
10946
+ reauthorize intent may be omitted for compatibility.
10947
+ example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
10948
+ required:
10949
+ - user_id
10950
+ - secret
10951
+ - connected_account_id
10952
+ additionalProperties: false
10823
10953
  responses:
10824
10954
  '200':
10825
10955
  description: The resulting connected account after the upsert.
@@ -11043,65 +11173,245 @@ paths:
11043
11173
  content:
11044
11174
  application/json:
11045
11175
  schema:
11046
- type: object
11047
- properties:
11048
- user_id:
11049
- type: string
11050
- description: A [User](/reference/authkit/user) identifier.
11051
- example: user_01EHZNVPK3SFK441A1RGBFSHRT
11052
- organization_id:
11053
- type: string
11054
- description: >-
11055
- An [Organization](/reference/organization) identifier.
11056
- Optional parameter to scope the connection to a specific
11057
- organization. Required when `connection_owner` is
11058
- `organization`.
11059
- example: org_01EHZNVPK3SFK441A1RGBFSHRT
11060
- connected_account_id:
11061
- type: string
11062
- pattern: ^data_installation_.+$
11063
- description: >-
11064
- A [connected account](/reference/pipes/connected-account)
11065
- identifier. Use this to rotate a specific existing
11066
- connection.
11067
- example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
11068
- connection_owner:
11069
- type: string
11070
- enum:
11071
- - user
11072
- - organization
11073
- description: >-
11074
- Whose connection to create or rotate. `user` (the default)
11075
- addresses the connection owned by `user_id`. `organization`
11076
- addresses the connection shared by every member of
11077
- `organization_id`; `user_id` then identifies the member
11078
- performing the request and must be an active member of the
11079
- organization.
11080
- example: user
11081
- client_id:
11082
- type: string
11083
- minLength: 1
11084
- description: The OAuth client ID to store for this integration.
11085
- example: 3MVG9...
11086
- client_secret:
11087
- type: string
11088
- minLength: 1
11089
- description: The OAuth client secret to store for this integration.
11090
- example: shhh-secret
11091
- config:
11092
- type: object
11093
- additionalProperties:
11094
- type: string
11095
- description: >-
11096
- Provider-specific configuration values collected for this
11097
- installation, keyed by the provider's config field
11098
- descriptors.
11099
- example:
11100
- salesforce_host: acme.my.salesforce.com
11101
- required:
11102
- - user_id
11103
- - client_id
11104
- - client_secret
11176
+ oneOf:
11177
+ - type: object
11178
+ properties:
11179
+ user_id:
11180
+ type: string
11181
+ description: A [User](/reference/authkit/user) identifier.
11182
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
11183
+ organization_id:
11184
+ type: string
11185
+ description: >-
11186
+ An [Organization](/reference/organization) identifier.
11187
+ Optional parameter to scope the connection to a specific
11188
+ organization. Required when `connection_owner` is
11189
+ `organization`.
11190
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
11191
+ connection_owner:
11192
+ type: string
11193
+ enum:
11194
+ - user
11195
+ - organization
11196
+ description: >-
11197
+ Whose connection to create or rotate. `user` (the
11198
+ default) addresses the connection owned by `user_id`.
11199
+ `organization` addresses the connection shared by every
11200
+ member of `organization_id`; `user_id` then identifies
11201
+ the member performing the request and must be an active
11202
+ member of the organization.
11203
+ example: user
11204
+ client_id:
11205
+ type: string
11206
+ minLength: 1
11207
+ description: The OAuth client ID to store for this integration.
11208
+ example: 3MVG9...
11209
+ client_secret:
11210
+ type: string
11211
+ minLength: 1
11212
+ description: The OAuth client secret to store for this integration.
11213
+ example: shhh-secret
11214
+ config:
11215
+ type: object
11216
+ additionalProperties:
11217
+ type: string
11218
+ description: >-
11219
+ Provider-specific configuration values collected for
11220
+ this installation, keyed by the provider's config field
11221
+ descriptors.
11222
+ example: &ref_1
11223
+ salesforce_host: acme.my.salesforce.com
11224
+ required:
11225
+ - user_id
11226
+ - client_id
11227
+ - client_secret
11228
+ additionalProperties: false
11229
+ - type: object
11230
+ properties:
11231
+ user_id:
11232
+ type: string
11233
+ description: A [User](/reference/authkit/user) identifier.
11234
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
11235
+ organization_id:
11236
+ type: string
11237
+ description: >-
11238
+ An [Organization](/reference/organization) identifier.
11239
+ Optional parameter to scope the connection to a specific
11240
+ organization. Required when `connection_owner` is
11241
+ `organization`.
11242
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
11243
+ connection_owner:
11244
+ type: string
11245
+ enum:
11246
+ - user
11247
+ - organization
11248
+ description: >-
11249
+ Whose connection to create or rotate. `user` (the
11250
+ default) addresses the connection owned by `user_id`.
11251
+ `organization` addresses the connection shared by every
11252
+ member of `organization_id`; `user_id` then identifies
11253
+ the member performing the request and must be an active
11254
+ member of the organization.
11255
+ example: user
11256
+ client_id:
11257
+ type: string
11258
+ minLength: 1
11259
+ description: The OAuth client ID to store for this integration.
11260
+ example: 3MVG9...
11261
+ client_secret:
11262
+ type: string
11263
+ minLength: 1
11264
+ description: The OAuth client secret to store for this integration.
11265
+ example: shhh-secret
11266
+ config:
11267
+ type: object
11268
+ additionalProperties:
11269
+ type: string
11270
+ description: >-
11271
+ Provider-specific configuration values collected for
11272
+ this installation, keyed by the provider's config field
11273
+ descriptors.
11274
+ example: *ref_1
11275
+ connection_intent:
11276
+ type: string
11277
+ description: >-
11278
+ Create another connection. The first connection for an
11279
+ owner shape fills the compatibility slot; later
11280
+ connections are standard.
11281
+ example: add
11282
+ const: add
11283
+ required:
11284
+ - user_id
11285
+ - client_id
11286
+ - client_secret
11287
+ - connection_intent
11288
+ additionalProperties: false
11289
+ - type: object
11290
+ properties:
11291
+ user_id:
11292
+ type: string
11293
+ description: A [User](/reference/authkit/user) identifier.
11294
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
11295
+ organization_id:
11296
+ type: string
11297
+ description: >-
11298
+ An [Organization](/reference/organization) identifier.
11299
+ Optional parameter to scope the connection to a specific
11300
+ organization. Required when `connection_owner` is
11301
+ `organization`.
11302
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
11303
+ connection_owner:
11304
+ type: string
11305
+ enum:
11306
+ - user
11307
+ - organization
11308
+ description: >-
11309
+ Whose connection to create or rotate. `user` (the
11310
+ default) addresses the connection owned by `user_id`.
11311
+ `organization` addresses the connection shared by every
11312
+ member of `organization_id`; `user_id` then identifies
11313
+ the member performing the request and must be an active
11314
+ member of the organization.
11315
+ example: user
11316
+ client_id:
11317
+ type: string
11318
+ minLength: 1
11319
+ description: The OAuth client ID to store for this integration.
11320
+ example: 3MVG9...
11321
+ client_secret:
11322
+ type: string
11323
+ minLength: 1
11324
+ description: The OAuth client secret to store for this integration.
11325
+ example: shhh-secret
11326
+ config:
11327
+ type: object
11328
+ additionalProperties:
11329
+ type: string
11330
+ description: >-
11331
+ Provider-specific configuration values collected for
11332
+ this installation, keyed by the provider's config field
11333
+ descriptors.
11334
+ example: *ref_1
11335
+ connection_intent:
11336
+ type: string
11337
+ description: >-
11338
+ Reauthorize exactly the connection named by
11339
+ `connected_account_id`.
11340
+ example: reauthorize
11341
+ const: reauthorize
11342
+ connected_account_id:
11343
+ type: string
11344
+ pattern: ^data_installation_.+$
11345
+ description: >-
11346
+ The exact connected account to reauthorize. Required
11347
+ with `connection_intent: reauthorize`.
11348
+ example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
11349
+ required:
11350
+ - user_id
11351
+ - client_id
11352
+ - client_secret
11353
+ - connection_intent
11354
+ - connected_account_id
11355
+ additionalProperties: false
11356
+ - type: object
11357
+ properties:
11358
+ user_id:
11359
+ type: string
11360
+ description: A [User](/reference/authkit/user) identifier.
11361
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
11362
+ organization_id:
11363
+ type: string
11364
+ description: >-
11365
+ An [Organization](/reference/organization) identifier.
11366
+ Optional parameter to scope the connection to a specific
11367
+ organization. Required when `connection_owner` is
11368
+ `organization`.
11369
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
11370
+ connection_owner:
11371
+ type: string
11372
+ enum:
11373
+ - user
11374
+ - organization
11375
+ description: >-
11376
+ Whose connection to create or rotate. `user` (the
11377
+ default) addresses the connection owned by `user_id`.
11378
+ `organization` addresses the connection shared by every
11379
+ member of `organization_id`; `user_id` then identifies
11380
+ the member performing the request and must be an active
11381
+ member of the organization.
11382
+ example: user
11383
+ client_id:
11384
+ type: string
11385
+ minLength: 1
11386
+ description: The OAuth client ID to store for this integration.
11387
+ example: 3MVG9...
11388
+ client_secret:
11389
+ type: string
11390
+ minLength: 1
11391
+ description: The OAuth client secret to store for this integration.
11392
+ example: shhh-secret
11393
+ config:
11394
+ type: object
11395
+ additionalProperties:
11396
+ type: string
11397
+ description: >-
11398
+ Provider-specific configuration values collected for
11399
+ this installation, keyed by the provider's config field
11400
+ descriptors.
11401
+ example: *ref_1
11402
+ connected_account_id:
11403
+ type: string
11404
+ pattern: ^data_installation_.+$
11405
+ description: >-
11406
+ The exact connected account to reauthorize. The
11407
+ reauthorize intent may be omitted for compatibility.
11408
+ example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
11409
+ required:
11410
+ - user_id
11411
+ - client_id
11412
+ - client_secret
11413
+ - connected_account_id
11414
+ additionalProperties: false
11105
11415
  responses:
11106
11416
  '200':
11107
11417
  description: The resulting connected account after the upsert.
@@ -11416,7 +11726,6 @@ paths:
11416
11726
  summary: Get an organization-owned data integration
11417
11727
  tags:
11418
11728
  - pipes
11419
- x-feature-flag: pipes-management-api
11420
11729
  put:
11421
11730
  description: >-
11422
11731
  Updates the description, enabled state, or custom credentials of the
@@ -11555,7 +11864,6 @@ paths:
11555
11864
  summary: Update an organization-owned data integration
11556
11865
  tags:
11557
11866
  - pipes
11558
- x-feature-flag: pipes-management-api
11559
11867
  delete:
11560
11868
  description: >-
11561
11869
  Deletes the organization-owned data integration for a provider and all
@@ -11593,7 +11901,6 @@ paths:
11593
11901
  summary: Delete an organization-owned data integration
11594
11902
  tags:
11595
11903
  - pipes
11596
- x-feature-flag: pipes-management-api
11597
11904
  /data-integrations/{slug}/token:
11598
11905
  post:
11599
11906
  description: >-
@@ -13741,7 +14048,7 @@ paths:
13741
14048
  summary: Set Retention
13742
14049
  tags:
13743
14050
  - audit-logs
13744
- x-mutually-exclusive-body-groups: &ref_4
14051
+ x-mutually-exclusive-body-groups: &ref_5
13745
14052
  retention:
13746
14053
  optional: false
13747
14054
  variants:
@@ -15053,8 +15360,10 @@ paths:
15053
15360
  description: >-
15054
15361
  Imports an organization-owned [connected
15055
15362
  account](/reference/pipes/connected-account) by providing OAuth tokens
15056
- directly. Use this to migrate existing connections or set up connections
15057
- without going through the OAuth flow.
15363
+ directly. Omit `connection_intent` to create only the compatibility
15364
+ connection, or set it to `add` to explicitly create another connection.
15365
+ This creation-only endpoint does not accept `connected_account_id` or
15366
+ reauthorization intent.
15058
15367
  operationId: >-
15059
15368
  DataIntegrationsOrganizationController_createOrganizationDataInstallation
15060
15369
  parameters:
@@ -15079,7 +15388,7 @@ paths:
15079
15388
  content:
15080
15389
  application/json:
15081
15390
  schema:
15082
- $ref: '#/components/schemas/OrganizationConnectedAccountDto'
15391
+ $ref: '#/components/schemas/CreateOrganizationConnectedAccountDto'
15083
15392
  responses:
15084
15393
  '201':
15085
15394
  description: The connected account was created successfully.
@@ -15137,8 +15446,8 @@ paths:
15137
15446
  - message
15138
15447
  '409':
15139
15448
  description: >-
15140
- A connected account already exists for this organization and
15141
- integration.
15449
+ The compatibility connection already exists for this organization
15450
+ and integration.
15142
15451
  content:
15143
15452
  application/json:
15144
15453
  schema:
@@ -15213,10 +15522,31 @@ paths:
15213
15522
  - code
15214
15523
  - message
15215
15524
  - errors
15525
+ '503':
15526
+ description: >-
15527
+ Another connection is being created for this owner and provider.
15528
+ Retry the request.
15529
+ content:
15530
+ application/json:
15531
+ schema:
15532
+ type: object
15533
+ properties:
15534
+ code:
15535
+ type: string
15536
+ description: The error code identifying the type of error.
15537
+ example: concurrent_request
15538
+ const: concurrent_request
15539
+ message:
15540
+ type: string
15541
+ description: A human-readable description of the error.
15542
+ example: Request could not be processed.
15543
+ required:
15544
+ - code
15545
+ - message
15216
15546
  summary: Import an organization connected account
15217
15547
  tags:
15218
15548
  - organizations.data-providers
15219
- x-feature-flag: pipes-management-api
15549
+ x-feature-flag: pipes-org-integrations
15220
15550
  put:
15221
15551
  description: >-
15222
15552
  Updates an organization's [connected
@@ -15245,8 +15575,9 @@ paths:
15245
15575
  required: false
15246
15576
  in: query
15247
15577
  description: >-
15248
- Set to `true` to use the plural connection contract. When omitted or
15249
- `false`, only the compatibility connection is considered.
15578
+ Accepted for compatibility; does not change update targeting. Omit
15579
+ intent and selector to update the compatibility connection, or
15580
+ supply `connected_account_id` to update an exact connection.
15250
15581
  schema:
15251
15582
  example: true
15252
15583
  type: boolean
@@ -15260,6 +15591,17 @@ paths:
15260
15591
  minLength: 1
15261
15592
  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
15262
15593
  type: string
15594
+ - name: connection_intent
15595
+ required: false
15596
+ in: query
15597
+ description: >-
15598
+ Set to `reauthorize` with `connected_account_id` to update one exact
15599
+ connection. The intent may be omitted when supplying an ID. Omit
15600
+ both for permanent compatibility behavior.
15601
+ schema:
15602
+ type: string
15603
+ example: reauthorize
15604
+ const: reauthorize
15263
15605
  requestBody:
15264
15606
  required: true
15265
15607
  content:
@@ -15384,7 +15726,7 @@ paths:
15384
15726
  summary: Update an organization connected account
15385
15727
  tags:
15386
15728
  - organizations.data-providers
15387
- x-feature-flag: pipes-management-api
15729
+ x-feature-flag: pipes-org-integrations
15388
15730
  /organizations/{organization_id}/data_providers:
15389
15731
  get:
15390
15732
  description: >-
@@ -15442,7 +15784,7 @@ paths:
15442
15784
  credentialsType: oauth2
15443
15785
  createdAt: '2024-01-15T10:30:00.000Z'
15444
15786
  updatedAt: '2024-01-15T10:30:00.000Z'
15445
- connected_account: &ref_1
15787
+ connected_account: &ref_2
15446
15788
  object: connected_account
15447
15789
  id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
15448
15790
  user_id: null
@@ -15467,7 +15809,7 @@ paths:
15467
15809
  createdAt: '2024-01-16T14:20:00.000Z'
15468
15810
  updatedAt: '2024-01-16T14:20:00.000Z'
15469
15811
  connected_accounts:
15470
- - *ref_1
15812
+ - *ref_2
15471
15813
  '401':
15472
15814
  description: The request is missing a valid API key.
15473
15815
  '404':
@@ -20365,7 +20707,7 @@ paths:
20365
20707
  summary: Create an organization membership
20366
20708
  tags:
20367
20709
  - user-management.organization-membership
20368
- x-mutually-exclusive-body-groups: &ref_18
20710
+ x-mutually-exclusive-body-groups: &ref_19
20369
20711
  role:
20370
20712
  optional: true
20371
20713
  variants:
@@ -20549,7 +20891,7 @@ paths:
20549
20891
  summary: Update an organization membership
20550
20892
  tags:
20551
20893
  - user-management.organization-membership
20552
- x-mutually-exclusive-body-groups: &ref_19
20894
+ x-mutually-exclusive-body-groups: &ref_20
20553
20895
  role:
20554
20896
  optional: true
20555
20897
  variants:
@@ -21869,7 +22211,7 @@ paths:
21869
22211
  summary: Create a user
21870
22212
  tags:
21871
22213
  - user-management.users
21872
- x-mutually-exclusive-body-groups: &ref_20
22214
+ x-mutually-exclusive-body-groups: &ref_21
21873
22215
  password:
21874
22216
  optional: true
21875
22217
  variants:
@@ -22162,7 +22504,7 @@ paths:
22162
22504
  summary: Update a user
22163
22505
  tags:
22164
22506
  - user-management.users
22165
- x-mutually-exclusive-body-groups: &ref_24
22507
+ x-mutually-exclusive-body-groups: &ref_25
22166
22508
  password:
22167
22509
  optional: true
22168
22510
  variants:
@@ -23841,7 +24183,7 @@ paths:
23841
24183
  content:
23842
24184
  application/json:
23843
24185
  schema:
23844
- $ref: '#/components/schemas/ConnectedAccountDto'
24186
+ $ref: '#/components/schemas/CreateConnectedAccountDto'
23845
24187
  responses:
23846
24188
  '201':
23847
24189
  description: The connected account was created successfully.
@@ -23946,8 +24288,9 @@ paths:
23946
24288
  - errors
23947
24289
  '503':
23948
24290
  description: >-
23949
- The WorkOS OAuth grant behind `refresh_token` is being changed by
23950
- another request. Retry the request.
24291
+ Another connection is being created for this owner and provider, or
24292
+ the WorkOS OAuth grant behind `refresh_token` is being changed.
24293
+ Retry the request.
23951
24294
  content:
23952
24295
  application/json:
23953
24296
  schema:
@@ -23968,7 +24311,6 @@ paths:
23968
24311
  summary: Import a connected account
23969
24312
  tags:
23970
24313
  - user-management.data-providers
23971
- x-feature-flag: pipes-management-api
23972
24314
  put:
23973
24315
  description: >-
23974
24316
  Updates a user's [connected account](/reference/pipes/connected-account)
@@ -24004,8 +24346,9 @@ paths:
24004
24346
  required: false
24005
24347
  in: query
24006
24348
  description: >-
24007
- Set to `true` to use the plural connection contract. When omitted or
24008
- `false`, only the compatibility connection is considered.
24349
+ Accepted for compatibility; does not change update targeting. Omit
24350
+ intent and selector to update the compatibility connection, or
24351
+ supply `connected_account_id` to update an exact connection.
24009
24352
  schema:
24010
24353
  example: true
24011
24354
  type: boolean
@@ -24019,6 +24362,17 @@ paths:
24019
24362
  minLength: 1
24020
24363
  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
24021
24364
  type: string
24365
+ - name: connection_intent
24366
+ required: false
24367
+ in: query
24368
+ description: >-
24369
+ Set to `reauthorize` with `connected_account_id` to update one exact
24370
+ connection. The intent may be omitted when supplying an ID. Omit
24371
+ both for permanent compatibility behavior.
24372
+ schema:
24373
+ type: string
24374
+ example: reauthorize
24375
+ const: reauthorize
24022
24376
  requestBody:
24023
24377
  required: true
24024
24378
  content:
@@ -24149,7 +24503,6 @@ paths:
24149
24503
  summary: Update a connected account
24150
24504
  tags:
24151
24505
  - user-management.data-providers
24152
- x-feature-flag: pipes-management-api
24153
24506
  /user_management/users/{user_id}/data_providers:
24154
24507
  get:
24155
24508
  description: >-
@@ -26104,7 +26457,7 @@ components:
26104
26457
  example: An application for managing user access
26105
26458
  scopes:
26106
26459
  description: The OAuth scopes granted to the application.
26107
- example: &ref_2
26460
+ example: &ref_3
26108
26461
  - openid
26109
26462
  - profile
26110
26463
  - email
@@ -26166,7 +26519,7 @@ components:
26166
26519
  example: An application for managing user access
26167
26520
  scopes:
26168
26521
  description: The OAuth scopes granted to the application.
26169
- example: *ref_2
26522
+ example: *ref_3
26170
26523
  type:
26171
26524
  - array
26172
26525
  - 'null'
@@ -26239,7 +26592,7 @@ components:
26239
26592
  owner: user_01GBTCQ2
26240
26593
  maxProperties: 50
26241
26594
  additionalProperties: false
26242
- patternProperties: &ref_3
26595
+ patternProperties: &ref_4
26243
26596
  ^[a-zA-Z0-9_-]{0,40}$:
26244
26597
  anyOf:
26245
26598
  - type: string
@@ -26271,7 +26624,7 @@ components:
26271
26624
  owner: user_01GBTCQ2
26272
26625
  maxProperties: 50
26273
26626
  additionalProperties: false
26274
- patternProperties: *ref_3
26627
+ patternProperties: *ref_4
26275
26628
  required:
26276
26629
  - id
26277
26630
  - type
@@ -26318,7 +26671,7 @@ components:
26318
26671
  owner: user_01GBTCQ2
26319
26672
  maxProperties: 50
26320
26673
  additionalProperties: false
26321
- patternProperties: *ref_3
26674
+ patternProperties: *ref_4
26322
26675
  version:
26323
26676
  type: integer
26324
26677
  description: What schema version the event is associated with.
@@ -26400,7 +26753,7 @@ components:
26400
26753
  - range_start
26401
26754
  - range_end
26402
26755
  UpdateAuditLogsRetentionDto:
26403
- x-mutually-exclusive-body-groups: *ref_4
26756
+ x-mutually-exclusive-body-groups: *ref_5
26404
26757
  oneOf:
26405
26758
  - type: object
26406
26759
  properties:
@@ -26585,7 +26938,7 @@ components:
26585
26938
  x-exclude-from-lint: true
26586
26939
  required:
26587
26940
  - resource_id
26588
- x-mutually-exclusive-body-groups: *ref_5
26941
+ x-mutually-exclusive-body-groups: *ref_6
26589
26942
  CreateGroupRoleAssignmentDto:
26590
26943
  type: object
26591
26944
  properties:
@@ -26726,7 +27079,7 @@ components:
26726
27079
  x-exclude-from-lint: true
26727
27080
  required:
26728
27081
  - resource_id
26729
- x-mutually-exclusive-body-groups: *ref_6
27082
+ x-mutually-exclusive-body-groups: *ref_7
26730
27083
  RemoveRoleDto:
26731
27084
  allOf:
26732
27085
  - type: object
@@ -26785,7 +27138,7 @@ components:
26785
27138
  x-exclude-from-lint: true
26786
27139
  required:
26787
27140
  - resource_id
26788
- x-mutually-exclusive-body-groups: *ref_7
27141
+ x-mutually-exclusive-body-groups: *ref_8
26789
27142
  SetRolePermissionsDto:
26790
27143
  type: object
26791
27144
  properties:
@@ -27135,7 +27488,7 @@ components:
27135
27488
  x-exclude-from-lint: true
27136
27489
  required:
27137
27490
  - parent_resource_id
27138
- x-mutually-exclusive-body-groups: *ref_8
27491
+ x-mutually-exclusive-body-groups: *ref_9
27139
27492
  CreateConnectionKeyPairDto:
27140
27493
  type: object
27141
27494
  properties:
@@ -27253,7 +27606,7 @@ components:
27253
27606
  default: true
27254
27607
  token_authentication_method:
27255
27608
  type: string
27256
- enum: &ref_10
27609
+ enum: &ref_11
27257
27610
  - client_secret_post
27258
27611
  - client_secret_basic
27259
27612
  - private_key_jwt
@@ -27269,7 +27622,7 @@ components:
27269
27622
  $ref: '#/components/schemas/CreateConnectionKeyPairDto'
27270
27623
  id_token_signature_algorithm:
27271
27624
  type: string
27272
- enum: &ref_11
27625
+ enum: &ref_12
27273
27626
  - ES256
27274
27627
  - ES384
27275
27628
  - ES512
@@ -27425,7 +27778,7 @@ components:
27425
27778
  x-exclude-from-lint: true
27426
27779
  required:
27427
27780
  - saml_options
27428
- x-mutually-exclusive-body-groups: *ref_9
27781
+ x-mutually-exclusive-body-groups: *ref_10
27429
27782
  PatchConnectionSamlOptionsDto:
27430
27783
  type: object
27431
27784
  properties:
@@ -27501,7 +27854,7 @@ components:
27501
27854
  example: true
27502
27855
  token_authentication_method:
27503
27856
  type: string
27504
- enum: *ref_10
27857
+ enum: *ref_11
27505
27858
  description: >-
27506
27859
  The token-endpoint client authentication method. Moving to
27507
27860
  `private_key_jwt` generates a signing key pair if the connection has
@@ -27511,7 +27864,7 @@ components:
27511
27864
  example: client_secret_basic
27512
27865
  id_token_signature_algorithm:
27513
27866
  type: string
27514
- enum: *ref_11
27867
+ enum: *ref_12
27515
27868
  description: The ID-token signing algorithm.
27516
27869
  example: RS256
27517
27870
  fetch_user_info:
@@ -27655,7 +28008,7 @@ components:
27655
28008
  x-exclude-from-lint: true
27656
28009
  required:
27657
28010
  - saml_options
27658
- x-mutually-exclusive-body-groups: *ref_12
28011
+ x-mutually-exclusive-body-groups: *ref_13
27659
28012
  CreateCorsOriginDto:
27660
28013
  type: object
27661
28014
  properties:
@@ -27837,11 +28190,11 @@ components:
27837
28190
  type:
27838
28191
  - object
27839
28192
  - 'null'
27840
- additionalProperties: &ref_13
28193
+ additionalProperties: &ref_14
27841
28194
  type: string
27842
28195
  maxLength: 600
27843
28196
  maxProperties: 50
27844
- example: &ref_14
28197
+ example: &ref_15
27845
28198
  tier: diamond
27846
28199
  description: >-
27847
28200
  Object containing [metadata](/authkit/metadata) key/value pairs
@@ -27896,9 +28249,9 @@ components:
27896
28249
  type:
27897
28250
  - object
27898
28251
  - 'null'
27899
- additionalProperties: *ref_13
28252
+ additionalProperties: *ref_14
27900
28253
  maxProperties: 50
27901
- example: *ref_14
28254
+ example: *ref_15
27902
28255
  description: >-
27903
28256
  Object containing [metadata](/authkit/metadata) key/value pairs
27904
28257
  associated with the Organization.
@@ -28032,7 +28385,7 @@ components:
28032
28385
  example: application/x-www-form-urlencoded
28033
28386
  authenticate_via:
28034
28387
  type: string
28035
- enum: &ref_15
28388
+ enum: &ref_16
28036
28389
  - request_body
28037
28390
  - basic_auth_header
28038
28391
  description: >-
@@ -28200,7 +28553,7 @@ components:
28200
28553
  example: application/x-www-form-urlencoded
28201
28554
  authenticate_via:
28202
28555
  type: string
28203
- enum: *ref_15
28556
+ enum: *ref_16
28204
28557
  description: >-
28205
28558
  How client credentials are sent when exchanging authorization codes
28206
28559
  and refreshing tokens.
@@ -28246,7 +28599,7 @@ components:
28246
28599
  Updates to a custom provider's OAuth definition. Only valid for
28247
28600
  custom-provider integrations.
28248
28601
  $ref: '#/components/schemas/UpdateCustomProviderDefinitionDto'
28249
- OrganizationConnectedAccountDto:
28602
+ CreateOrganizationConnectedAccountDto:
28250
28603
  type: object
28251
28604
  properties:
28252
28605
  access_token:
@@ -28266,7 +28619,7 @@ components:
28266
28619
  format: date-time
28267
28620
  scopes:
28268
28621
  description: The OAuth scopes granted for this connection.
28269
- example: &ref_16
28622
+ example: &ref_17
28270
28623
  - repo
28271
28624
  - user:email
28272
28625
  type: array
@@ -28274,7 +28627,7 @@ components:
28274
28627
  type: string
28275
28628
  state:
28276
28629
  type: string
28277
- enum: &ref_17
28630
+ enum: &ref_18
28278
28631
  - connected
28279
28632
  - needs_reauthorization
28280
28633
  description: >-
@@ -28288,8 +28641,93 @@ components:
28288
28641
  member on whose behalf the connected account is being imported or
28289
28642
  updated. The user must be an active member of the organization.
28290
28643
  example: user_01EHZNVPK3SFK441A1RGBFSHRT
28644
+ connection_intent:
28645
+ type: string
28646
+ description: >-
28647
+ Set to `add` to create another connected account. Omit this field
28648
+ for permanent compatibility behavior.
28649
+ example: add
28650
+ const: add
28651
+ required:
28652
+ - user_id
28653
+ OrganizationConnectedAccountDto:
28654
+ type: object
28655
+ properties:
28656
+ access_token:
28657
+ type: string
28658
+ description: The OAuth access token for the connected account.
28659
+ example: gho_16C7e42F292c6912E7710c838347Ae178B4a
28660
+ refresh_token:
28661
+ type: string
28662
+ description: The OAuth refresh token for the connected account.
28663
+ example: ghr_xxxxxxxxxxxxxxxxxxxx
28664
+ expires_at:
28665
+ type: string
28666
+ description: >-
28667
+ The ISO-8601 timestamp when the access token expires. Required when
28668
+ `access_token` is provided for tokens that expire.
28669
+ example: '2025-12-31T23:59:59.000Z'
28670
+ format: date-time
28671
+ scopes:
28672
+ description: The OAuth scopes granted for this connection.
28673
+ example: *ref_17
28674
+ type: array
28675
+ items:
28676
+ type: string
28677
+ state:
28678
+ type: string
28679
+ enum: *ref_18
28680
+ description: >-
28681
+ Explicitly set the state of the connected account. When omitted, the
28682
+ state is derived from the token combination provided.
28683
+ example: connected
28684
+ user_id:
28685
+ type: string
28686
+ description: >-
28687
+ The [User](/reference/authkit/user) identifier of the organization
28688
+ member on whose behalf the connected account is being imported or
28689
+ updated. The user must be an active member of the organization.
28690
+ example: user_01EHZNVPK3SFK441A1RGBFSHRT
28291
28691
  required:
28292
28692
  - user_id
28693
+ CreateConnectedAccountDto:
28694
+ type: object
28695
+ properties:
28696
+ access_token:
28697
+ type: string
28698
+ description: The OAuth access token for the connected account.
28699
+ example: gho_16C7e42F292c6912E7710c838347Ae178B4a
28700
+ refresh_token:
28701
+ type: string
28702
+ description: The OAuth refresh token for the connected account.
28703
+ example: ghr_xxxxxxxxxxxxxxxxxxxx
28704
+ expires_at:
28705
+ type: string
28706
+ description: >-
28707
+ The ISO-8601 timestamp when the access token expires. Required when
28708
+ `access_token` is provided for tokens that expire.
28709
+ example: '2025-12-31T23:59:59.000Z'
28710
+ format: date-time
28711
+ scopes:
28712
+ description: The OAuth scopes granted for this connection.
28713
+ example: *ref_17
28714
+ type: array
28715
+ items:
28716
+ type: string
28717
+ state:
28718
+ type: string
28719
+ enum: *ref_18
28720
+ description: >-
28721
+ Explicitly set the state of the connected account. When omitted, the
28722
+ state is derived from the token combination provided.
28723
+ example: connected
28724
+ connection_intent:
28725
+ type: string
28726
+ description: >-
28727
+ Set to `add` to create another connected account. Omit this field
28728
+ for permanent compatibility behavior.
28729
+ example: add
28730
+ const: add
28293
28731
  ConnectedAccountDto:
28294
28732
  type: object
28295
28733
  properties:
@@ -28310,13 +28748,13 @@ components:
28310
28748
  format: date-time
28311
28749
  scopes:
28312
28750
  description: The OAuth scopes granted for this connection.
28313
- example: *ref_16
28751
+ example: *ref_17
28314
28752
  type: array
28315
28753
  items:
28316
28754
  type: string
28317
28755
  state:
28318
28756
  type: string
28319
- enum: *ref_17
28757
+ enum: *ref_18
28320
28758
  description: >-
28321
28759
  Explicitly set the state of the connected account. When omitted, the
28322
28760
  state is derived from the token combination provided.
@@ -28826,9 +29264,9 @@ components:
28826
29264
  x-exclude-from-lint: true
28827
29265
  required:
28828
29266
  - role_slug
28829
- x-mutually-exclusive-body-groups: *ref_18
28830
- UpdateUserlandUserOrganizationMembershipDto:
28831
29267
  x-mutually-exclusive-body-groups: *ref_19
29268
+ UpdateUserlandUserOrganizationMembershipDto:
29269
+ x-mutually-exclusive-body-groups: *ref_20
28832
29270
  oneOf:
28833
29271
  - type: object
28834
29272
  not:
@@ -28952,9 +29390,9 @@ components:
28952
29390
  type:
28953
29391
  - object
28954
29392
  - 'null'
28955
- additionalProperties: *ref_13
29393
+ additionalProperties: *ref_14
28956
29394
  maxProperties: 50
28957
- example: &ref_21
29395
+ example: &ref_22
28958
29396
  timezone: America/New_York
28959
29397
  description: >-
28960
29398
  Object containing metadata key/value pairs associated with the
@@ -29053,7 +29491,7 @@ components:
29053
29491
  example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
29054
29492
  password_hash_type:
29055
29493
  type: string
29056
- enum: &ref_22
29494
+ enum: &ref_23
29057
29495
  - bcrypt
29058
29496
  - firebase-scrypt
29059
29497
  - ssha
@@ -29068,7 +29506,7 @@ components:
29068
29506
  example: bcrypt
29069
29507
  password_salt_position:
29070
29508
  type: string
29071
- enum: &ref_23
29509
+ enum: &ref_24
29072
29510
  - prefix
29073
29511
  - suffix
29074
29512
  description: >-
@@ -29089,7 +29527,7 @@ components:
29089
29527
  x-exclude-from-lint: true
29090
29528
  required:
29091
29529
  - password
29092
- x-mutually-exclusive-body-groups: *ref_20
29530
+ x-mutually-exclusive-body-groups: *ref_21
29093
29531
  UpdateUserlandUserDto:
29094
29532
  allOf:
29095
29533
  - type: object
@@ -29119,9 +29557,9 @@ components:
29119
29557
  type:
29120
29558
  - object
29121
29559
  - 'null'
29122
- additionalProperties: *ref_13
29560
+ additionalProperties: *ref_14
29123
29561
  maxProperties: 50
29124
- example: *ref_21
29562
+ example: *ref_22
29125
29563
  description: >-
29126
29564
  Object containing metadata key/value pairs associated with the
29127
29565
  user.
@@ -29203,7 +29641,7 @@ components:
29203
29641
  example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
29204
29642
  password_hash_type:
29205
29643
  type: string
29206
- enum: *ref_22
29644
+ enum: *ref_23
29207
29645
  description: >-
29208
29646
  The algorithm originally used to hash the password, used
29209
29647
  when providing a `password_hash`. Required with
@@ -29211,7 +29649,7 @@ components:
29211
29649
  example: bcrypt
29212
29650
  password_salt_position:
29213
29651
  type: string
29214
- enum: *ref_23
29652
+ enum: *ref_24
29215
29653
  description: >-
29216
29654
  The position of the salt relative to the password when the
29217
29655
  `password_hash` digest was computed: `prefix` for `hash(salt
@@ -29230,7 +29668,7 @@ components:
29230
29668
  x-exclude-from-lint: true
29231
29669
  required:
29232
29670
  - password
29233
- x-mutually-exclusive-body-groups: *ref_24
29671
+ x-mutually-exclusive-body-groups: *ref_25
29234
29672
  VerifyEmailAddressDto:
29235
29673
  type: object
29236
29674
  properties:
@@ -29339,7 +29777,7 @@ components:
29339
29777
  description: The events that the Webhook Endpoint is subscribed to.
29340
29778
  items:
29341
29779
  type: string
29342
- enum: &ref_25
29780
+ enum: &ref_26
29343
29781
  - agent.blueprint.created
29344
29782
  - agent.blueprint.deleted
29345
29783
  - agent.blueprint.updated
@@ -29470,7 +29908,7 @@ components:
29470
29908
  description: The events that the Webhook Endpoint is subscribed to.
29471
29909
  items:
29472
29910
  type: string
29473
- enum: *ref_25
29911
+ enum: *ref_26
29474
29912
  example:
29475
29913
  - user.created
29476
29914
  - dsync.user.created
@@ -33145,7 +33583,7 @@ components:
33145
33583
  description: >-
33146
33584
  An object containing the custom attribute mapping for the Directory
33147
33585
  Provider.
33148
- example: &ref_32
33586
+ example: &ref_33
33149
33587
  department: Engineering
33150
33588
  job_title: Software Engineer
33151
33589
  role:
@@ -33384,7 +33822,7 @@ components:
33384
33822
  type: object
33385
33823
  additionalProperties: {}
33386
33824
  description: The event payload.
33387
- example: &ref_26
33825
+ example: &ref_27
33388
33826
  id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
33389
33827
  directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
33390
33828
  organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
@@ -33419,11 +33857,11 @@ components:
33419
33857
  - data
33420
33858
  - created_at
33421
33859
  description: An event emitted by WorkOS.
33422
- example: &ref_37
33860
+ example: &ref_38
33423
33861
  object: event
33424
33862
  id: event_01EHZNVPK3SFK441A1RGBFSHRT
33425
33863
  event: dsync.user.created
33426
- data: *ref_26
33864
+ data: *ref_27
33427
33865
  created_at: '2021-06-25T19:07:33.155Z'
33428
33866
  context: {}
33429
33867
  - oneOf:
@@ -33623,7 +34061,7 @@ components:
33623
34061
  description: >-
33624
34062
  Permission slugs forming the ceiling on what sessions
33625
34063
  minted from this blueprint may do.
33626
- example: &ref_27
34064
+ example: &ref_28
33627
34065
  - crm:read
33628
34066
  - email:send
33629
34067
  invocable_by:
@@ -33636,7 +34074,7 @@ components:
33636
34074
  description: >-
33637
34075
  Role slugs whose members may mint user-delegated
33638
34076
  sessions from this blueprint.
33639
- example: &ref_28
34077
+ example: &ref_29
33640
34078
  - manager
33641
34079
  organization_ids:
33642
34080
  type: array
@@ -33645,7 +34083,7 @@ components:
33645
34083
  description: >-
33646
34084
  Organizations in which autonomous sessions may be
33647
34085
  minted from this blueprint.
33648
- example: &ref_29
34086
+ example: &ref_30
33649
34087
  - org_01EHWNCE74X7JSDV0X3SZ3KJNY
33650
34088
  required:
33651
34089
  - role_slugs
@@ -33665,7 +34103,7 @@ components:
33665
34103
  Instance types that may be minted from this
33666
34104
  blueprint: `delegated` (acting for a user) and/or
33667
34105
  `autonomous` (acting as the agent itself).
33668
- example: &ref_30
34106
+ example: &ref_31
33669
34107
  - delegated
33670
34108
  - autonomous
33671
34109
  required:
@@ -33825,7 +34263,7 @@ components:
33825
34263
  description: >-
33826
34264
  Permission slugs forming the ceiling on what sessions
33827
34265
  minted from this blueprint may do.
33828
- example: *ref_27
34266
+ example: *ref_28
33829
34267
  invocable_by:
33830
34268
  type: object
33831
34269
  properties:
@@ -33836,7 +34274,7 @@ components:
33836
34274
  description: >-
33837
34275
  Role slugs whose members may mint user-delegated
33838
34276
  sessions from this blueprint.
33839
- example: *ref_28
34277
+ example: *ref_29
33840
34278
  organization_ids:
33841
34279
  type: array
33842
34280
  items:
@@ -33844,7 +34282,7 @@ components:
33844
34282
  description: >-
33845
34283
  Organizations in which autonomous sessions may be
33846
34284
  minted from this blueprint.
33847
- example: *ref_29
34285
+ example: *ref_30
33848
34286
  required:
33849
34287
  - role_slugs
33850
34288
  - organization_ids
@@ -33863,7 +34301,7 @@ components:
33863
34301
  Instance types that may be minted from this
33864
34302
  blueprint: `delegated` (acting for a user) and/or
33865
34303
  `autonomous` (acting as the agent itself).
33866
- example: *ref_30
34304
+ example: *ref_31
33867
34305
  required:
33868
34306
  - instance_types
33869
34307
  description: How sessions may be minted from this blueprint.
@@ -34899,7 +35337,7 @@ components:
34899
35337
  items:
34900
35338
  type: string
34901
35339
  description: The permissions granted to the API key.
34902
- example: &ref_31
35340
+ example: &ref_32
34903
35341
  - users:read
34904
35342
  - users:write
34905
35343
  created_at:
@@ -35025,7 +35463,7 @@ components:
35025
35463
  items:
35026
35464
  type: string
35027
35465
  description: The permissions granted to the API key.
35028
- example: *ref_31
35466
+ example: *ref_32
35029
35467
  created_at:
35030
35468
  type: string
35031
35469
  description: The timestamp when the API key was created.
@@ -35149,7 +35587,7 @@ components:
35149
35587
  items:
35150
35588
  type: string
35151
35589
  description: The permissions granted to the API key.
35152
- example: *ref_31
35590
+ example: *ref_32
35153
35591
  created_at:
35154
35592
  type: string
35155
35593
  description: The timestamp when the API key was created.
@@ -38016,7 +38454,7 @@ components:
38016
38454
  description: >-
38017
38455
  An object containing the custom attribute mapping for
38018
38456
  the Directory Provider.
38019
- example: *ref_32
38457
+ example: *ref_33
38020
38458
  role:
38021
38459
  $ref: '#/components/schemas/SlimRole'
38022
38460
  roles:
@@ -38206,7 +38644,7 @@ components:
38206
38644
  description: >-
38207
38645
  Labels assigned to the Feature Flag for categorizing and
38208
38646
  filtering.
38209
- example: &ref_33
38647
+ example: &ref_34
38210
38648
  - reports
38211
38649
  enabled:
38212
38650
  type: boolean
@@ -38367,7 +38805,7 @@ components:
38367
38805
  description: >-
38368
38806
  Labels assigned to the Feature Flag for categorizing and
38369
38807
  filtering.
38370
- example: *ref_33
38808
+ example: *ref_34
38371
38809
  enabled:
38372
38810
  type: boolean
38373
38811
  description: >-
@@ -38527,7 +38965,7 @@ components:
38527
38965
  description: >-
38528
38966
  Labels assigned to the Feature Flag for categorizing and
38529
38967
  filtering.
38530
- example: *ref_33
38968
+ example: *ref_34
38531
38969
  enabled:
38532
38970
  type: boolean
38533
38971
  description: >-
@@ -38807,7 +39245,7 @@ components:
38807
39245
  description: >-
38808
39246
  Labels assigned to the Feature Flag for categorizing and
38809
39247
  filtering.
38810
- example: *ref_33
39248
+ example: *ref_34
38811
39249
  enabled:
38812
39250
  type: boolean
38813
39251
  description: >-
@@ -39795,7 +40233,7 @@ components:
39795
40233
  description: >-
39796
40234
  Object containing [metadata](/authkit/metadata)
39797
40235
  key/value pairs associated with the Organization.
39798
- example: &ref_34
40236
+ example: &ref_35
39799
40237
  tier: diamond
39800
40238
  propertyNames:
39801
40239
  maxLength: 40
@@ -39945,7 +40383,7 @@ components:
39945
40383
  description: >-
39946
40384
  Object containing [metadata](/authkit/metadata)
39947
40385
  key/value pairs associated with the Organization.
39948
- example: *ref_34
40386
+ example: *ref_35
39949
40387
  propertyNames:
39950
40388
  maxLength: 40
39951
40389
  maxProperties: 50
@@ -40772,7 +41210,7 @@ components:
40772
41210
  items:
40773
41211
  type: string
40774
41212
  description: The permissions granted by the role.
40775
- example: &ref_35
41213
+ example: &ref_36
40776
41214
  - users:read
40777
41215
  - users:write
40778
41216
  created_at:
@@ -40856,7 +41294,7 @@ components:
40856
41294
  items:
40857
41295
  type: string
40858
41296
  description: The permissions granted by the role.
40859
- example: *ref_35
41297
+ example: *ref_36
40860
41298
  created_at:
40861
41299
  format: date-time
40862
41300
  type: string
@@ -40938,7 +41376,7 @@ components:
40938
41376
  items:
40939
41377
  type: string
40940
41378
  description: The permissions granted by the role.
40941
- example: *ref_35
41379
+ example: *ref_36
40942
41380
  created_at:
40943
41381
  format: date-time
40944
41382
  type: string
@@ -41075,7 +41513,7 @@ components:
41075
41513
  description: >-
41076
41514
  Object containing [metadata](/authkit/metadata)
41077
41515
  key/value pairs associated with the Organization.
41078
- example: *ref_34
41516
+ example: *ref_35
41079
41517
  propertyNames:
41080
41518
  maxLength: 40
41081
41519
  maxProperties: 50
@@ -42271,7 +42709,7 @@ components:
42271
42709
  items:
42272
42710
  type: string
42273
42711
  description: The permissions granted by the role.
42274
- example: &ref_36
42712
+ example: &ref_37
42275
42713
  - users:read
42276
42714
  - users:write
42277
42715
  created_at:
@@ -42337,7 +42775,7 @@ components:
42337
42775
  items:
42338
42776
  type: string
42339
42777
  description: The permissions granted by the role.
42340
- example: *ref_36
42778
+ example: *ref_37
42341
42779
  created_at:
42342
42780
  format: date-time
42343
42781
  type: string
@@ -42401,7 +42839,7 @@ components:
42401
42839
  items:
42402
42840
  type: string
42403
42841
  description: The permissions granted by the role.
42404
- example: *ref_36
42842
+ example: *ref_37
42405
42843
  created_at:
42406
42844
  format: date-time
42407
42845
  type: string
@@ -43541,7 +43979,7 @@ components:
43541
43979
  - data
43542
43980
  - created_at
43543
43981
  - object
43544
- example: *ref_37
43982
+ example: *ref_38
43545
43983
  description: An event emitted by WorkOS.
43546
43984
  EventList:
43547
43985
  type: object
@@ -43576,7 +44014,7 @@ components:
43576
44014
  example:
43577
44015
  object: list
43578
44016
  data:
43579
- - *ref_37
44017
+ - *ref_38
43580
44018
  list_metadata:
43581
44019
  after: event_01EHZNVPK3SFK441A1RGBFSHRT
43582
44020
  JwtTemplate:
@@ -45537,7 +45975,7 @@ components:
45537
45975
  items:
45538
45976
  type: string
45539
45977
  description: The OAuth scopes granted for this connection.
45540
- example: &ref_38
45978
+ example: &ref_39
45541
45979
  - repo
45542
45980
  - user:email
45543
45981
  auth_method:
@@ -45587,7 +46025,7 @@ components:
45587
46025
  `installation` scope, excluding any it declares as
45588
46026
  secret. Only present when `auth_method` is
45589
46027
  `client_credentials`.
45590
- example: &ref_39
46028
+ example: &ref_40
45591
46029
  instance_url: https://example.my.salesforce.com
45592
46030
  state:
45593
46031
  type: string
@@ -45716,7 +46154,7 @@ components:
45716
46154
  items:
45717
46155
  type: string
45718
46156
  description: The OAuth scopes granted for this connection.
45719
- example: *ref_38
46157
+ example: *ref_39
45720
46158
  auth_method:
45721
46159
  type: string
45722
46160
  enum:
@@ -45763,7 +46201,7 @@ components:
45763
46201
  `installation` scope, excluding any it declares as
45764
46202
  secret. Only present when `auth_method` is
45765
46203
  `client_credentials`.
45766
- example: *ref_39
46204
+ example: *ref_40
45767
46205
  state:
45768
46206
  type: string
45769
46207
  enum: