@workos/openapi-spec 0.68.0 → 0.69.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.
@@ -631,7 +631,7 @@ paths:
631
631
  - name: order
632
632
  required: false
633
633
  in: query
634
- description: Order the results by the creation time.
634
+ description: Order the results by the creation time. Defaults to `normal`.
635
635
  schema:
636
636
  $ref: '#/components/schemas/PaginationOrder'
637
637
  responses:
@@ -800,7 +800,7 @@ paths:
800
800
  - name: order
801
801
  required: false
802
802
  in: query
803
- description: Order the results by the creation time.
803
+ description: Order the results by the creation time. Defaults to `normal`.
804
804
  schema:
805
805
  $ref: '#/components/schemas/PaginationOrder'
806
806
  responses:
@@ -1661,7 +1661,7 @@ paths:
1661
1661
  Order the results by the creation time. Supported values are `"asc"`
1662
1662
  (ascending), `"desc"` (descending), and `"normal"` (descending with
1663
1663
  reversed cursor semantics where `before` fetches older records and
1664
- `after` fetches newer records).
1664
+ `after` fetches newer records). Defaults to `normal`.
1665
1665
  schema:
1666
1666
  $ref: '#/components/schemas/PaginationOrder'
1667
1667
  responses:
@@ -2165,7 +2165,7 @@ paths:
2165
2165
  Order the results by the creation time. Supported values are `"asc"`
2166
2166
  (ascending), `"desc"` (descending), and `"normal"` (descending with
2167
2167
  reversed cursor semantics where `before` fetches older records and
2168
- `after` fetches newer records).
2168
+ `after` fetches newer records). Defaults to `normal`.
2169
2169
  schema:
2170
2170
  $ref: '#/components/schemas/PaginationOrder'
2171
2171
  - name: permission_slug
@@ -2355,7 +2355,7 @@ paths:
2355
2355
  Order the results by the creation time. Supported values are `"asc"`
2356
2356
  (ascending), `"desc"` (descending), and `"normal"` (descending with
2357
2357
  reversed cursor semantics where `before` fetches older records and
2358
- `after` fetches newer records).
2358
+ `after` fetches newer records). Defaults to `normal`.
2359
2359
  schema:
2360
2360
  $ref: '#/components/schemas/PaginationOrder'
2361
2361
  responses:
@@ -2482,7 +2482,7 @@ paths:
2482
2482
  Order the results by the creation time. Supported values are `"asc"`
2483
2483
  (ascending), `"desc"` (descending), and `"normal"` (descending with
2484
2484
  reversed cursor semantics where `before` fetches older records and
2485
- `after` fetches newer records).
2485
+ `after` fetches newer records). Defaults to `normal`.
2486
2486
  schema:
2487
2487
  $ref: '#/components/schemas/PaginationOrder'
2488
2488
  responses:
@@ -2594,7 +2594,7 @@ paths:
2594
2594
  Order the results by the creation time. Supported values are `"asc"`
2595
2595
  (ascending), `"desc"` (descending), and `"normal"` (descending with
2596
2596
  reversed cursor semantics where `before` fetches older records and
2597
- `after` fetches newer records).
2597
+ `after` fetches newer records). Defaults to `normal`.
2598
2598
  schema:
2599
2599
  $ref: '#/components/schemas/PaginationOrder'
2600
2600
  - name: resource_id
@@ -4291,7 +4291,7 @@ paths:
4291
4291
  Order the results by the creation time. Supported values are `"asc"`
4292
4292
  (ascending), `"desc"` (descending), and `"normal"` (descending with
4293
4293
  reversed cursor semantics where `before` fetches older records and
4294
- `after` fetches newer records).
4294
+ `after` fetches newer records). Defaults to `normal`.
4295
4295
  schema:
4296
4296
  $ref: '#/components/schemas/PaginationOrder'
4297
4297
  - name: permission_slug
@@ -4457,7 +4457,7 @@ paths:
4457
4457
  Order the results by the creation time. Supported values are `"asc"`
4458
4458
  (ascending), `"desc"` (descending), and `"normal"` (descending with
4459
4459
  reversed cursor semantics where `before` fetches older records and
4460
- `after` fetches newer records).
4460
+ `after` fetches newer records). Defaults to `normal`.
4461
4461
  schema:
4462
4462
  $ref: '#/components/schemas/PaginationOrder'
4463
4463
  - name: role_slug
@@ -4551,7 +4551,7 @@ paths:
4551
4551
  Order the results by the creation time. Supported values are `"asc"`
4552
4552
  (ascending), `"desc"` (descending), and `"normal"` (descending with
4553
4553
  reversed cursor semantics where `before` fetches older records and
4554
- `after` fetches newer records).
4554
+ `after` fetches newer records). Defaults to `normal`.
4555
4555
  schema:
4556
4556
  $ref: '#/components/schemas/PaginationOrder'
4557
4557
  responses:
@@ -4925,7 +4925,7 @@ paths:
4925
4925
  Order the results by the creation time. Supported values are `"asc"`
4926
4926
  (ascending), `"desc"` (descending), and `"normal"` (descending with
4927
4927
  reversed cursor semantics where `before` fetches older records and
4928
- `after` fetches newer records).
4928
+ `after` fetches newer records). Defaults to `normal`.
4929
4929
  schema:
4930
4930
  $ref: '#/components/schemas/PaginationOrder'
4931
4931
  - name: organization_id
@@ -5630,7 +5630,7 @@ paths:
5630
5630
  Order the results by the creation time. Supported values are `"asc"`
5631
5631
  (ascending), `"desc"` (descending), and `"normal"` (descending with
5632
5632
  reversed cursor semantics where `before` fetches older records and
5633
- `after` fetches newer records).
5633
+ `after` fetches newer records). Defaults to `normal`.
5634
5634
  schema:
5635
5635
  $ref: '#/components/schemas/PaginationOrder'
5636
5636
  - name: permission_slug
@@ -5780,7 +5780,7 @@ paths:
5780
5780
  Order the results by the creation time. Supported values are `"asc"`
5781
5781
  (ascending), `"desc"` (descending), and `"normal"` (descending with
5782
5782
  reversed cursor semantics where `before` fetches older records and
5783
- `after` fetches newer records).
5783
+ `after` fetches newer records). Defaults to `normal`.
5784
5784
  schema:
5785
5785
  $ref: '#/components/schemas/PaginationOrder'
5786
5786
  - name: role_slug
@@ -6638,7 +6638,7 @@ paths:
6638
6638
  Order the results by the creation time. Supported values are `"asc"`
6639
6639
  (ascending), `"desc"` (descending), and `"normal"` (descending with
6640
6640
  reversed cursor semantics where `before` fetches older records and
6641
- `after` fetches newer records).
6641
+ `after` fetches newer records). Defaults to `normal`.
6642
6642
  schema:
6643
6643
  $ref: '#/components/schemas/PaginationOrder'
6644
6644
  - name: registration_types
@@ -7063,7 +7063,7 @@ paths:
7063
7063
  - name: order
7064
7064
  required: false
7065
7065
  in: query
7066
- description: Order the results by the creation time.
7066
+ description: Order the results by the creation time. Defaults to `normal`.
7067
7067
  schema:
7068
7068
  $ref: '#/components/schemas/PaginationOrder'
7069
7069
  - name: connection_type
@@ -7419,7 +7419,7 @@ paths:
7419
7419
  Order the results by the creation time. Supported values are `"asc"`
7420
7420
  (ascending), `"desc"` (descending), and `"normal"` (descending with
7421
7421
  reversed cursor semantics where `before` fetches older records and
7422
- `after` fetches newer records).
7422
+ `after` fetches newer records). Defaults to `normal`.
7423
7423
  schema:
7424
7424
  $ref: '#/components/schemas/PaginationOrder'
7425
7425
  responses:
@@ -7860,7 +7860,7 @@ paths:
7860
7860
  installation, keyed by the provider's config field
7861
7861
  descriptors.
7862
7862
  example:
7863
- mydomain: acme
7863
+ salesforce_host: acme.my.salesforce.com
7864
7864
  required:
7865
7865
  - user_id
7866
7866
  - client_id
@@ -8155,7 +8155,7 @@ paths:
8155
8155
  - name: order
8156
8156
  required: false
8157
8157
  in: query
8158
- description: Order the results by the creation time.
8158
+ description: Order the results by the creation time. Defaults to `normal`.
8159
8159
  schema:
8160
8160
  $ref: '#/components/schemas/PaginationOrder'
8161
8161
  - name: organization_id
@@ -8349,7 +8349,7 @@ paths:
8349
8349
  Order the results by the creation time. Supported values are `"asc"`
8350
8350
  (ascending), `"desc"` (descending), and `"normal"` (descending with
8351
8351
  reversed cursor semantics where `before` fetches older records and
8352
- `after` fetches newer records).
8352
+ `after` fetches newer records). Defaults to `normal`.
8353
8353
  schema:
8354
8354
  $ref: '#/components/schemas/PaginationOrder'
8355
8355
  - name: directory
@@ -8517,7 +8517,7 @@ paths:
8517
8517
  Order the results by the creation time. Supported values are `"asc"`
8518
8518
  (ascending), `"desc"` (descending), and `"normal"` (descending with
8519
8519
  reversed cursor semantics where `before` fetches older records and
8520
- `after` fetches newer records).
8520
+ `after` fetches newer records). Defaults to `normal`.
8521
8521
  schema:
8522
8522
  $ref: '#/components/schemas/PaginationOrder'
8523
8523
  - name: directory
@@ -8708,7 +8708,7 @@ paths:
8708
8708
  Order the results by the creation time. Supported values are `"asc"`
8709
8709
  (ascending), `"desc"` (descending), and `"normal"` (descending with
8710
8710
  reversed cursor semantics where `before` fetches older records and
8711
- `after` fetches newer records).
8711
+ `after` fetches newer records). Defaults to `normal`.
8712
8712
  schema:
8713
8713
  $ref: '#/components/schemas/PaginationOrder'
8714
8714
  - name: events
@@ -8843,7 +8843,7 @@ paths:
8843
8843
  - name: order
8844
8844
  required: false
8845
8845
  in: query
8846
- description: Order the results by the creation time.
8846
+ description: Order the results by the creation time. Defaults to `normal`.
8847
8847
  schema:
8848
8848
  $ref: '#/components/schemas/PaginationOrder'
8849
8849
  responses:
@@ -9594,7 +9594,7 @@ paths:
9594
9594
  Order the results by the creation time. Supported values are `"asc"`
9595
9595
  (ascending), `"desc"` (descending), and `"normal"` (descending with
9596
9596
  reversed cursor semantics where `before` fetches older records and
9597
- `after` fetches newer records).
9597
+ `after` fetches newer records). Defaults to `normal`.
9598
9598
  schema:
9599
9599
  $ref: '#/components/schemas/PaginationOrder'
9600
9600
  - name: domains
@@ -10170,7 +10170,7 @@ paths:
10170
10170
  - name: order
10171
10171
  required: false
10172
10172
  in: query
10173
- description: Order the results by the creation time.
10173
+ description: Order the results by the creation time. Defaults to `normal`.
10174
10174
  schema:
10175
10175
  $ref: '#/components/schemas/PaginationOrder'
10176
10176
  responses:
@@ -10447,7 +10447,7 @@ paths:
10447
10447
  - name: order
10448
10448
  required: false
10449
10449
  in: query
10450
- description: Order the results by the creation time.
10450
+ description: Order the results by the creation time. Defaults to `desc`.
10451
10451
  schema:
10452
10452
  $ref: '#/components/schemas/PaginationOrder'
10453
10453
  responses:
@@ -10613,7 +10613,7 @@ paths:
10613
10613
  Order the results by the creation time. Supported values are `"asc"`
10614
10614
  (ascending), `"desc"` (descending), and `"normal"` (descending with
10615
10615
  reversed cursor semantics where `before` fetches older records and
10616
- `after` fetches newer records).
10616
+ `after` fetches newer records). Defaults to `normal`.
10617
10617
  schema:
10618
10618
  $ref: '#/components/schemas/PaginationOrder'
10619
10619
  - name: search
@@ -11012,7 +11012,7 @@ paths:
11012
11012
  Order the results by the creation time. Supported values are `"asc"`
11013
11013
  (ascending), `"desc"` (descending), and `"normal"` (descending with
11014
11014
  reversed cursor semantics where `before` fetches older records and
11015
- `after` fetches newer records).
11015
+ `after` fetches newer records). Defaults to `normal`.
11016
11016
  schema:
11017
11017
  $ref: '#/components/schemas/PaginationOrder'
11018
11018
  responses:
@@ -11167,7 +11167,7 @@ paths:
11167
11167
  Order the results by the creation time. Supported values are `"asc"`
11168
11168
  (ascending), `"desc"` (descending), and `"normal"` (descending with
11169
11169
  reversed cursor semantics where `before` fetches older records and
11170
- `after` fetches newer records).
11170
+ `after` fetches newer records). Defaults to `normal`.
11171
11171
  schema:
11172
11172
  $ref: '#/components/schemas/PaginationOrder'
11173
11173
  responses:
@@ -14262,7 +14262,7 @@ paths:
14262
14262
  Order the results by the creation time. Supported values are `"asc"`
14263
14263
  (ascending), `"desc"` (descending), and `"normal"` (descending with
14264
14264
  reversed cursor semantics where `before` fetches older records and
14265
- `after` fetches newer records).
14265
+ `after` fetches newer records). Defaults to `normal`.
14266
14266
  schema:
14267
14267
  $ref: '#/components/schemas/PaginationOrder'
14268
14268
  responses:
@@ -14413,7 +14413,7 @@ paths:
14413
14413
  Order the results by the creation time. Supported values are `"asc"`
14414
14414
  (ascending), `"desc"` (descending), and `"normal"` (descending with
14415
14415
  reversed cursor semantics where `before` fetches older records and
14416
- `after` fetches newer records).
14416
+ `after` fetches newer records). Defaults to `desc`.
14417
14417
  schema:
14418
14418
  $ref: '#/components/schemas/PaginationOrder'
14419
14419
  - name: organization_id
@@ -15450,7 +15450,7 @@ paths:
15450
15450
  Order the results by the creation time. Supported values are `"asc"`
15451
15451
  (ascending), `"desc"` (descending), and `"normal"` (descending with
15452
15452
  reversed cursor semantics where `before` fetches older records and
15453
- `after` fetches newer records).
15453
+ `after` fetches newer records). Defaults to `desc`.
15454
15454
  schema:
15455
15455
  $ref: '#/components/schemas/PaginationOrder'
15456
15456
  - name: organization_id
@@ -16296,7 +16296,7 @@ paths:
16296
16296
  Order the results by the creation time. Supported values are `"asc"`
16297
16297
  (ascending), `"desc"` (descending), and `"normal"` (descending with
16298
16298
  reversed cursor semantics where `before` fetches older records and
16299
- `after` fetches newer records).
16299
+ `after` fetches newer records). Defaults to `normal`.
16300
16300
  schema:
16301
16301
  $ref: '#/components/schemas/PaginationOrder'
16302
16302
  responses:
@@ -16760,7 +16760,7 @@ paths:
16760
16760
  Order the results by the creation time. Supported values are `"asc"`
16761
16761
  (ascending), `"desc"` (descending), and `"normal"` (descending with
16762
16762
  reversed cursor semantics where `before` fetches older records and
16763
- `after` fetches newer records).
16763
+ `after` fetches newer records). Defaults to `normal`.
16764
16764
  schema:
16765
16765
  $ref: '#/components/schemas/PaginationOrder'
16766
16766
  responses:
@@ -17024,7 +17024,7 @@ paths:
17024
17024
  Order the results by the creation time. Supported values are `"asc"`
17025
17025
  (ascending), `"desc"` (descending), and `"normal"` (descending with
17026
17026
  reversed cursor semantics where `before` fetches older records and
17027
- `after` fetches newer records).
17027
+ `after` fetches newer records). Defaults to `desc`.
17028
17028
  schema:
17029
17029
  $ref: '#/components/schemas/PaginationOrder'
17030
17030
  - name: organization
@@ -18421,7 +18421,7 @@ paths:
18421
18421
  Order the results by the creation time. Supported values are `"asc"`
18422
18422
  (ascending), `"desc"` (descending), and `"normal"` (descending with
18423
18423
  reversed cursor semantics where `before` fetches older records and
18424
- `after` fetches newer records).
18424
+ `after` fetches newer records). Defaults to `desc`.
18425
18425
  schema:
18426
18426
  $ref: '#/components/schemas/PaginationOrder'
18427
18427
  responses:
@@ -18672,7 +18672,7 @@ paths:
18672
18672
  - name: order
18673
18673
  required: false
18674
18674
  in: query
18675
- description: Order the results by the creation time.
18675
+ description: Order the results by the creation time. Defaults to `normal`.
18676
18676
  schema:
18677
18677
  $ref: '#/components/schemas/PaginationOrder'
18678
18678
  - name: organization_id
@@ -18844,7 +18844,7 @@ paths:
18844
18844
  - name: order
18845
18845
  required: false
18846
18846
  in: query
18847
- description: Order the results by the creation time.
18847
+ description: Order the results by the creation time. Defaults to `desc`.
18848
18848
  schema:
18849
18849
  $ref: '#/components/schemas/PaginationOrder'
18850
18850
  responses:
@@ -18925,7 +18925,7 @@ paths:
18925
18925
  Order the results by the creation time. Supported values are `"asc"`
18926
18926
  (ascending), `"desc"` (descending), and `"normal"` (descending with
18927
18927
  reversed cursor semantics where `before` fetches older records and
18928
- `after` fetches newer records).
18928
+ `after` fetches newer records). Defaults to `normal`.
18929
18929
  schema:
18930
18930
  $ref: '#/components/schemas/PaginationOrder'
18931
18931
  responses:
@@ -19411,7 +19411,7 @@ paths:
19411
19411
  - name: order
19412
19412
  required: false
19413
19413
  in: query
19414
- description: Order the results by the creation time.
19414
+ description: Order the results by the creation time. Defaults to `normal`.
19415
19415
  schema:
19416
19416
  $ref: '#/components/schemas/PaginationOrder'
19417
19417
  responses:
@@ -19878,7 +19878,7 @@ paths:
19878
19878
  Order the results by the creation time. Supported values are `"asc"`
19879
19879
  (ascending), `"desc"` (descending), and `"normal"` (descending with
19880
19880
  reversed cursor semantics where `before` fetches older records and
19881
- `after` fetches newer records).
19881
+ `after` fetches newer records). Defaults to `normal`.
19882
19882
  schema:
19883
19883
  $ref: '#/components/schemas/PaginationOrder'
19884
19884
  - name: state
@@ -20535,7 +20535,7 @@ paths:
20535
20535
  Order the results by the creation time. Supported values are `"asc"`
20536
20536
  (ascending), `"desc"` (descending), and `"normal"` (descending with
20537
20537
  reversed cursor semantics where `before` fetches older records and
20538
- `after` fetches newer records).
20538
+ `after` fetches newer records). Defaults to `normal`.
20539
20539
  schema:
20540
20540
  $ref: '#/components/schemas/PaginationOrder'
20541
20541
  responses:
@@ -21140,7 +21140,6 @@ components:
21140
21140
  - desc
21141
21141
  - asc
21142
21142
  example: desc
21143
- default: desc
21144
21143
  RedirectUriDto:
21145
21144
  type: object
21146
21145
  properties:
@@ -22467,14 +22466,19 @@ components:
22467
22466
  format: uri
22468
22467
  description: >-
22469
22468
  The provider's OAuth authorization endpoint. Required for OAuth
22470
- providers; omit for `api_key` providers.
22469
+ providers; omit for `api_key` providers. Must be a static URL:
22470
+ `${config.…}` placeholders are resolved against a provider's
22471
+ declared config fields, which custom providers cannot declare.
22471
22472
  example: https://provider.example.com/oauth/authorize
22472
22473
  token_url:
22473
22474
  type: string
22474
22475
  format: uri
22475
22476
  description: >-
22476
- The provider's OAuth token endpoint. Required for OAuth providers;
22477
- omit for `api_key` providers.
22477
+ The provider's OAuth token endpoint. Required for OAuth and
22478
+ `client_credentials` providers; omit for `api_key` providers. Must
22479
+ be a static URL: `${config.…}` placeholders are resolved against a
22480
+ provider's declared config fields, which custom providers cannot
22481
+ declare.
22478
22482
  example: https://provider.example.com/oauth/token
22479
22483
  refresh_token_url:
22480
22484
  type:
@@ -22483,7 +22487,7 @@ components:
22483
22487
  format: uri
22484
22488
  description: >-
22485
22489
  The endpoint used to refresh tokens, if different from the token
22486
- endpoint.
22490
+ endpoint. Must be a static URL, like the other endpoints.
22487
22491
  example: https://provider.example.com/oauth/token
22488
22492
  pkce_enabled:
22489
22493
  type: boolean
@@ -22623,12 +22627,18 @@ components:
22623
22627
  authorization_url:
22624
22628
  type: string
22625
22629
  format: uri
22626
- description: The provider's OAuth authorization endpoint.
22630
+ description: >-
22631
+ The provider's OAuth authorization endpoint. Must be a static URL:
22632
+ `${config.…}` placeholders are resolved against a provider's
22633
+ declared config fields, which custom providers cannot declare.
22627
22634
  example: https://provider.example.com/oauth/authorize
22628
22635
  token_url:
22629
22636
  type: string
22630
22637
  format: uri
22631
- description: The provider's OAuth token endpoint.
22638
+ description: >-
22639
+ The provider's OAuth token endpoint. Must be a static URL:
22640
+ `${config.…}` placeholders are resolved against a provider's
22641
+ declared config fields, which custom providers cannot declare.
22632
22642
  example: https://provider.example.com/oauth/token
22633
22643
  refresh_token_url:
22634
22644
  type:
@@ -22637,7 +22647,7 @@ components:
22637
22647
  format: uri
22638
22648
  description: >-
22639
22649
  The endpoint used to refresh tokens, if different from the token
22640
- endpoint.
22650
+ endpoint. Must be a static URL, like the other endpoints.
22641
22651
  example: https://provider.example.com/oauth/token
22642
22652
  pkce_enabled:
22643
22653
  type: boolean
@@ -23737,6 +23747,9 @@ components:
23737
23747
  items:
23738
23748
  type: string
23739
23749
  enum: &ref_17
23750
+ - agent.blueprint.created
23751
+ - agent.blueprint.deleted
23752
+ - agent.blueprint.updated
23740
23753
  - agent.registration.created
23741
23754
  - agent.registration.claim.attempt.created
23742
23755
  - agent.registration.claim.completed
@@ -27181,7 +27194,7 @@ components:
27181
27194
  description: >-
27182
27195
  An object containing the custom attribute mapping for the Directory
27183
27196
  Provider.
27184
- example: &ref_20
27197
+ example: &ref_23
27185
27198
  department: Engineering
27186
27199
  job_title: Software Engineer
27187
27200
  role:
@@ -27410,7 +27423,7 @@ components:
27410
27423
  - data
27411
27424
  - created_at
27412
27425
  description: An event emitted by WorkOS.
27413
- example: &ref_25
27426
+ example: &ref_28
27414
27427
  object: event
27415
27428
  id: event_01EHZNVPK3SFK441A1RGBFSHRT
27416
27429
  event: dsync.user.created
@@ -27577,6 +27590,308 @@ components:
27577
27590
  - data
27578
27591
  - created_at
27579
27592
  - object
27593
+ - type: object
27594
+ properties:
27595
+ id:
27596
+ type: string
27597
+ description: Unique identifier for the event.
27598
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
27599
+ event:
27600
+ type: string
27601
+ const: agent.blueprint.created
27602
+ data:
27603
+ type: object
27604
+ properties:
27605
+ object:
27606
+ type: string
27607
+ description: Distinguishes the agent blueprint object.
27608
+ const: agent_blueprint
27609
+ id:
27610
+ type: string
27611
+ description: Unique identifier of the agent blueprint.
27612
+ example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
27613
+ name:
27614
+ type: string
27615
+ description: Human-readable name of the agent blueprint.
27616
+ example: Prospecting Agent
27617
+ description:
27618
+ type:
27619
+ - string
27620
+ - 'null'
27621
+ description: Human-readable description of the agent blueprint.
27622
+ example: Finds and qualifies sales prospects.
27623
+ permissions:
27624
+ type: array
27625
+ items:
27626
+ type: string
27627
+ description: >-
27628
+ Permission slugs forming the ceiling on what sessions
27629
+ minted from this blueprint may do.
27630
+ example: &ref_19
27631
+ - crm:read
27632
+ - email:send
27633
+ invocable_by:
27634
+ type: object
27635
+ properties:
27636
+ role_slugs:
27637
+ type: array
27638
+ items:
27639
+ type: string
27640
+ description: >-
27641
+ Role slugs whose members may mint user-delegated
27642
+ sessions from this blueprint.
27643
+ example: &ref_20
27644
+ - manager
27645
+ organization_ids:
27646
+ type: array
27647
+ items:
27648
+ type: string
27649
+ description: >-
27650
+ Organizations in which autonomous sessions may be
27651
+ minted from this blueprint.
27652
+ example: &ref_21
27653
+ - org_01EHWNCE74X7JSDV0X3SZ3KJNY
27654
+ required:
27655
+ - role_slugs
27656
+ - organization_ids
27657
+ description: Who may mint sessions from this blueprint.
27658
+ session_settings:
27659
+ type: object
27660
+ properties:
27661
+ max_age_seconds:
27662
+ type: number
27663
+ description: >-
27664
+ Maximum lifetime of a session in seconds; refreshes
27665
+ never extend a session past this.
27666
+ example: 3600
27667
+ access_token_ttl_seconds:
27668
+ type: number
27669
+ description: Lifetime of each minted access token in seconds.
27670
+ example: 300
27671
+ refresh_token_ttl_seconds:
27672
+ type: number
27673
+ description: Lifetime of each rotated refresh token in seconds.
27674
+ example: 3600
27675
+ required:
27676
+ - max_age_seconds
27677
+ - access_token_ttl_seconds
27678
+ - refresh_token_ttl_seconds
27679
+ description: >-
27680
+ Token and session lifetimes for sessions minted from
27681
+ this blueprint.
27682
+ created_at:
27683
+ type: string
27684
+ description: The timestamp when the agent blueprint was created.
27685
+ example: '2026-01-15T12:00:00.000Z'
27686
+ updated_at:
27687
+ type: string
27688
+ description: The timestamp when the agent blueprint was last updated.
27689
+ example: '2026-01-15T12:00:00.000Z'
27690
+ required:
27691
+ - object
27692
+ - id
27693
+ - name
27694
+ - description
27695
+ - permissions
27696
+ - invocable_by
27697
+ - session_settings
27698
+ - created_at
27699
+ - updated_at
27700
+ description: The event payload.
27701
+ created_at:
27702
+ format: date-time
27703
+ type: string
27704
+ description: An ISO 8601 timestamp.
27705
+ example: '2026-01-15T12:00:00.000Z'
27706
+ context:
27707
+ $ref: '#/components/schemas/EventContextDto'
27708
+ object:
27709
+ type: string
27710
+ description: Distinguishes the Event object.
27711
+ const: event
27712
+ required:
27713
+ - id
27714
+ - event
27715
+ - data
27716
+ - created_at
27717
+ - object
27718
+ - type: object
27719
+ properties:
27720
+ id:
27721
+ type: string
27722
+ description: Unique identifier for the event.
27723
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
27724
+ event:
27725
+ type: string
27726
+ const: agent.blueprint.deleted
27727
+ data:
27728
+ type: object
27729
+ properties:
27730
+ object:
27731
+ type: string
27732
+ description: Distinguishes the agent blueprint object.
27733
+ const: agent_blueprint
27734
+ id:
27735
+ type: string
27736
+ description: Unique identifier of the agent blueprint.
27737
+ example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
27738
+ name:
27739
+ type: string
27740
+ description: Human-readable name of the agent blueprint.
27741
+ example: Prospecting Agent
27742
+ created_at:
27743
+ type: string
27744
+ description: The timestamp when the agent blueprint was created.
27745
+ example: '2026-01-15T12:00:00.000Z'
27746
+ updated_at:
27747
+ type: string
27748
+ description: The timestamp when the agent blueprint was last updated.
27749
+ example: '2026-01-15T12:00:00.000Z'
27750
+ required:
27751
+ - object
27752
+ - id
27753
+ - name
27754
+ - created_at
27755
+ - updated_at
27756
+ description: The event payload.
27757
+ created_at:
27758
+ format: date-time
27759
+ type: string
27760
+ description: An ISO 8601 timestamp.
27761
+ example: '2026-01-15T12:00:00.000Z'
27762
+ context:
27763
+ $ref: '#/components/schemas/EventContextDto'
27764
+ object:
27765
+ type: string
27766
+ description: Distinguishes the Event object.
27767
+ const: event
27768
+ required:
27769
+ - id
27770
+ - event
27771
+ - data
27772
+ - created_at
27773
+ - object
27774
+ - type: object
27775
+ properties:
27776
+ id:
27777
+ type: string
27778
+ description: Unique identifier for the event.
27779
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
27780
+ event:
27781
+ type: string
27782
+ const: agent.blueprint.updated
27783
+ data:
27784
+ type: object
27785
+ properties:
27786
+ object:
27787
+ type: string
27788
+ description: Distinguishes the agent blueprint object.
27789
+ const: agent_blueprint
27790
+ id:
27791
+ type: string
27792
+ description: Unique identifier of the agent blueprint.
27793
+ example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
27794
+ name:
27795
+ type: string
27796
+ description: Human-readable name of the agent blueprint.
27797
+ example: Prospecting Agent
27798
+ description:
27799
+ type:
27800
+ - string
27801
+ - 'null'
27802
+ description: Human-readable description of the agent blueprint.
27803
+ example: Finds and qualifies sales prospects.
27804
+ permissions:
27805
+ type: array
27806
+ items:
27807
+ type: string
27808
+ description: >-
27809
+ Permission slugs forming the ceiling on what sessions
27810
+ minted from this blueprint may do.
27811
+ example: *ref_19
27812
+ invocable_by:
27813
+ type: object
27814
+ properties:
27815
+ role_slugs:
27816
+ type: array
27817
+ items:
27818
+ type: string
27819
+ description: >-
27820
+ Role slugs whose members may mint user-delegated
27821
+ sessions from this blueprint.
27822
+ example: *ref_20
27823
+ organization_ids:
27824
+ type: array
27825
+ items:
27826
+ type: string
27827
+ description: >-
27828
+ Organizations in which autonomous sessions may be
27829
+ minted from this blueprint.
27830
+ example: *ref_21
27831
+ required:
27832
+ - role_slugs
27833
+ - organization_ids
27834
+ description: Who may mint sessions from this blueprint.
27835
+ session_settings:
27836
+ type: object
27837
+ properties:
27838
+ max_age_seconds:
27839
+ type: number
27840
+ description: >-
27841
+ Maximum lifetime of a session in seconds; refreshes
27842
+ never extend a session past this.
27843
+ example: 3600
27844
+ access_token_ttl_seconds:
27845
+ type: number
27846
+ description: Lifetime of each minted access token in seconds.
27847
+ example: 300
27848
+ refresh_token_ttl_seconds:
27849
+ type: number
27850
+ description: Lifetime of each rotated refresh token in seconds.
27851
+ example: 3600
27852
+ required:
27853
+ - max_age_seconds
27854
+ - access_token_ttl_seconds
27855
+ - refresh_token_ttl_seconds
27856
+ description: >-
27857
+ Token and session lifetimes for sessions minted from
27858
+ this blueprint.
27859
+ created_at:
27860
+ type: string
27861
+ description: The timestamp when the agent blueprint was created.
27862
+ example: '2026-01-15T12:00:00.000Z'
27863
+ updated_at:
27864
+ type: string
27865
+ description: The timestamp when the agent blueprint was last updated.
27866
+ example: '2026-01-15T12:00:00.000Z'
27867
+ required:
27868
+ - object
27869
+ - id
27870
+ - name
27871
+ - description
27872
+ - permissions
27873
+ - invocable_by
27874
+ - session_settings
27875
+ - created_at
27876
+ - updated_at
27877
+ description: The event payload.
27878
+ created_at:
27879
+ format: date-time
27880
+ type: string
27881
+ description: An ISO 8601 timestamp.
27882
+ example: '2026-01-15T12:00:00.000Z'
27883
+ context:
27884
+ $ref: '#/components/schemas/EventContextDto'
27885
+ object:
27886
+ type: string
27887
+ description: Distinguishes the Event object.
27888
+ const: event
27889
+ required:
27890
+ - id
27891
+ - event
27892
+ - data
27893
+ - created_at
27894
+ - object
27580
27895
  - type: object
27581
27896
  properties:
27582
27897
  id:
@@ -28230,7 +28545,7 @@ components:
28230
28545
  items:
28231
28546
  type: string
28232
28547
  description: The permissions granted to the API key.
28233
- example: &ref_19
28548
+ example: &ref_22
28234
28549
  - users:read
28235
28550
  - users:write
28236
28551
  created_at:
@@ -28356,7 +28671,7 @@ components:
28356
28671
  items:
28357
28672
  type: string
28358
28673
  description: The permissions granted to the API key.
28359
- example: *ref_19
28674
+ example: *ref_22
28360
28675
  created_at:
28361
28676
  type: string
28362
28677
  description: The timestamp when the API key was created.
@@ -28480,7 +28795,7 @@ components:
28480
28795
  items:
28481
28796
  type: string
28482
28797
  description: The permissions granted to the API key.
28483
- example: *ref_19
28798
+ example: *ref_22
28484
28799
  created_at:
28485
28800
  type: string
28486
28801
  description: The timestamp when the API key was created.
@@ -31347,7 +31662,7 @@ components:
31347
31662
  description: >-
31348
31663
  An object containing the custom attribute mapping for
31349
31664
  the Directory Provider.
31350
- example: *ref_20
31665
+ example: *ref_23
31351
31666
  role:
31352
31667
  $ref: '#/components/schemas/SlimRole'
31353
31668
  roles:
@@ -31537,7 +31852,7 @@ components:
31537
31852
  description: >-
31538
31853
  Labels assigned to the Feature Flag for categorizing and
31539
31854
  filtering.
31540
- example: &ref_21
31855
+ example: &ref_24
31541
31856
  - reports
31542
31857
  enabled:
31543
31858
  type: boolean
@@ -31698,7 +32013,7 @@ components:
31698
32013
  description: >-
31699
32014
  Labels assigned to the Feature Flag for categorizing and
31700
32015
  filtering.
31701
- example: *ref_21
32016
+ example: *ref_24
31702
32017
  enabled:
31703
32018
  type: boolean
31704
32019
  description: >-
@@ -31858,7 +32173,7 @@ components:
31858
32173
  description: >-
31859
32174
  Labels assigned to the Feature Flag for categorizing and
31860
32175
  filtering.
31861
- example: *ref_21
32176
+ example: *ref_24
31862
32177
  enabled:
31863
32178
  type: boolean
31864
32179
  description: >-
@@ -32138,7 +32453,7 @@ components:
32138
32453
  description: >-
32139
32454
  Labels assigned to the Feature Flag for categorizing and
32140
32455
  filtering.
32141
- example: *ref_21
32456
+ example: *ref_24
32142
32457
  enabled:
32143
32458
  type: boolean
32144
32459
  description: >-
@@ -33126,7 +33441,7 @@ components:
33126
33441
  description: >-
33127
33442
  Object containing [metadata](/authkit/metadata)
33128
33443
  key/value pairs associated with the Organization.
33129
- example: &ref_22
33444
+ example: &ref_25
33130
33445
  tier: diamond
33131
33446
  propertyNames:
33132
33447
  maxLength: 40
@@ -33276,7 +33591,7 @@ components:
33276
33591
  description: >-
33277
33592
  Object containing [metadata](/authkit/metadata)
33278
33593
  key/value pairs associated with the Organization.
33279
- example: *ref_22
33594
+ example: *ref_25
33280
33595
  propertyNames:
33281
33596
  maxLength: 40
33282
33597
  maxProperties: 50
@@ -34103,7 +34418,7 @@ components:
34103
34418
  items:
34104
34419
  type: string
34105
34420
  description: The permissions granted by the role.
34106
- example: &ref_23
34421
+ example: &ref_26
34107
34422
  - users:read
34108
34423
  - users:write
34109
34424
  created_at:
@@ -34187,7 +34502,7 @@ components:
34187
34502
  items:
34188
34503
  type: string
34189
34504
  description: The permissions granted by the role.
34190
- example: *ref_23
34505
+ example: *ref_26
34191
34506
  created_at:
34192
34507
  format: date-time
34193
34508
  type: string
@@ -34269,7 +34584,7 @@ components:
34269
34584
  items:
34270
34585
  type: string
34271
34586
  description: The permissions granted by the role.
34272
- example: *ref_23
34587
+ example: *ref_26
34273
34588
  created_at:
34274
34589
  format: date-time
34275
34590
  type: string
@@ -34406,7 +34721,7 @@ components:
34406
34721
  description: >-
34407
34722
  Object containing [metadata](/authkit/metadata)
34408
34723
  key/value pairs associated with the Organization.
34409
- example: *ref_22
34724
+ example: *ref_25
34410
34725
  propertyNames:
34411
34726
  maxLength: 40
34412
34727
  maxProperties: 50
@@ -35060,6 +35375,190 @@ components:
35060
35375
  - data
35061
35376
  - created_at
35062
35377
  - object
35378
+ - type: object
35379
+ properties:
35380
+ id:
35381
+ type: string
35382
+ description: Unique identifier for the event.
35383
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
35384
+ event:
35385
+ type: string
35386
+ const: resource_export.completed
35387
+ data:
35388
+ type: object
35389
+ properties:
35390
+ id:
35391
+ type: string
35392
+ description: The ID of the resource export.
35393
+ example: resource_export_01HWZBQZY2M3AMQW166Q22K88F
35394
+ resource_type:
35395
+ type: string
35396
+ enum:
35397
+ - users
35398
+ - organizations
35399
+ - events
35400
+ - sessions
35401
+ description: The type of resource being exported.
35402
+ example: users
35403
+ required:
35404
+ - id
35405
+ - resource_type
35406
+ description: The event payload.
35407
+ created_at:
35408
+ format: date-time
35409
+ type: string
35410
+ description: An ISO 8601 timestamp.
35411
+ example: '2026-01-15T12:00:00.000Z'
35412
+ context:
35413
+ $ref: '#/components/schemas/EventContextDto'
35414
+ object:
35415
+ type: string
35416
+ description: Distinguishes the Event object.
35417
+ const: event
35418
+ required:
35419
+ - id
35420
+ - event
35421
+ - data
35422
+ - created_at
35423
+ - object
35424
+ - type: object
35425
+ properties:
35426
+ id:
35427
+ type: string
35428
+ description: Unique identifier for the event.
35429
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
35430
+ event:
35431
+ type: string
35432
+ const: resource_export.created
35433
+ data:
35434
+ type: object
35435
+ properties:
35436
+ id:
35437
+ type: string
35438
+ description: The ID of the resource export.
35439
+ example: resource_export_01HWZBQZY2M3AMQW166Q22K88F
35440
+ resource_type:
35441
+ type: string
35442
+ enum:
35443
+ - users
35444
+ - organizations
35445
+ - events
35446
+ - sessions
35447
+ description: The type of resource being exported.
35448
+ example: users
35449
+ required:
35450
+ - id
35451
+ - resource_type
35452
+ description: The event payload.
35453
+ created_at:
35454
+ format: date-time
35455
+ type: string
35456
+ description: An ISO 8601 timestamp.
35457
+ example: '2026-01-15T12:00:00.000Z'
35458
+ context:
35459
+ $ref: '#/components/schemas/EventContextDto'
35460
+ object:
35461
+ type: string
35462
+ description: Distinguishes the Event object.
35463
+ const: event
35464
+ required:
35465
+ - id
35466
+ - event
35467
+ - data
35468
+ - created_at
35469
+ - object
35470
+ - type: object
35471
+ properties:
35472
+ id:
35473
+ type: string
35474
+ description: Unique identifier for the event.
35475
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
35476
+ event:
35477
+ type: string
35478
+ const: resource_export.downloaded
35479
+ data:
35480
+ type: object
35481
+ properties:
35482
+ id:
35483
+ type: string
35484
+ description: The ID of the resource export.
35485
+ example: resource_export_01HWZBQZY2M3AMQW166Q22K88F
35486
+ resource_type:
35487
+ type: string
35488
+ enum:
35489
+ - users
35490
+ - organizations
35491
+ - events
35492
+ - sessions
35493
+ description: The type of resource being exported.
35494
+ example: users
35495
+ required:
35496
+ - id
35497
+ - resource_type
35498
+ description: The event payload.
35499
+ created_at:
35500
+ format: date-time
35501
+ type: string
35502
+ description: An ISO 8601 timestamp.
35503
+ example: '2026-01-15T12:00:00.000Z'
35504
+ context:
35505
+ $ref: '#/components/schemas/EventContextDto'
35506
+ object:
35507
+ type: string
35508
+ description: Distinguishes the Event object.
35509
+ const: event
35510
+ required:
35511
+ - id
35512
+ - event
35513
+ - data
35514
+ - created_at
35515
+ - object
35516
+ - type: object
35517
+ properties:
35518
+ id:
35519
+ type: string
35520
+ description: Unique identifier for the event.
35521
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
35522
+ event:
35523
+ type: string
35524
+ const: resource_export.failed
35525
+ data:
35526
+ type: object
35527
+ properties:
35528
+ id:
35529
+ type: string
35530
+ description: The ID of the resource export.
35531
+ example: resource_export_01HWZBQZY2M3AMQW166Q22K88F
35532
+ resource_type:
35533
+ type: string
35534
+ enum:
35535
+ - users
35536
+ - organizations
35537
+ - events
35538
+ - sessions
35539
+ description: The type of resource being exported.
35540
+ example: users
35541
+ required:
35542
+ - id
35543
+ - resource_type
35544
+ description: The event payload.
35545
+ created_at:
35546
+ format: date-time
35547
+ type: string
35548
+ description: An ISO 8601 timestamp.
35549
+ example: '2026-01-15T12:00:00.000Z'
35550
+ context:
35551
+ $ref: '#/components/schemas/EventContextDto'
35552
+ object:
35553
+ type: string
35554
+ description: Distinguishes the Event object.
35555
+ const: event
35556
+ required:
35557
+ - id
35558
+ - event
35559
+ - data
35560
+ - created_at
35561
+ - object
35063
35562
  - type: object
35064
35563
  properties:
35065
35564
  id:
@@ -35089,7 +35588,7 @@ components:
35089
35588
  items:
35090
35589
  type: string
35091
35590
  description: The permissions granted by the role.
35092
- example: &ref_24
35591
+ example: &ref_27
35093
35592
  - users:read
35094
35593
  - users:write
35095
35594
  created_at:
@@ -35155,7 +35654,7 @@ components:
35155
35654
  items:
35156
35655
  type: string
35157
35656
  description: The permissions granted by the role.
35158
- example: *ref_24
35657
+ example: *ref_27
35159
35658
  created_at:
35160
35659
  format: date-time
35161
35660
  type: string
@@ -35219,7 +35718,7 @@ components:
35219
35718
  items:
35220
35719
  type: string
35221
35720
  description: The permissions granted by the role.
35222
- example: *ref_24
35721
+ example: *ref_27
35223
35722
  created_at:
35224
35723
  format: date-time
35225
35724
  type: string
@@ -36359,7 +36858,7 @@ components:
36359
36858
  - data
36360
36859
  - created_at
36361
36860
  - object
36362
- example: *ref_25
36861
+ example: *ref_28
36363
36862
  description: An event emitted by WorkOS.
36364
36863
  EventList:
36365
36864
  type: object
@@ -36394,7 +36893,7 @@ components:
36394
36893
  example:
36395
36894
  object: list
36396
36895
  data:
36397
- - *ref_25
36896
+ - *ref_28
36398
36897
  list_metadata:
36399
36898
  after: event_01EHZNVPK3SFK441A1RGBFSHRT
36400
36899
  JwtTemplate:
@@ -37388,7 +37887,9 @@ components:
37388
37887
  type: string
37389
37888
  description: >-
37390
37889
  The OAuth redirect URI to register with the provider when
37391
- configuring the custom application.
37890
+ configuring the custom application. Empty for `api_key` and
37891
+ `client_credentials` integrations, which run no authorization
37892
+ redirect.
37392
37893
  example: >-
37393
37894
  https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback
37394
37895
  auth_methods:
@@ -37407,8 +37908,8 @@ components:
37407
37908
  credentials:
37408
37909
  description: >-
37409
37910
  The integration-level OAuth app credentials. `null` for `api_key`
37410
- integrations, which hold no OAuth credentials (keys are installed
37411
- per-tenant).
37911
+ and `client_credentials` integrations, which hold no
37912
+ integration-level credentials (secrets are installed per-tenant).
37412
37913
  oneOf:
37413
37914
  - type: object
37414
37915
  properties:
@@ -37903,7 +38404,11 @@ components:
37903
38404
  type: string
37904
38405
  description: >-
37905
38406
  If the integration has requested scopes that aren't present
37906
- on the access token, they're listed here.
38407
+ on the access token, they're listed here. The scopes granted
38408
+ to a client-credentials token are governed by the connected
38409
+ organization's client application, so the integration's
38410
+ configured scopes are requests or defaults rather than
38411
+ guarantees.
37907
38412
  example: []
37908
38413
  metadata:
37909
38414
  type: object