@workos/openapi-spec 0.106.0 → 0.108.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:
@@ -10772,49 +10772,184 @@ paths:
10772
10772
  content:
10773
10773
  application/json:
10774
10774
  schema:
10775
- type: object
10776
- properties:
10777
- user_id:
10778
- type: string
10779
- description: A [User](/reference/authkit/user) identifier.
10780
- example: user_01EHZNVPK3SFK441A1RGBFSHRT
10781
- organization_id:
10782
- type: string
10783
- description: >-
10784
- An [Organization](/reference/organization) identifier.
10785
- Optional parameter to scope the connection to a specific
10786
- organization. Required when `connection_owner` is
10787
- `organization`.
10788
- example: org_01EHZNVPK3SFK441A1RGBFSHRT
10789
- connected_account_id:
10790
- type: string
10791
- pattern: ^data_installation_.+$
10792
- description: >-
10793
- A [connected account](/reference/pipes/connected-account)
10794
- identifier. Use this to rotate a specific existing
10795
- connection.
10796
- example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
10797
- connection_owner:
10798
- type: string
10799
- enum:
10800
- - user
10801
- - organization
10802
- description: >-
10803
- Whose connection to create or rotate. `user` (the default)
10804
- addresses the connection owned by `user_id`. `organization`
10805
- addresses the connection shared by every member of
10806
- `organization_id`; `user_id` then identifies the member
10807
- performing the request and must be an active member of the
10808
- organization.
10809
- example: user
10810
- secret:
10811
- type: string
10812
- minLength: 1
10813
- description: The API key secret to store for this integration.
10814
- example: sk-1234567890abcdef
10815
- required:
10816
- - user_id
10817
- - 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
10818
10953
  responses:
10819
10954
  '200':
10820
10955
  description: The resulting connected account after the upsert.
@@ -11038,65 +11173,245 @@ paths:
11038
11173
  content:
11039
11174
  application/json:
11040
11175
  schema:
11041
- type: object
11042
- properties:
11043
- user_id:
11044
- type: string
11045
- description: A [User](/reference/authkit/user) identifier.
11046
- example: user_01EHZNVPK3SFK441A1RGBFSHRT
11047
- organization_id:
11048
- type: string
11049
- description: >-
11050
- An [Organization](/reference/organization) identifier.
11051
- Optional parameter to scope the connection to a specific
11052
- organization. Required when `connection_owner` is
11053
- `organization`.
11054
- example: org_01EHZNVPK3SFK441A1RGBFSHRT
11055
- connected_account_id:
11056
- type: string
11057
- pattern: ^data_installation_.+$
11058
- description: >-
11059
- A [connected account](/reference/pipes/connected-account)
11060
- identifier. Use this to rotate a specific existing
11061
- connection.
11062
- example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
11063
- connection_owner:
11064
- type: string
11065
- enum:
11066
- - user
11067
- - organization
11068
- description: >-
11069
- Whose connection to create or rotate. `user` (the default)
11070
- addresses the connection owned by `user_id`. `organization`
11071
- addresses the connection shared by every member of
11072
- `organization_id`; `user_id` then identifies the member
11073
- performing the request and must be an active member of the
11074
- organization.
11075
- example: user
11076
- client_id:
11077
- type: string
11078
- minLength: 1
11079
- description: The OAuth client ID to store for this integration.
11080
- example: 3MVG9...
11081
- client_secret:
11082
- type: string
11083
- minLength: 1
11084
- description: The OAuth client secret to store for this integration.
11085
- example: shhh-secret
11086
- config:
11087
- type: object
11088
- additionalProperties:
11089
- type: string
11090
- description: >-
11091
- Provider-specific configuration values collected for this
11092
- installation, keyed by the provider's config field
11093
- descriptors.
11094
- example:
11095
- salesforce_host: acme.my.salesforce.com
11096
- required:
11097
- - user_id
11098
- - client_id
11099
- - 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
11100
11415
  responses:
11101
11416
  '200':
11102
11417
  description: The resulting connected account after the upsert.
@@ -13733,7 +14048,7 @@ paths:
13733
14048
  summary: Set Retention
13734
14049
  tags:
13735
14050
  - audit-logs
13736
- x-mutually-exclusive-body-groups: &ref_4
14051
+ x-mutually-exclusive-body-groups: &ref_5
13737
14052
  retention:
13738
14053
  optional: false
13739
14054
  variants:
@@ -15045,8 +15360,10 @@ paths:
15045
15360
  description: >-
15046
15361
  Imports an organization-owned [connected
15047
15362
  account](/reference/pipes/connected-account) by providing OAuth tokens
15048
- directly. Use this to migrate existing connections or set up connections
15049
- 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.
15050
15367
  operationId: >-
15051
15368
  DataIntegrationsOrganizationController_createOrganizationDataInstallation
15052
15369
  parameters:
@@ -15071,7 +15388,7 @@ paths:
15071
15388
  content:
15072
15389
  application/json:
15073
15390
  schema:
15074
- $ref: '#/components/schemas/OrganizationConnectedAccountDto'
15391
+ $ref: '#/components/schemas/CreateOrganizationConnectedAccountDto'
15075
15392
  responses:
15076
15393
  '201':
15077
15394
  description: The connected account was created successfully.
@@ -15129,8 +15446,8 @@ paths:
15129
15446
  - message
15130
15447
  '409':
15131
15448
  description: >-
15132
- A connected account already exists for this organization and
15133
- integration.
15449
+ The compatibility connection already exists for this organization
15450
+ and integration.
15134
15451
  content:
15135
15452
  application/json:
15136
15453
  schema:
@@ -15205,6 +15522,27 @@ paths:
15205
15522
  - code
15206
15523
  - message
15207
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
15208
15546
  summary: Import an organization connected account
15209
15547
  tags:
15210
15548
  - organizations.data-providers
@@ -15237,8 +15575,9 @@ paths:
15237
15575
  required: false
15238
15576
  in: query
15239
15577
  description: >-
15240
- Set to `true` to use the plural connection contract. When omitted or
15241
- `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.
15242
15581
  schema:
15243
15582
  example: true
15244
15583
  type: boolean
@@ -15252,6 +15591,17 @@ paths:
15252
15591
  minLength: 1
15253
15592
  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
15254
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
15255
15605
  requestBody:
15256
15606
  required: true
15257
15607
  content:
@@ -15434,7 +15784,7 @@ paths:
15434
15784
  credentialsType: oauth2
15435
15785
  createdAt: '2024-01-15T10:30:00.000Z'
15436
15786
  updatedAt: '2024-01-15T10:30:00.000Z'
15437
- connected_account: &ref_1
15787
+ connected_account: &ref_2
15438
15788
  object: connected_account
15439
15789
  id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
15440
15790
  user_id: null
@@ -15459,7 +15809,7 @@ paths:
15459
15809
  createdAt: '2024-01-16T14:20:00.000Z'
15460
15810
  updatedAt: '2024-01-16T14:20:00.000Z'
15461
15811
  connected_accounts:
15462
- - *ref_1
15812
+ - *ref_2
15463
15813
  '401':
15464
15814
  description: The request is missing a valid API key.
15465
15815
  '404':
@@ -20357,7 +20707,7 @@ paths:
20357
20707
  summary: Create an organization membership
20358
20708
  tags:
20359
20709
  - user-management.organization-membership
20360
- x-mutually-exclusive-body-groups: &ref_18
20710
+ x-mutually-exclusive-body-groups: &ref_19
20361
20711
  role:
20362
20712
  optional: true
20363
20713
  variants:
@@ -20541,7 +20891,7 @@ paths:
20541
20891
  summary: Update an organization membership
20542
20892
  tags:
20543
20893
  - user-management.organization-membership
20544
- x-mutually-exclusive-body-groups: &ref_19
20894
+ x-mutually-exclusive-body-groups: &ref_20
20545
20895
  role:
20546
20896
  optional: true
20547
20897
  variants:
@@ -21861,7 +22211,7 @@ paths:
21861
22211
  summary: Create a user
21862
22212
  tags:
21863
22213
  - user-management.users
21864
- x-mutually-exclusive-body-groups: &ref_20
22214
+ x-mutually-exclusive-body-groups: &ref_21
21865
22215
  password:
21866
22216
  optional: true
21867
22217
  variants:
@@ -22154,7 +22504,7 @@ paths:
22154
22504
  summary: Update a user
22155
22505
  tags:
22156
22506
  - user-management.users
22157
- x-mutually-exclusive-body-groups: &ref_24
22507
+ x-mutually-exclusive-body-groups: &ref_25
22158
22508
  password:
22159
22509
  optional: true
22160
22510
  variants:
@@ -23833,7 +24183,7 @@ paths:
23833
24183
  content:
23834
24184
  application/json:
23835
24185
  schema:
23836
- $ref: '#/components/schemas/ConnectedAccountDto'
24186
+ $ref: '#/components/schemas/CreateConnectedAccountDto'
23837
24187
  responses:
23838
24188
  '201':
23839
24189
  description: The connected account was created successfully.
@@ -23938,8 +24288,9 @@ paths:
23938
24288
  - errors
23939
24289
  '503':
23940
24290
  description: >-
23941
- The WorkOS OAuth grant behind `refresh_token` is being changed by
23942
- 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.
23943
24294
  content:
23944
24295
  application/json:
23945
24296
  schema:
@@ -23995,8 +24346,9 @@ paths:
23995
24346
  required: false
23996
24347
  in: query
23997
24348
  description: >-
23998
- Set to `true` to use the plural connection contract. When omitted or
23999
- `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.
24000
24352
  schema:
24001
24353
  example: true
24002
24354
  type: boolean
@@ -24010,6 +24362,17 @@ paths:
24010
24362
  minLength: 1
24011
24363
  example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
24012
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
24013
24376
  requestBody:
24014
24377
  required: true
24015
24378
  content:
@@ -26094,7 +26457,7 @@ components:
26094
26457
  example: An application for managing user access
26095
26458
  scopes:
26096
26459
  description: The OAuth scopes granted to the application.
26097
- example: &ref_2
26460
+ example: &ref_3
26098
26461
  - openid
26099
26462
  - profile
26100
26463
  - email
@@ -26156,7 +26519,7 @@ components:
26156
26519
  example: An application for managing user access
26157
26520
  scopes:
26158
26521
  description: The OAuth scopes granted to the application.
26159
- example: *ref_2
26522
+ example: *ref_3
26160
26523
  type:
26161
26524
  - array
26162
26525
  - 'null'
@@ -26229,7 +26592,7 @@ components:
26229
26592
  owner: user_01GBTCQ2
26230
26593
  maxProperties: 50
26231
26594
  additionalProperties: false
26232
- patternProperties: &ref_3
26595
+ patternProperties: &ref_4
26233
26596
  ^[a-zA-Z0-9_-]{0,40}$:
26234
26597
  anyOf:
26235
26598
  - type: string
@@ -26261,7 +26624,7 @@ components:
26261
26624
  owner: user_01GBTCQ2
26262
26625
  maxProperties: 50
26263
26626
  additionalProperties: false
26264
- patternProperties: *ref_3
26627
+ patternProperties: *ref_4
26265
26628
  required:
26266
26629
  - id
26267
26630
  - type
@@ -26308,7 +26671,7 @@ components:
26308
26671
  owner: user_01GBTCQ2
26309
26672
  maxProperties: 50
26310
26673
  additionalProperties: false
26311
- patternProperties: *ref_3
26674
+ patternProperties: *ref_4
26312
26675
  version:
26313
26676
  type: integer
26314
26677
  description: What schema version the event is associated with.
@@ -26390,7 +26753,7 @@ components:
26390
26753
  - range_start
26391
26754
  - range_end
26392
26755
  UpdateAuditLogsRetentionDto:
26393
- x-mutually-exclusive-body-groups: *ref_4
26756
+ x-mutually-exclusive-body-groups: *ref_5
26394
26757
  oneOf:
26395
26758
  - type: object
26396
26759
  properties:
@@ -26575,7 +26938,7 @@ components:
26575
26938
  x-exclude-from-lint: true
26576
26939
  required:
26577
26940
  - resource_id
26578
- x-mutually-exclusive-body-groups: *ref_5
26941
+ x-mutually-exclusive-body-groups: *ref_6
26579
26942
  CreateGroupRoleAssignmentDto:
26580
26943
  type: object
26581
26944
  properties:
@@ -26716,7 +27079,7 @@ components:
26716
27079
  x-exclude-from-lint: true
26717
27080
  required:
26718
27081
  - resource_id
26719
- x-mutually-exclusive-body-groups: *ref_6
27082
+ x-mutually-exclusive-body-groups: *ref_7
26720
27083
  RemoveRoleDto:
26721
27084
  allOf:
26722
27085
  - type: object
@@ -26775,7 +27138,7 @@ components:
26775
27138
  x-exclude-from-lint: true
26776
27139
  required:
26777
27140
  - resource_id
26778
- x-mutually-exclusive-body-groups: *ref_7
27141
+ x-mutually-exclusive-body-groups: *ref_8
26779
27142
  SetRolePermissionsDto:
26780
27143
  type: object
26781
27144
  properties:
@@ -27125,7 +27488,7 @@ components:
27125
27488
  x-exclude-from-lint: true
27126
27489
  required:
27127
27490
  - parent_resource_id
27128
- x-mutually-exclusive-body-groups: *ref_8
27491
+ x-mutually-exclusive-body-groups: *ref_9
27129
27492
  CreateConnectionKeyPairDto:
27130
27493
  type: object
27131
27494
  properties:
@@ -27243,7 +27606,7 @@ components:
27243
27606
  default: true
27244
27607
  token_authentication_method:
27245
27608
  type: string
27246
- enum: &ref_10
27609
+ enum: &ref_11
27247
27610
  - client_secret_post
27248
27611
  - client_secret_basic
27249
27612
  - private_key_jwt
@@ -27259,7 +27622,7 @@ components:
27259
27622
  $ref: '#/components/schemas/CreateConnectionKeyPairDto'
27260
27623
  id_token_signature_algorithm:
27261
27624
  type: string
27262
- enum: &ref_11
27625
+ enum: &ref_12
27263
27626
  - ES256
27264
27627
  - ES384
27265
27628
  - ES512
@@ -27415,7 +27778,7 @@ components:
27415
27778
  x-exclude-from-lint: true
27416
27779
  required:
27417
27780
  - saml_options
27418
- x-mutually-exclusive-body-groups: *ref_9
27781
+ x-mutually-exclusive-body-groups: *ref_10
27419
27782
  PatchConnectionSamlOptionsDto:
27420
27783
  type: object
27421
27784
  properties:
@@ -27491,7 +27854,7 @@ components:
27491
27854
  example: true
27492
27855
  token_authentication_method:
27493
27856
  type: string
27494
- enum: *ref_10
27857
+ enum: *ref_11
27495
27858
  description: >-
27496
27859
  The token-endpoint client authentication method. Moving to
27497
27860
  `private_key_jwt` generates a signing key pair if the connection has
@@ -27501,7 +27864,7 @@ components:
27501
27864
  example: client_secret_basic
27502
27865
  id_token_signature_algorithm:
27503
27866
  type: string
27504
- enum: *ref_11
27867
+ enum: *ref_12
27505
27868
  description: The ID-token signing algorithm.
27506
27869
  example: RS256
27507
27870
  fetch_user_info:
@@ -27645,7 +28008,7 @@ components:
27645
28008
  x-exclude-from-lint: true
27646
28009
  required:
27647
28010
  - saml_options
27648
- x-mutually-exclusive-body-groups: *ref_12
28011
+ x-mutually-exclusive-body-groups: *ref_13
27649
28012
  CreateCorsOriginDto:
27650
28013
  type: object
27651
28014
  properties:
@@ -27827,11 +28190,11 @@ components:
27827
28190
  type:
27828
28191
  - object
27829
28192
  - 'null'
27830
- additionalProperties: &ref_13
28193
+ additionalProperties: &ref_14
27831
28194
  type: string
27832
28195
  maxLength: 600
27833
28196
  maxProperties: 50
27834
- example: &ref_14
28197
+ example: &ref_15
27835
28198
  tier: diamond
27836
28199
  description: >-
27837
28200
  Object containing [metadata](/authkit/metadata) key/value pairs
@@ -27886,9 +28249,9 @@ components:
27886
28249
  type:
27887
28250
  - object
27888
28251
  - 'null'
27889
- additionalProperties: *ref_13
28252
+ additionalProperties: *ref_14
27890
28253
  maxProperties: 50
27891
- example: *ref_14
28254
+ example: *ref_15
27892
28255
  description: >-
27893
28256
  Object containing [metadata](/authkit/metadata) key/value pairs
27894
28257
  associated with the Organization.
@@ -28022,7 +28385,7 @@ components:
28022
28385
  example: application/x-www-form-urlencoded
28023
28386
  authenticate_via:
28024
28387
  type: string
28025
- enum: &ref_15
28388
+ enum: &ref_16
28026
28389
  - request_body
28027
28390
  - basic_auth_header
28028
28391
  description: >-
@@ -28190,7 +28553,7 @@ components:
28190
28553
  example: application/x-www-form-urlencoded
28191
28554
  authenticate_via:
28192
28555
  type: string
28193
- enum: *ref_15
28556
+ enum: *ref_16
28194
28557
  description: >-
28195
28558
  How client credentials are sent when exchanging authorization codes
28196
28559
  and refreshing tokens.
@@ -28236,7 +28599,7 @@ components:
28236
28599
  Updates to a custom provider's OAuth definition. Only valid for
28237
28600
  custom-provider integrations.
28238
28601
  $ref: '#/components/schemas/UpdateCustomProviderDefinitionDto'
28239
- OrganizationConnectedAccountDto:
28602
+ CreateOrganizationConnectedAccountDto:
28240
28603
  type: object
28241
28604
  properties:
28242
28605
  access_token:
@@ -28256,7 +28619,7 @@ components:
28256
28619
  format: date-time
28257
28620
  scopes:
28258
28621
  description: The OAuth scopes granted for this connection.
28259
- example: &ref_16
28622
+ example: &ref_17
28260
28623
  - repo
28261
28624
  - user:email
28262
28625
  type: array
@@ -28264,7 +28627,7 @@ components:
28264
28627
  type: string
28265
28628
  state:
28266
28629
  type: string
28267
- enum: &ref_17
28630
+ enum: &ref_18
28268
28631
  - connected
28269
28632
  - needs_reauthorization
28270
28633
  description: >-
@@ -28278,8 +28641,93 @@ components:
28278
28641
  member on whose behalf the connected account is being imported or
28279
28642
  updated. The user must be an active member of the organization.
28280
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
28281
28691
  required:
28282
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
28283
28731
  ConnectedAccountDto:
28284
28732
  type: object
28285
28733
  properties:
@@ -28300,13 +28748,13 @@ components:
28300
28748
  format: date-time
28301
28749
  scopes:
28302
28750
  description: The OAuth scopes granted for this connection.
28303
- example: *ref_16
28751
+ example: *ref_17
28304
28752
  type: array
28305
28753
  items:
28306
28754
  type: string
28307
28755
  state:
28308
28756
  type: string
28309
- enum: *ref_17
28757
+ enum: *ref_18
28310
28758
  description: >-
28311
28759
  Explicitly set the state of the connected account. When omitted, the
28312
28760
  state is derived from the token combination provided.
@@ -28816,9 +29264,9 @@ components:
28816
29264
  x-exclude-from-lint: true
28817
29265
  required:
28818
29266
  - role_slug
28819
- x-mutually-exclusive-body-groups: *ref_18
28820
- UpdateUserlandUserOrganizationMembershipDto:
28821
29267
  x-mutually-exclusive-body-groups: *ref_19
29268
+ UpdateUserlandUserOrganizationMembershipDto:
29269
+ x-mutually-exclusive-body-groups: *ref_20
28822
29270
  oneOf:
28823
29271
  - type: object
28824
29272
  not:
@@ -28942,9 +29390,9 @@ components:
28942
29390
  type:
28943
29391
  - object
28944
29392
  - 'null'
28945
- additionalProperties: *ref_13
29393
+ additionalProperties: *ref_14
28946
29394
  maxProperties: 50
28947
- example: &ref_21
29395
+ example: &ref_22
28948
29396
  timezone: America/New_York
28949
29397
  description: >-
28950
29398
  Object containing metadata key/value pairs associated with the
@@ -29043,7 +29491,7 @@ components:
29043
29491
  example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
29044
29492
  password_hash_type:
29045
29493
  type: string
29046
- enum: &ref_22
29494
+ enum: &ref_23
29047
29495
  - bcrypt
29048
29496
  - firebase-scrypt
29049
29497
  - ssha
@@ -29058,7 +29506,7 @@ components:
29058
29506
  example: bcrypt
29059
29507
  password_salt_position:
29060
29508
  type: string
29061
- enum: &ref_23
29509
+ enum: &ref_24
29062
29510
  - prefix
29063
29511
  - suffix
29064
29512
  description: >-
@@ -29079,7 +29527,7 @@ components:
29079
29527
  x-exclude-from-lint: true
29080
29528
  required:
29081
29529
  - password
29082
- x-mutually-exclusive-body-groups: *ref_20
29530
+ x-mutually-exclusive-body-groups: *ref_21
29083
29531
  UpdateUserlandUserDto:
29084
29532
  allOf:
29085
29533
  - type: object
@@ -29109,9 +29557,9 @@ components:
29109
29557
  type:
29110
29558
  - object
29111
29559
  - 'null'
29112
- additionalProperties: *ref_13
29560
+ additionalProperties: *ref_14
29113
29561
  maxProperties: 50
29114
- example: *ref_21
29562
+ example: *ref_22
29115
29563
  description: >-
29116
29564
  Object containing metadata key/value pairs associated with the
29117
29565
  user.
@@ -29193,7 +29641,7 @@ components:
29193
29641
  example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
29194
29642
  password_hash_type:
29195
29643
  type: string
29196
- enum: *ref_22
29644
+ enum: *ref_23
29197
29645
  description: >-
29198
29646
  The algorithm originally used to hash the password, used
29199
29647
  when providing a `password_hash`. Required with
@@ -29201,7 +29649,7 @@ components:
29201
29649
  example: bcrypt
29202
29650
  password_salt_position:
29203
29651
  type: string
29204
- enum: *ref_23
29652
+ enum: *ref_24
29205
29653
  description: >-
29206
29654
  The position of the salt relative to the password when the
29207
29655
  `password_hash` digest was computed: `prefix` for `hash(salt
@@ -29220,7 +29668,7 @@ components:
29220
29668
  x-exclude-from-lint: true
29221
29669
  required:
29222
29670
  - password
29223
- x-mutually-exclusive-body-groups: *ref_24
29671
+ x-mutually-exclusive-body-groups: *ref_25
29224
29672
  VerifyEmailAddressDto:
29225
29673
  type: object
29226
29674
  properties:
@@ -29329,7 +29777,7 @@ components:
29329
29777
  description: The events that the Webhook Endpoint is subscribed to.
29330
29778
  items:
29331
29779
  type: string
29332
- enum: &ref_25
29780
+ enum: &ref_26
29333
29781
  - agent.blueprint.created
29334
29782
  - agent.blueprint.deleted
29335
29783
  - agent.blueprint.updated
@@ -29460,7 +29908,7 @@ components:
29460
29908
  description: The events that the Webhook Endpoint is subscribed to.
29461
29909
  items:
29462
29910
  type: string
29463
- enum: *ref_25
29911
+ enum: *ref_26
29464
29912
  example:
29465
29913
  - user.created
29466
29914
  - dsync.user.created
@@ -33135,7 +33583,7 @@ components:
33135
33583
  description: >-
33136
33584
  An object containing the custom attribute mapping for the Directory
33137
33585
  Provider.
33138
- example: &ref_32
33586
+ example: &ref_33
33139
33587
  department: Engineering
33140
33588
  job_title: Software Engineer
33141
33589
  role:
@@ -33374,7 +33822,7 @@ components:
33374
33822
  type: object
33375
33823
  additionalProperties: {}
33376
33824
  description: The event payload.
33377
- example: &ref_26
33825
+ example: &ref_27
33378
33826
  id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
33379
33827
  directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
33380
33828
  organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
@@ -33409,11 +33857,11 @@ components:
33409
33857
  - data
33410
33858
  - created_at
33411
33859
  description: An event emitted by WorkOS.
33412
- example: &ref_37
33860
+ example: &ref_38
33413
33861
  object: event
33414
33862
  id: event_01EHZNVPK3SFK441A1RGBFSHRT
33415
33863
  event: dsync.user.created
33416
- data: *ref_26
33864
+ data: *ref_27
33417
33865
  created_at: '2021-06-25T19:07:33.155Z'
33418
33866
  context: {}
33419
33867
  - oneOf:
@@ -33613,7 +34061,7 @@ components:
33613
34061
  description: >-
33614
34062
  Permission slugs forming the ceiling on what sessions
33615
34063
  minted from this blueprint may do.
33616
- example: &ref_27
34064
+ example: &ref_28
33617
34065
  - crm:read
33618
34066
  - email:send
33619
34067
  invocable_by:
@@ -33626,7 +34074,7 @@ components:
33626
34074
  description: >-
33627
34075
  Role slugs whose members may mint user-delegated
33628
34076
  sessions from this blueprint.
33629
- example: &ref_28
34077
+ example: &ref_29
33630
34078
  - manager
33631
34079
  organization_ids:
33632
34080
  type: array
@@ -33635,7 +34083,7 @@ components:
33635
34083
  description: >-
33636
34084
  Organizations in which autonomous sessions may be
33637
34085
  minted from this blueprint.
33638
- example: &ref_29
34086
+ example: &ref_30
33639
34087
  - org_01EHWNCE74X7JSDV0X3SZ3KJNY
33640
34088
  required:
33641
34089
  - role_slugs
@@ -33655,7 +34103,7 @@ components:
33655
34103
  Instance types that may be minted from this
33656
34104
  blueprint: `delegated` (acting for a user) and/or
33657
34105
  `autonomous` (acting as the agent itself).
33658
- example: &ref_30
34106
+ example: &ref_31
33659
34107
  - delegated
33660
34108
  - autonomous
33661
34109
  required:
@@ -33815,7 +34263,7 @@ components:
33815
34263
  description: >-
33816
34264
  Permission slugs forming the ceiling on what sessions
33817
34265
  minted from this blueprint may do.
33818
- example: *ref_27
34266
+ example: *ref_28
33819
34267
  invocable_by:
33820
34268
  type: object
33821
34269
  properties:
@@ -33826,7 +34274,7 @@ components:
33826
34274
  description: >-
33827
34275
  Role slugs whose members may mint user-delegated
33828
34276
  sessions from this blueprint.
33829
- example: *ref_28
34277
+ example: *ref_29
33830
34278
  organization_ids:
33831
34279
  type: array
33832
34280
  items:
@@ -33834,7 +34282,7 @@ components:
33834
34282
  description: >-
33835
34283
  Organizations in which autonomous sessions may be
33836
34284
  minted from this blueprint.
33837
- example: *ref_29
34285
+ example: *ref_30
33838
34286
  required:
33839
34287
  - role_slugs
33840
34288
  - organization_ids
@@ -33853,7 +34301,7 @@ components:
33853
34301
  Instance types that may be minted from this
33854
34302
  blueprint: `delegated` (acting for a user) and/or
33855
34303
  `autonomous` (acting as the agent itself).
33856
- example: *ref_30
34304
+ example: *ref_31
33857
34305
  required:
33858
34306
  - instance_types
33859
34307
  description: How sessions may be minted from this blueprint.
@@ -34889,7 +35337,7 @@ components:
34889
35337
  items:
34890
35338
  type: string
34891
35339
  description: The permissions granted to the API key.
34892
- example: &ref_31
35340
+ example: &ref_32
34893
35341
  - users:read
34894
35342
  - users:write
34895
35343
  created_at:
@@ -35015,7 +35463,7 @@ components:
35015
35463
  items:
35016
35464
  type: string
35017
35465
  description: The permissions granted to the API key.
35018
- example: *ref_31
35466
+ example: *ref_32
35019
35467
  created_at:
35020
35468
  type: string
35021
35469
  description: The timestamp when the API key was created.
@@ -35139,7 +35587,7 @@ components:
35139
35587
  items:
35140
35588
  type: string
35141
35589
  description: The permissions granted to the API key.
35142
- example: *ref_31
35590
+ example: *ref_32
35143
35591
  created_at:
35144
35592
  type: string
35145
35593
  description: The timestamp when the API key was created.
@@ -38006,7 +38454,7 @@ components:
38006
38454
  description: >-
38007
38455
  An object containing the custom attribute mapping for
38008
38456
  the Directory Provider.
38009
- example: *ref_32
38457
+ example: *ref_33
38010
38458
  role:
38011
38459
  $ref: '#/components/schemas/SlimRole'
38012
38460
  roles:
@@ -38196,7 +38644,7 @@ components:
38196
38644
  description: >-
38197
38645
  Labels assigned to the Feature Flag for categorizing and
38198
38646
  filtering.
38199
- example: &ref_33
38647
+ example: &ref_34
38200
38648
  - reports
38201
38649
  enabled:
38202
38650
  type: boolean
@@ -38357,7 +38805,7 @@ components:
38357
38805
  description: >-
38358
38806
  Labels assigned to the Feature Flag for categorizing and
38359
38807
  filtering.
38360
- example: *ref_33
38808
+ example: *ref_34
38361
38809
  enabled:
38362
38810
  type: boolean
38363
38811
  description: >-
@@ -38517,7 +38965,7 @@ components:
38517
38965
  description: >-
38518
38966
  Labels assigned to the Feature Flag for categorizing and
38519
38967
  filtering.
38520
- example: *ref_33
38968
+ example: *ref_34
38521
38969
  enabled:
38522
38970
  type: boolean
38523
38971
  description: >-
@@ -38797,7 +39245,7 @@ components:
38797
39245
  description: >-
38798
39246
  Labels assigned to the Feature Flag for categorizing and
38799
39247
  filtering.
38800
- example: *ref_33
39248
+ example: *ref_34
38801
39249
  enabled:
38802
39250
  type: boolean
38803
39251
  description: >-
@@ -39785,7 +40233,7 @@ components:
39785
40233
  description: >-
39786
40234
  Object containing [metadata](/authkit/metadata)
39787
40235
  key/value pairs associated with the Organization.
39788
- example: &ref_34
40236
+ example: &ref_35
39789
40237
  tier: diamond
39790
40238
  propertyNames:
39791
40239
  maxLength: 40
@@ -39935,7 +40383,7 @@ components:
39935
40383
  description: >-
39936
40384
  Object containing [metadata](/authkit/metadata)
39937
40385
  key/value pairs associated with the Organization.
39938
- example: *ref_34
40386
+ example: *ref_35
39939
40387
  propertyNames:
39940
40388
  maxLength: 40
39941
40389
  maxProperties: 50
@@ -40762,7 +41210,7 @@ components:
40762
41210
  items:
40763
41211
  type: string
40764
41212
  description: The permissions granted by the role.
40765
- example: &ref_35
41213
+ example: &ref_36
40766
41214
  - users:read
40767
41215
  - users:write
40768
41216
  created_at:
@@ -40846,7 +41294,7 @@ components:
40846
41294
  items:
40847
41295
  type: string
40848
41296
  description: The permissions granted by the role.
40849
- example: *ref_35
41297
+ example: *ref_36
40850
41298
  created_at:
40851
41299
  format: date-time
40852
41300
  type: string
@@ -40928,7 +41376,7 @@ components:
40928
41376
  items:
40929
41377
  type: string
40930
41378
  description: The permissions granted by the role.
40931
- example: *ref_35
41379
+ example: *ref_36
40932
41380
  created_at:
40933
41381
  format: date-time
40934
41382
  type: string
@@ -41065,7 +41513,7 @@ components:
41065
41513
  description: >-
41066
41514
  Object containing [metadata](/authkit/metadata)
41067
41515
  key/value pairs associated with the Organization.
41068
- example: *ref_34
41516
+ example: *ref_35
41069
41517
  propertyNames:
41070
41518
  maxLength: 40
41071
41519
  maxProperties: 50
@@ -42261,7 +42709,7 @@ components:
42261
42709
  items:
42262
42710
  type: string
42263
42711
  description: The permissions granted by the role.
42264
- example: &ref_36
42712
+ example: &ref_37
42265
42713
  - users:read
42266
42714
  - users:write
42267
42715
  created_at:
@@ -42327,7 +42775,7 @@ components:
42327
42775
  items:
42328
42776
  type: string
42329
42777
  description: The permissions granted by the role.
42330
- example: *ref_36
42778
+ example: *ref_37
42331
42779
  created_at:
42332
42780
  format: date-time
42333
42781
  type: string
@@ -42391,7 +42839,7 @@ components:
42391
42839
  items:
42392
42840
  type: string
42393
42841
  description: The permissions granted by the role.
42394
- example: *ref_36
42842
+ example: *ref_37
42395
42843
  created_at:
42396
42844
  format: date-time
42397
42845
  type: string
@@ -43231,6 +43679,68 @@ components:
43231
43679
  - data
43232
43680
  - created_at
43233
43681
  - object
43682
+ - type: object
43683
+ properties:
43684
+ id:
43685
+ type: string
43686
+ description: Unique identifier for the event.
43687
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
43688
+ event:
43689
+ type: string
43690
+ const: vault.dek.rekeyed
43691
+ data:
43692
+ type: object
43693
+ properties:
43694
+ actor_id:
43695
+ type: string
43696
+ description: The unique identifier of the actor.
43697
+ example: user_01EHWNCE74X7JSDV0X3SZ3KJNY
43698
+ actor_source:
43699
+ type: string
43700
+ enum:
43701
+ - api
43702
+ - dashboard
43703
+ actor_name:
43704
+ type: string
43705
+ description: The name of the actor.
43706
+ example: Jane Doe
43707
+ key_ids:
43708
+ type: array
43709
+ items:
43710
+ type: string
43711
+ description: >-
43712
+ The unique identifiers of the re-encrypted data
43713
+ encryption keys.
43714
+ example:
43715
+ - dek_01EHWNCE74X7JSDV0X3SZ3KJNY
43716
+ key_context:
43717
+ type: object
43718
+ additionalProperties:
43719
+ type: string
43720
+ required:
43721
+ - actor_id
43722
+ - actor_source
43723
+ - actor_name
43724
+ - key_ids
43725
+ - key_context
43726
+ description: The event payload.
43727
+ created_at:
43728
+ format: date-time
43729
+ type: string
43730
+ description: An ISO 8601 timestamp.
43731
+ example: '2026-01-15T12:00:00.000Z'
43732
+ context:
43733
+ $ref: '#/components/schemas/EventContextDto'
43734
+ object:
43735
+ type: string
43736
+ description: Distinguishes the Event object.
43737
+ const: event
43738
+ required:
43739
+ - id
43740
+ - event
43741
+ - data
43742
+ - created_at
43743
+ - object
43234
43744
  - type: object
43235
43745
  properties:
43236
43746
  id:
@@ -43531,7 +44041,7 @@ components:
43531
44041
  - data
43532
44042
  - created_at
43533
44043
  - object
43534
- example: *ref_37
44044
+ example: *ref_38
43535
44045
  description: An event emitted by WorkOS.
43536
44046
  EventList:
43537
44047
  type: object
@@ -43566,7 +44076,7 @@ components:
43566
44076
  example:
43567
44077
  object: list
43568
44078
  data:
43569
- - *ref_37
44079
+ - *ref_38
43570
44080
  list_metadata:
43571
44081
  after: event_01EHZNVPK3SFK441A1RGBFSHRT
43572
44082
  JwtTemplate:
@@ -45527,7 +46037,7 @@ components:
45527
46037
  items:
45528
46038
  type: string
45529
46039
  description: The OAuth scopes granted for this connection.
45530
- example: &ref_38
46040
+ example: &ref_39
45531
46041
  - repo
45532
46042
  - user:email
45533
46043
  auth_method:
@@ -45577,7 +46087,7 @@ components:
45577
46087
  `installation` scope, excluding any it declares as
45578
46088
  secret. Only present when `auth_method` is
45579
46089
  `client_credentials`.
45580
- example: &ref_39
46090
+ example: &ref_40
45581
46091
  instance_url: https://example.my.salesforce.com
45582
46092
  state:
45583
46093
  type: string
@@ -45706,7 +46216,7 @@ components:
45706
46216
  items:
45707
46217
  type: string
45708
46218
  description: The OAuth scopes granted for this connection.
45709
- example: *ref_38
46219
+ example: *ref_39
45710
46220
  auth_method:
45711
46221
  type: string
45712
46222
  enum:
@@ -45753,7 +46263,7 @@ components:
45753
46263
  `installation` scope, excluding any it declares as
45754
46264
  secret. Only present when `auth_method` is
45755
46265
  `client_credentials`.
45756
- example: *ref_39
46266
+ example: *ref_40
45757
46267
  state:
45758
46268
  type: string
45759
46269
  enum: