@workos/openapi-spec 0.104.0 → 0.106.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.
- package/README.md +25 -0
- package/dist/open-api-spec.yaml +152 -37
- package/dist/types.d.ts +74 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -160,6 +160,31 @@ node scripts/sdk-compat-pr-comment.mjs \
|
|
|
160
160
|
|
|
161
161
|
Changes to any file under `src/policy/` (or to `operationOverrides.node.json` or `tsdown.config.ts`) trigger a new release of `@workos/openapi-spec` the same way changes to the spec YAML do — see the publish workflow at `.github/workflows/release.yml`.
|
|
162
162
|
|
|
163
|
+
### Automatic sync conflict resolution
|
|
164
|
+
|
|
165
|
+
`.github/workflows/resolve-sync-conflicts.yml` keeps autogenerated spec PRs
|
|
166
|
+
mergeable when their only conflict is `.last-synced-sha`. It compares the two
|
|
167
|
+
source commits in `workos/workos`, keeps the descendant SHA, and merges `main`
|
|
168
|
+
into the PR with a GitHub-signed bot commit. Other conflicts and divergent source
|
|
169
|
+
history still require manual review; SDK validation and approval requirements
|
|
170
|
+
are unchanged.
|
|
171
|
+
|
|
172
|
+
The workflow runs trusted code from `main`, never PR code. The existing SDK bot
|
|
173
|
+
App needs contents write and PR read access to this repository, plus contents
|
|
174
|
+
read access to `workos/workos`. Its branch updates trigger SDK validation again.
|
|
175
|
+
|
|
176
|
+
Preview locally with an authenticated `gh` that can read both repositories:
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
node scripts/resolve-sync-conflicts.mjs --pr 184
|
|
180
|
+
node --test scripts/__tests__/resolve-sync-conflicts.spec.mjs
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
The script is read-only on GitHub unless `--write` is supplied; writes require a
|
|
184
|
+
bot installation token so GitHub can sign the merge commit. Manual workflow runs
|
|
185
|
+
also default to dry-run. A new `pull_request_target` workflow must land on `main`
|
|
186
|
+
before it can resolve PRs automatically; local previews work before then.
|
|
187
|
+
|
|
163
188
|
## Grabbing from npm
|
|
164
189
|
|
|
165
190
|
The spec is published to npm as [`@workos/openapi-spec`](https://www.npmjs.com/package/@workos/openapi-spec).
|
package/dist/open-api-spec.yaml
CHANGED
|
@@ -73,6 +73,34 @@ paths:
|
|
|
73
73
|
example:
|
|
74
74
|
- org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
75
75
|
description: Who may mint sessions from this blueprint.
|
|
76
|
+
invocable_as:
|
|
77
|
+
default: {}
|
|
78
|
+
type: object
|
|
79
|
+
properties:
|
|
80
|
+
instance_types:
|
|
81
|
+
default:
|
|
82
|
+
- delegated
|
|
83
|
+
- autonomous
|
|
84
|
+
type: array
|
|
85
|
+
items:
|
|
86
|
+
type: string
|
|
87
|
+
enum:
|
|
88
|
+
- delegated
|
|
89
|
+
- autonomous
|
|
90
|
+
minItems: 1
|
|
91
|
+
maxItems: 2
|
|
92
|
+
description: >-
|
|
93
|
+
Instance types that may be minted from this blueprint:
|
|
94
|
+
`delegated` (a user-delegated session, minted with a
|
|
95
|
+
user access token) and/or `autonomous` (a session acting
|
|
96
|
+
as the agent itself, minted with an agent registration
|
|
97
|
+
credential). Agent-delegated chaining and refreshes are
|
|
98
|
+
checked against the type of the presenting instance.
|
|
99
|
+
Defaults to both.
|
|
100
|
+
example:
|
|
101
|
+
- delegated
|
|
102
|
+
- autonomous
|
|
103
|
+
description: How sessions may be minted from this blueprint.
|
|
76
104
|
session_settings:
|
|
77
105
|
default:
|
|
78
106
|
max_age_seconds: 3600
|
|
@@ -442,6 +470,29 @@ paths:
|
|
|
442
470
|
description: >-
|
|
443
471
|
Who may mint sessions from this blueprint. Omitted lists are
|
|
444
472
|
left unchanged.
|
|
473
|
+
invocable_as:
|
|
474
|
+
type: object
|
|
475
|
+
properties:
|
|
476
|
+
instance_types:
|
|
477
|
+
type: array
|
|
478
|
+
items:
|
|
479
|
+
type: string
|
|
480
|
+
enum:
|
|
481
|
+
- delegated
|
|
482
|
+
- autonomous
|
|
483
|
+
minItems: 1
|
|
484
|
+
maxItems: 2
|
|
485
|
+
description: >-
|
|
486
|
+
Instance types that may be minted from this blueprint:
|
|
487
|
+
`delegated` and/or `autonomous`. At least one is
|
|
488
|
+
required; existing sessions of a removed type are
|
|
489
|
+
refused at their next refresh.
|
|
490
|
+
example:
|
|
491
|
+
- delegated
|
|
492
|
+
- autonomous
|
|
493
|
+
description: >-
|
|
494
|
+
How sessions may be minted from this blueprint. Omitted
|
|
495
|
+
lists are left unchanged.
|
|
445
496
|
session_settings:
|
|
446
497
|
type: object
|
|
447
498
|
properties:
|
|
@@ -947,6 +998,20 @@ paths:
|
|
|
947
998
|
required:
|
|
948
999
|
- code
|
|
949
1000
|
- message
|
|
1001
|
+
- type: object
|
|
1002
|
+
properties:
|
|
1003
|
+
code:
|
|
1004
|
+
type: string
|
|
1005
|
+
description: The error code identifying the type of error.
|
|
1006
|
+
example: unsupported_invocation_type
|
|
1007
|
+
const: unsupported_invocation_type
|
|
1008
|
+
message:
|
|
1009
|
+
type: string
|
|
1010
|
+
description: A human-readable description of the error.
|
|
1011
|
+
example: Request could not be processed.
|
|
1012
|
+
required:
|
|
1013
|
+
- code
|
|
1014
|
+
- message
|
|
950
1015
|
- type: object
|
|
951
1016
|
properties:
|
|
952
1017
|
code:
|
|
@@ -10407,7 +10472,6 @@ paths:
|
|
|
10407
10472
|
summary: Create a data integration
|
|
10408
10473
|
tags:
|
|
10409
10474
|
- pipes
|
|
10410
|
-
x-feature-flag: pipes-management-api
|
|
10411
10475
|
get:
|
|
10412
10476
|
description: >-
|
|
10413
10477
|
Lists the environment's data integrations configured with `custom` or
|
|
@@ -10516,7 +10580,6 @@ paths:
|
|
|
10516
10580
|
summary: List data integrations
|
|
10517
10581
|
tags:
|
|
10518
10582
|
- pipes
|
|
10519
|
-
x-feature-flag: pipes-management-api
|
|
10520
10583
|
/data-integrations/{slug}:
|
|
10521
10584
|
get:
|
|
10522
10585
|
description: Retrieves the user-owned data integration by its slug.
|
|
@@ -10554,7 +10617,6 @@ paths:
|
|
|
10554
10617
|
summary: Get a data integration
|
|
10555
10618
|
tags:
|
|
10556
10619
|
- pipes
|
|
10557
|
-
x-feature-flag: pipes-management-api
|
|
10558
10620
|
put:
|
|
10559
10621
|
description: >-
|
|
10560
10622
|
Updates the description, enabled state, or custom credentials of the
|
|
@@ -10654,7 +10716,6 @@ paths:
|
|
|
10654
10716
|
summary: Update a data integration
|
|
10655
10717
|
tags:
|
|
10656
10718
|
- pipes
|
|
10657
|
-
x-feature-flag: pipes-management-api
|
|
10658
10719
|
delete:
|
|
10659
10720
|
description: >-
|
|
10660
10721
|
Deletes the user-owned data integration and all of its connected
|
|
@@ -10690,7 +10751,6 @@ paths:
|
|
|
10690
10751
|
summary: Delete a data integration
|
|
10691
10752
|
tags:
|
|
10692
10753
|
- pipes
|
|
10693
|
-
x-feature-flag: pipes-management-api
|
|
10694
10754
|
/data-integrations/{slug}/api-key:
|
|
10695
10755
|
put:
|
|
10696
10756
|
description: >-
|
|
@@ -11351,7 +11411,6 @@ paths:
|
|
|
11351
11411
|
summary: Get an organization-owned data integration
|
|
11352
11412
|
tags:
|
|
11353
11413
|
- pipes
|
|
11354
|
-
x-feature-flag: pipes-management-api
|
|
11355
11414
|
put:
|
|
11356
11415
|
description: >-
|
|
11357
11416
|
Updates the description, enabled state, or custom credentials of the
|
|
@@ -11490,7 +11549,6 @@ paths:
|
|
|
11490
11549
|
summary: Update an organization-owned data integration
|
|
11491
11550
|
tags:
|
|
11492
11551
|
- pipes
|
|
11493
|
-
x-feature-flag: pipes-management-api
|
|
11494
11552
|
delete:
|
|
11495
11553
|
description: >-
|
|
11496
11554
|
Deletes the organization-owned data integration for a provider and all
|
|
@@ -11528,7 +11586,6 @@ paths:
|
|
|
11528
11586
|
summary: Delete an organization-owned data integration
|
|
11529
11587
|
tags:
|
|
11530
11588
|
- pipes
|
|
11531
|
-
x-feature-flag: pipes-management-api
|
|
11532
11589
|
/data-integrations/{slug}/token:
|
|
11533
11590
|
post:
|
|
11534
11591
|
description: >-
|
|
@@ -15151,7 +15208,7 @@ paths:
|
|
|
15151
15208
|
summary: Import an organization connected account
|
|
15152
15209
|
tags:
|
|
15153
15210
|
- organizations.data-providers
|
|
15154
|
-
x-feature-flag: pipes-
|
|
15211
|
+
x-feature-flag: pipes-org-integrations
|
|
15155
15212
|
put:
|
|
15156
15213
|
description: >-
|
|
15157
15214
|
Updates an organization's [connected
|
|
@@ -15319,7 +15376,7 @@ paths:
|
|
|
15319
15376
|
summary: Update an organization connected account
|
|
15320
15377
|
tags:
|
|
15321
15378
|
- organizations.data-providers
|
|
15322
|
-
x-feature-flag: pipes-
|
|
15379
|
+
x-feature-flag: pipes-org-integrations
|
|
15323
15380
|
/organizations/{organization_id}/data_providers:
|
|
15324
15381
|
get:
|
|
15325
15382
|
description: >-
|
|
@@ -23903,7 +23960,6 @@ paths:
|
|
|
23903
23960
|
summary: Import a connected account
|
|
23904
23961
|
tags:
|
|
23905
23962
|
- user-management.data-providers
|
|
23906
|
-
x-feature-flag: pipes-management-api
|
|
23907
23963
|
put:
|
|
23908
23964
|
description: >-
|
|
23909
23965
|
Updates a user's [connected account](/reference/pipes/connected-account)
|
|
@@ -24084,7 +24140,6 @@ paths:
|
|
|
24084
24140
|
summary: Update a connected account
|
|
24085
24141
|
tags:
|
|
24086
24142
|
- user-management.data-providers
|
|
24087
|
-
x-feature-flag: pipes-management-api
|
|
24088
24143
|
/user_management/users/{user_id}/data_providers:
|
|
24089
24144
|
get:
|
|
24090
24145
|
description: >-
|
|
@@ -30158,6 +30213,25 @@ components:
|
|
|
30158
30213
|
- role_slugs
|
|
30159
30214
|
- organization_ids
|
|
30160
30215
|
description: Who may mint sessions from this blueprint.
|
|
30216
|
+
invocable_as:
|
|
30217
|
+
type: object
|
|
30218
|
+
properties:
|
|
30219
|
+
instance_types:
|
|
30220
|
+
type: array
|
|
30221
|
+
items:
|
|
30222
|
+
type: string
|
|
30223
|
+
enum:
|
|
30224
|
+
- delegated
|
|
30225
|
+
- autonomous
|
|
30226
|
+
description: >-
|
|
30227
|
+
Instance types that may be minted from this blueprint:
|
|
30228
|
+
`delegated` and/or `autonomous`.
|
|
30229
|
+
example:
|
|
30230
|
+
- delegated
|
|
30231
|
+
- autonomous
|
|
30232
|
+
required:
|
|
30233
|
+
- instance_types
|
|
30234
|
+
description: How sessions may be minted from this blueprint.
|
|
30161
30235
|
session_settings:
|
|
30162
30236
|
type: object
|
|
30163
30237
|
properties:
|
|
@@ -30197,6 +30271,7 @@ components:
|
|
|
30197
30271
|
- description
|
|
30198
30272
|
- permissions
|
|
30199
30273
|
- invocable_by
|
|
30274
|
+
- invocable_as
|
|
30200
30275
|
- session_settings
|
|
30201
30276
|
- created_at
|
|
30202
30277
|
- updated_at
|
|
@@ -33060,7 +33135,7 @@ components:
|
|
|
33060
33135
|
description: >-
|
|
33061
33136
|
An object containing the custom attribute mapping for the Directory
|
|
33062
33137
|
Provider.
|
|
33063
|
-
example: &
|
|
33138
|
+
example: &ref_32
|
|
33064
33139
|
department: Engineering
|
|
33065
33140
|
job_title: Software Engineer
|
|
33066
33141
|
role:
|
|
@@ -33334,7 +33409,7 @@ components:
|
|
|
33334
33409
|
- data
|
|
33335
33410
|
- created_at
|
|
33336
33411
|
description: An event emitted by WorkOS.
|
|
33337
|
-
example: &
|
|
33412
|
+
example: &ref_37
|
|
33338
33413
|
object: event
|
|
33339
33414
|
id: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
33340
33415
|
event: dsync.user.created
|
|
@@ -33566,6 +33641,26 @@ components:
|
|
|
33566
33641
|
- role_slugs
|
|
33567
33642
|
- organization_ids
|
|
33568
33643
|
description: Who may mint sessions from this blueprint.
|
|
33644
|
+
invocable_as:
|
|
33645
|
+
type: object
|
|
33646
|
+
properties:
|
|
33647
|
+
instance_types:
|
|
33648
|
+
type: array
|
|
33649
|
+
items:
|
|
33650
|
+
type: string
|
|
33651
|
+
enum:
|
|
33652
|
+
- delegated
|
|
33653
|
+
- autonomous
|
|
33654
|
+
description: >-
|
|
33655
|
+
Instance types that may be minted from this
|
|
33656
|
+
blueprint: `delegated` (acting for a user) and/or
|
|
33657
|
+
`autonomous` (acting as the agent itself).
|
|
33658
|
+
example: &ref_30
|
|
33659
|
+
- delegated
|
|
33660
|
+
- autonomous
|
|
33661
|
+
required:
|
|
33662
|
+
- instance_types
|
|
33663
|
+
description: How sessions may be minted from this blueprint.
|
|
33569
33664
|
session_settings:
|
|
33570
33665
|
type: object
|
|
33571
33666
|
properties:
|
|
@@ -33605,6 +33700,7 @@ components:
|
|
|
33605
33700
|
- description
|
|
33606
33701
|
- permissions
|
|
33607
33702
|
- invocable_by
|
|
33703
|
+
- invocable_as
|
|
33608
33704
|
- session_settings
|
|
33609
33705
|
- created_at
|
|
33610
33706
|
- updated_at
|
|
@@ -33743,6 +33839,24 @@ components:
|
|
|
33743
33839
|
- role_slugs
|
|
33744
33840
|
- organization_ids
|
|
33745
33841
|
description: Who may mint sessions from this blueprint.
|
|
33842
|
+
invocable_as:
|
|
33843
|
+
type: object
|
|
33844
|
+
properties:
|
|
33845
|
+
instance_types:
|
|
33846
|
+
type: array
|
|
33847
|
+
items:
|
|
33848
|
+
type: string
|
|
33849
|
+
enum:
|
|
33850
|
+
- delegated
|
|
33851
|
+
- autonomous
|
|
33852
|
+
description: >-
|
|
33853
|
+
Instance types that may be minted from this
|
|
33854
|
+
blueprint: `delegated` (acting for a user) and/or
|
|
33855
|
+
`autonomous` (acting as the agent itself).
|
|
33856
|
+
example: *ref_30
|
|
33857
|
+
required:
|
|
33858
|
+
- instance_types
|
|
33859
|
+
description: How sessions may be minted from this blueprint.
|
|
33746
33860
|
session_settings:
|
|
33747
33861
|
type: object
|
|
33748
33862
|
properties:
|
|
@@ -33782,6 +33896,7 @@ components:
|
|
|
33782
33896
|
- description
|
|
33783
33897
|
- permissions
|
|
33784
33898
|
- invocable_by
|
|
33899
|
+
- invocable_as
|
|
33785
33900
|
- session_settings
|
|
33786
33901
|
- created_at
|
|
33787
33902
|
- updated_at
|
|
@@ -34774,7 +34889,7 @@ components:
|
|
|
34774
34889
|
items:
|
|
34775
34890
|
type: string
|
|
34776
34891
|
description: The permissions granted to the API key.
|
|
34777
|
-
example: &
|
|
34892
|
+
example: &ref_31
|
|
34778
34893
|
- users:read
|
|
34779
34894
|
- users:write
|
|
34780
34895
|
created_at:
|
|
@@ -34900,7 +35015,7 @@ components:
|
|
|
34900
35015
|
items:
|
|
34901
35016
|
type: string
|
|
34902
35017
|
description: The permissions granted to the API key.
|
|
34903
|
-
example: *
|
|
35018
|
+
example: *ref_31
|
|
34904
35019
|
created_at:
|
|
34905
35020
|
type: string
|
|
34906
35021
|
description: The timestamp when the API key was created.
|
|
@@ -35024,7 +35139,7 @@ components:
|
|
|
35024
35139
|
items:
|
|
35025
35140
|
type: string
|
|
35026
35141
|
description: The permissions granted to the API key.
|
|
35027
|
-
example: *
|
|
35142
|
+
example: *ref_31
|
|
35028
35143
|
created_at:
|
|
35029
35144
|
type: string
|
|
35030
35145
|
description: The timestamp when the API key was created.
|
|
@@ -37891,7 +38006,7 @@ components:
|
|
|
37891
38006
|
description: >-
|
|
37892
38007
|
An object containing the custom attribute mapping for
|
|
37893
38008
|
the Directory Provider.
|
|
37894
|
-
example: *
|
|
38009
|
+
example: *ref_32
|
|
37895
38010
|
role:
|
|
37896
38011
|
$ref: '#/components/schemas/SlimRole'
|
|
37897
38012
|
roles:
|
|
@@ -38081,7 +38196,7 @@ components:
|
|
|
38081
38196
|
description: >-
|
|
38082
38197
|
Labels assigned to the Feature Flag for categorizing and
|
|
38083
38198
|
filtering.
|
|
38084
|
-
example: &
|
|
38199
|
+
example: &ref_33
|
|
38085
38200
|
- reports
|
|
38086
38201
|
enabled:
|
|
38087
38202
|
type: boolean
|
|
@@ -38242,7 +38357,7 @@ components:
|
|
|
38242
38357
|
description: >-
|
|
38243
38358
|
Labels assigned to the Feature Flag for categorizing and
|
|
38244
38359
|
filtering.
|
|
38245
|
-
example: *
|
|
38360
|
+
example: *ref_33
|
|
38246
38361
|
enabled:
|
|
38247
38362
|
type: boolean
|
|
38248
38363
|
description: >-
|
|
@@ -38402,7 +38517,7 @@ components:
|
|
|
38402
38517
|
description: >-
|
|
38403
38518
|
Labels assigned to the Feature Flag for categorizing and
|
|
38404
38519
|
filtering.
|
|
38405
|
-
example: *
|
|
38520
|
+
example: *ref_33
|
|
38406
38521
|
enabled:
|
|
38407
38522
|
type: boolean
|
|
38408
38523
|
description: >-
|
|
@@ -38682,7 +38797,7 @@ components:
|
|
|
38682
38797
|
description: >-
|
|
38683
38798
|
Labels assigned to the Feature Flag for categorizing and
|
|
38684
38799
|
filtering.
|
|
38685
|
-
example: *
|
|
38800
|
+
example: *ref_33
|
|
38686
38801
|
enabled:
|
|
38687
38802
|
type: boolean
|
|
38688
38803
|
description: >-
|
|
@@ -39670,7 +39785,7 @@ components:
|
|
|
39670
39785
|
description: >-
|
|
39671
39786
|
Object containing [metadata](/authkit/metadata)
|
|
39672
39787
|
key/value pairs associated with the Organization.
|
|
39673
|
-
example: &
|
|
39788
|
+
example: &ref_34
|
|
39674
39789
|
tier: diamond
|
|
39675
39790
|
propertyNames:
|
|
39676
39791
|
maxLength: 40
|
|
@@ -39820,7 +39935,7 @@ components:
|
|
|
39820
39935
|
description: >-
|
|
39821
39936
|
Object containing [metadata](/authkit/metadata)
|
|
39822
39937
|
key/value pairs associated with the Organization.
|
|
39823
|
-
example: *
|
|
39938
|
+
example: *ref_34
|
|
39824
39939
|
propertyNames:
|
|
39825
39940
|
maxLength: 40
|
|
39826
39941
|
maxProperties: 50
|
|
@@ -40647,7 +40762,7 @@ components:
|
|
|
40647
40762
|
items:
|
|
40648
40763
|
type: string
|
|
40649
40764
|
description: The permissions granted by the role.
|
|
40650
|
-
example: &
|
|
40765
|
+
example: &ref_35
|
|
40651
40766
|
- users:read
|
|
40652
40767
|
- users:write
|
|
40653
40768
|
created_at:
|
|
@@ -40731,7 +40846,7 @@ components:
|
|
|
40731
40846
|
items:
|
|
40732
40847
|
type: string
|
|
40733
40848
|
description: The permissions granted by the role.
|
|
40734
|
-
example: *
|
|
40849
|
+
example: *ref_35
|
|
40735
40850
|
created_at:
|
|
40736
40851
|
format: date-time
|
|
40737
40852
|
type: string
|
|
@@ -40813,7 +40928,7 @@ components:
|
|
|
40813
40928
|
items:
|
|
40814
40929
|
type: string
|
|
40815
40930
|
description: The permissions granted by the role.
|
|
40816
|
-
example: *
|
|
40931
|
+
example: *ref_35
|
|
40817
40932
|
created_at:
|
|
40818
40933
|
format: date-time
|
|
40819
40934
|
type: string
|
|
@@ -40950,7 +41065,7 @@ components:
|
|
|
40950
41065
|
description: >-
|
|
40951
41066
|
Object containing [metadata](/authkit/metadata)
|
|
40952
41067
|
key/value pairs associated with the Organization.
|
|
40953
|
-
example: *
|
|
41068
|
+
example: *ref_34
|
|
40954
41069
|
propertyNames:
|
|
40955
41070
|
maxLength: 40
|
|
40956
41071
|
maxProperties: 50
|
|
@@ -42146,7 +42261,7 @@ components:
|
|
|
42146
42261
|
items:
|
|
42147
42262
|
type: string
|
|
42148
42263
|
description: The permissions granted by the role.
|
|
42149
|
-
example: &
|
|
42264
|
+
example: &ref_36
|
|
42150
42265
|
- users:read
|
|
42151
42266
|
- users:write
|
|
42152
42267
|
created_at:
|
|
@@ -42212,7 +42327,7 @@ components:
|
|
|
42212
42327
|
items:
|
|
42213
42328
|
type: string
|
|
42214
42329
|
description: The permissions granted by the role.
|
|
42215
|
-
example: *
|
|
42330
|
+
example: *ref_36
|
|
42216
42331
|
created_at:
|
|
42217
42332
|
format: date-time
|
|
42218
42333
|
type: string
|
|
@@ -42276,7 +42391,7 @@ components:
|
|
|
42276
42391
|
items:
|
|
42277
42392
|
type: string
|
|
42278
42393
|
description: The permissions granted by the role.
|
|
42279
|
-
example: *
|
|
42394
|
+
example: *ref_36
|
|
42280
42395
|
created_at:
|
|
42281
42396
|
format: date-time
|
|
42282
42397
|
type: string
|
|
@@ -43416,7 +43531,7 @@ components:
|
|
|
43416
43531
|
- data
|
|
43417
43532
|
- created_at
|
|
43418
43533
|
- object
|
|
43419
|
-
example: *
|
|
43534
|
+
example: *ref_37
|
|
43420
43535
|
description: An event emitted by WorkOS.
|
|
43421
43536
|
EventList:
|
|
43422
43537
|
type: object
|
|
@@ -43451,7 +43566,7 @@ components:
|
|
|
43451
43566
|
example:
|
|
43452
43567
|
object: list
|
|
43453
43568
|
data:
|
|
43454
|
-
- *
|
|
43569
|
+
- *ref_37
|
|
43455
43570
|
list_metadata:
|
|
43456
43571
|
after: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
43457
43572
|
JwtTemplate:
|
|
@@ -45412,7 +45527,7 @@ components:
|
|
|
45412
45527
|
items:
|
|
45413
45528
|
type: string
|
|
45414
45529
|
description: The OAuth scopes granted for this connection.
|
|
45415
|
-
example: &
|
|
45530
|
+
example: &ref_38
|
|
45416
45531
|
- repo
|
|
45417
45532
|
- user:email
|
|
45418
45533
|
auth_method:
|
|
@@ -45462,7 +45577,7 @@ components:
|
|
|
45462
45577
|
`installation` scope, excluding any it declares as
|
|
45463
45578
|
secret. Only present when `auth_method` is
|
|
45464
45579
|
`client_credentials`.
|
|
45465
|
-
example: &
|
|
45580
|
+
example: &ref_39
|
|
45466
45581
|
instance_url: https://example.my.salesforce.com
|
|
45467
45582
|
state:
|
|
45468
45583
|
type: string
|
|
@@ -45591,7 +45706,7 @@ components:
|
|
|
45591
45706
|
items:
|
|
45592
45707
|
type: string
|
|
45593
45708
|
description: The OAuth scopes granted for this connection.
|
|
45594
|
-
example: *
|
|
45709
|
+
example: *ref_38
|
|
45595
45710
|
auth_method:
|
|
45596
45711
|
type: string
|
|
45597
45712
|
enum:
|
|
@@ -45638,7 +45753,7 @@ components:
|
|
|
45638
45753
|
`installation` scope, excluding any it declares as
|
|
45639
45754
|
secret. Only present when `auth_method` is
|
|
45640
45755
|
`client_credentials`.
|
|
45641
|
-
example: *
|
|
45756
|
+
example: *ref_39
|
|
45642
45757
|
state:
|
|
45643
45758
|
type: string
|
|
45644
45759
|
enum:
|
package/dist/types.d.ts
CHANGED
|
@@ -6737,6 +6737,17 @@ export interface components {
|
|
|
6737
6737
|
*/
|
|
6738
6738
|
organization_ids: string[];
|
|
6739
6739
|
};
|
|
6740
|
+
/** @description How sessions may be minted from this blueprint. */
|
|
6741
|
+
invocable_as: {
|
|
6742
|
+
/**
|
|
6743
|
+
* @description Instance types that may be minted from this blueprint: `delegated` and/or `autonomous`.
|
|
6744
|
+
* @example [
|
|
6745
|
+
* "delegated",
|
|
6746
|
+
* "autonomous"
|
|
6747
|
+
* ]
|
|
6748
|
+
*/
|
|
6749
|
+
instance_types: ("delegated" | "autonomous")[];
|
|
6750
|
+
};
|
|
6740
6751
|
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
6741
6752
|
session_settings: {
|
|
6742
6753
|
/**
|
|
@@ -9406,6 +9417,17 @@ export interface components {
|
|
|
9406
9417
|
*/
|
|
9407
9418
|
organization_ids: string[];
|
|
9408
9419
|
};
|
|
9420
|
+
/** @description How sessions may be minted from this blueprint. */
|
|
9421
|
+
invocable_as: {
|
|
9422
|
+
/**
|
|
9423
|
+
* @description Instance types that may be minted from this blueprint: `delegated` (acting for a user) and/or `autonomous` (acting as the agent itself).
|
|
9424
|
+
* @example [
|
|
9425
|
+
* "delegated",
|
|
9426
|
+
* "autonomous"
|
|
9427
|
+
* ]
|
|
9428
|
+
*/
|
|
9429
|
+
instance_types: ("delegated" | "autonomous")[];
|
|
9430
|
+
};
|
|
9409
9431
|
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
9410
9432
|
session_settings: {
|
|
9411
9433
|
/**
|
|
@@ -9550,6 +9572,17 @@ export interface components {
|
|
|
9550
9572
|
*/
|
|
9551
9573
|
organization_ids: string[];
|
|
9552
9574
|
};
|
|
9575
|
+
/** @description How sessions may be minted from this blueprint. */
|
|
9576
|
+
invocable_as: {
|
|
9577
|
+
/**
|
|
9578
|
+
* @description Instance types that may be minted from this blueprint: `delegated` (acting for a user) and/or `autonomous` (acting as the agent itself).
|
|
9579
|
+
* @example [
|
|
9580
|
+
* "delegated",
|
|
9581
|
+
* "autonomous"
|
|
9582
|
+
* ]
|
|
9583
|
+
*/
|
|
9584
|
+
instance_types: ("delegated" | "autonomous")[];
|
|
9585
|
+
};
|
|
9553
9586
|
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
9554
9587
|
session_settings: {
|
|
9555
9588
|
/**
|
|
@@ -20160,6 +20193,24 @@ export interface operations {
|
|
|
20160
20193
|
*/
|
|
20161
20194
|
organization_ids?: string[];
|
|
20162
20195
|
};
|
|
20196
|
+
/**
|
|
20197
|
+
* @description How sessions may be minted from this blueprint.
|
|
20198
|
+
* @default {}
|
|
20199
|
+
*/
|
|
20200
|
+
invocable_as?: {
|
|
20201
|
+
/**
|
|
20202
|
+
* @description Instance types that may be minted from this blueprint: `delegated` (a user-delegated session, minted with a user access token) and/or `autonomous` (a session acting as the agent itself, minted with an agent registration credential). Agent-delegated chaining and refreshes are checked against the type of the presenting instance. Defaults to both.
|
|
20203
|
+
* @default [
|
|
20204
|
+
* "delegated",
|
|
20205
|
+
* "autonomous"
|
|
20206
|
+
* ]
|
|
20207
|
+
* @example [
|
|
20208
|
+
* "delegated",
|
|
20209
|
+
* "autonomous"
|
|
20210
|
+
* ]
|
|
20211
|
+
*/
|
|
20212
|
+
instance_types?: ("delegated" | "autonomous")[];
|
|
20213
|
+
};
|
|
20163
20214
|
/**
|
|
20164
20215
|
* @description Token and session lifetimes for sessions minted from this blueprint.
|
|
20165
20216
|
* @default {
|
|
@@ -20408,6 +20459,17 @@ export interface operations {
|
|
|
20408
20459
|
*/
|
|
20409
20460
|
organization_ids?: string[];
|
|
20410
20461
|
};
|
|
20462
|
+
/** @description How sessions may be minted from this blueprint. Omitted lists are left unchanged. */
|
|
20463
|
+
invocable_as?: {
|
|
20464
|
+
/**
|
|
20465
|
+
* @description Instance types that may be minted from this blueprint: `delegated` and/or `autonomous`. At least one is required; existing sessions of a removed type are refused at their next refresh.
|
|
20466
|
+
* @example [
|
|
20467
|
+
* "delegated",
|
|
20468
|
+
* "autonomous"
|
|
20469
|
+
* ]
|
|
20470
|
+
*/
|
|
20471
|
+
instance_types?: ("delegated" | "autonomous")[];
|
|
20472
|
+
};
|
|
20411
20473
|
/** @description Token and session lifetimes for sessions minted from this blueprint. Omitted fields are left unchanged. */
|
|
20412
20474
|
session_settings?: {
|
|
20413
20475
|
/**
|
|
@@ -20790,6 +20852,18 @@ export interface operations {
|
|
|
20790
20852
|
* @example Request could not be processed.
|
|
20791
20853
|
*/
|
|
20792
20854
|
message: string;
|
|
20855
|
+
} | {
|
|
20856
|
+
/**
|
|
20857
|
+
* @description The error code identifying the type of error.
|
|
20858
|
+
* @example unsupported_invocation_type
|
|
20859
|
+
* @constant
|
|
20860
|
+
*/
|
|
20861
|
+
code: "unsupported_invocation_type";
|
|
20862
|
+
/**
|
|
20863
|
+
* @description A human-readable description of the error.
|
|
20864
|
+
* @example Request could not be processed.
|
|
20865
|
+
*/
|
|
20866
|
+
message: string;
|
|
20793
20867
|
} | {
|
|
20794
20868
|
/**
|
|
20795
20869
|
* @description The error code identifying the type of error.
|