@workos/openapi-spec 0.71.0 → 0.73.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/dist/open-api-spec.yaml +1841 -91
- package/dist/services.mjs +65 -0
- package/dist/types.d.ts +1745 -260
- package/package.json +3 -3
package/dist/open-api-spec.yaml
CHANGED
|
@@ -1,5 +1,980 @@
|
|
|
1
1
|
openapi: 3.1.1
|
|
2
2
|
paths:
|
|
3
|
+
/agents/blueprints:
|
|
4
|
+
post:
|
|
5
|
+
description: >-
|
|
6
|
+
Creates an agent blueprint: the template describing what an agent may do
|
|
7
|
+
(its permission ceiling), who may invoke it, and the lifetimes of its
|
|
8
|
+
sessions.
|
|
9
|
+
operationId: AgentBlueprintsController_create
|
|
10
|
+
parameters: []
|
|
11
|
+
requestBody:
|
|
12
|
+
required: true
|
|
13
|
+
content:
|
|
14
|
+
application/json:
|
|
15
|
+
schema:
|
|
16
|
+
type: object
|
|
17
|
+
properties:
|
|
18
|
+
name:
|
|
19
|
+
type: string
|
|
20
|
+
minLength: 1
|
|
21
|
+
maxLength: 255
|
|
22
|
+
description: Human-readable name of the agent blueprint.
|
|
23
|
+
example: Prospecting Agent
|
|
24
|
+
description:
|
|
25
|
+
type: string
|
|
26
|
+
minLength: 1
|
|
27
|
+
maxLength: 1000
|
|
28
|
+
description: Human-readable description of the agent blueprint.
|
|
29
|
+
example: Finds and qualifies sales prospects.
|
|
30
|
+
permissions:
|
|
31
|
+
default: []
|
|
32
|
+
type: array
|
|
33
|
+
items:
|
|
34
|
+
type: string
|
|
35
|
+
minLength: 1
|
|
36
|
+
maxItems: 1000
|
|
37
|
+
description: >-
|
|
38
|
+
Permission slugs forming the ceiling on what sessions minted
|
|
39
|
+
from this blueprint may do. Each slug must exist in the
|
|
40
|
+
environment.
|
|
41
|
+
example:
|
|
42
|
+
- crm:read
|
|
43
|
+
- email:send
|
|
44
|
+
invocable_by:
|
|
45
|
+
default: {}
|
|
46
|
+
type: object
|
|
47
|
+
properties:
|
|
48
|
+
role_slugs:
|
|
49
|
+
default: []
|
|
50
|
+
type: array
|
|
51
|
+
items:
|
|
52
|
+
type: string
|
|
53
|
+
minLength: 1
|
|
54
|
+
maxItems: 100
|
|
55
|
+
description: >-
|
|
56
|
+
Role slugs whose members may mint user-delegated
|
|
57
|
+
sessions from this blueprint. An empty list allows any
|
|
58
|
+
member.
|
|
59
|
+
example:
|
|
60
|
+
- manager
|
|
61
|
+
organization_ids:
|
|
62
|
+
default: []
|
|
63
|
+
type: array
|
|
64
|
+
items:
|
|
65
|
+
type: string
|
|
66
|
+
minLength: 1
|
|
67
|
+
maxItems: 1000
|
|
68
|
+
description: >-
|
|
69
|
+
Organizations in which sessions may be minted from this
|
|
70
|
+
blueprint, enforced on user-delegated, autonomous, and
|
|
71
|
+
agent-delegated mints. An empty list allows any
|
|
72
|
+
organization in the environment.
|
|
73
|
+
example:
|
|
74
|
+
- org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
75
|
+
description: Who may mint sessions from this blueprint.
|
|
76
|
+
session_settings:
|
|
77
|
+
type: object
|
|
78
|
+
properties:
|
|
79
|
+
max_age_seconds:
|
|
80
|
+
type: integer
|
|
81
|
+
exclusiveMinimum: 0
|
|
82
|
+
maximum: 31536000
|
|
83
|
+
description: >-
|
|
84
|
+
Maximum lifetime of a session in seconds; refreshes
|
|
85
|
+
never extend a session past this. At most 31,536,000
|
|
86
|
+
(365 days).
|
|
87
|
+
example: 3600
|
|
88
|
+
access_token_ttl_seconds:
|
|
89
|
+
type: integer
|
|
90
|
+
exclusiveMinimum: 0
|
|
91
|
+
maximum: 3600
|
|
92
|
+
description: >-
|
|
93
|
+
Lifetime of each minted access token in seconds. At most
|
|
94
|
+
3,600 (1 hour).
|
|
95
|
+
example: 300
|
|
96
|
+
refresh_token_ttl_seconds:
|
|
97
|
+
type: integer
|
|
98
|
+
exclusiveMinimum: 0
|
|
99
|
+
maximum: 5184000
|
|
100
|
+
description: >-
|
|
101
|
+
Lifetime of each rotated refresh token in seconds. At
|
|
102
|
+
most 5,184,000 (60 days).
|
|
103
|
+
example: 3600
|
|
104
|
+
required:
|
|
105
|
+
- max_age_seconds
|
|
106
|
+
- access_token_ttl_seconds
|
|
107
|
+
- refresh_token_ttl_seconds
|
|
108
|
+
description: >-
|
|
109
|
+
Token and session lifetimes for sessions minted from this
|
|
110
|
+
blueprint.
|
|
111
|
+
required:
|
|
112
|
+
- name
|
|
113
|
+
- session_settings
|
|
114
|
+
description: Configuration for the new agent blueprint.
|
|
115
|
+
responses:
|
|
116
|
+
'201':
|
|
117
|
+
description: Created
|
|
118
|
+
content:
|
|
119
|
+
application/json:
|
|
120
|
+
schema:
|
|
121
|
+
$ref: '#/components/schemas/AgentBlueprint'
|
|
122
|
+
'400':
|
|
123
|
+
description: Bad Request
|
|
124
|
+
content:
|
|
125
|
+
application/json:
|
|
126
|
+
schema:
|
|
127
|
+
type: object
|
|
128
|
+
properties:
|
|
129
|
+
code:
|
|
130
|
+
type: string
|
|
131
|
+
description: The error code identifying the type of error.
|
|
132
|
+
example: invalid_request
|
|
133
|
+
const: invalid_request
|
|
134
|
+
message:
|
|
135
|
+
type: string
|
|
136
|
+
description: A human-readable description of the error.
|
|
137
|
+
example: Request could not be processed.
|
|
138
|
+
required:
|
|
139
|
+
- code
|
|
140
|
+
- message
|
|
141
|
+
'409':
|
|
142
|
+
description: ''
|
|
143
|
+
content:
|
|
144
|
+
application/json:
|
|
145
|
+
schema:
|
|
146
|
+
type: object
|
|
147
|
+
properties:
|
|
148
|
+
code:
|
|
149
|
+
type: string
|
|
150
|
+
description: The error code identifying the type of error.
|
|
151
|
+
example: name_already_in_use
|
|
152
|
+
const: name_already_in_use
|
|
153
|
+
message:
|
|
154
|
+
type: string
|
|
155
|
+
description: A human-readable description of the error.
|
|
156
|
+
example: Request could not be processed.
|
|
157
|
+
required:
|
|
158
|
+
- code
|
|
159
|
+
- message
|
|
160
|
+
'422':
|
|
161
|
+
description: Unprocessable Entity
|
|
162
|
+
content:
|
|
163
|
+
application/json:
|
|
164
|
+
schema:
|
|
165
|
+
oneOf:
|
|
166
|
+
- type: object
|
|
167
|
+
properties:
|
|
168
|
+
code:
|
|
169
|
+
type: string
|
|
170
|
+
description: The error code identifying the type of error.
|
|
171
|
+
example: permission_not_found
|
|
172
|
+
const: permission_not_found
|
|
173
|
+
message:
|
|
174
|
+
type: string
|
|
175
|
+
description: A human-readable description of the error.
|
|
176
|
+
example: Request could not be processed.
|
|
177
|
+
required:
|
|
178
|
+
- code
|
|
179
|
+
- message
|
|
180
|
+
- type: object
|
|
181
|
+
properties:
|
|
182
|
+
code:
|
|
183
|
+
type: string
|
|
184
|
+
description: The error code identifying the type of error.
|
|
185
|
+
example: role_not_found
|
|
186
|
+
const: role_not_found
|
|
187
|
+
message:
|
|
188
|
+
type: string
|
|
189
|
+
description: A human-readable description of the error.
|
|
190
|
+
example: Request could not be processed.
|
|
191
|
+
required:
|
|
192
|
+
- code
|
|
193
|
+
- message
|
|
194
|
+
- type: object
|
|
195
|
+
properties:
|
|
196
|
+
code:
|
|
197
|
+
type: string
|
|
198
|
+
description: The error code identifying the type of error.
|
|
199
|
+
example: organization_not_found
|
|
200
|
+
const: organization_not_found
|
|
201
|
+
message:
|
|
202
|
+
type: string
|
|
203
|
+
description: A human-readable description of the error.
|
|
204
|
+
example: Request could not be processed.
|
|
205
|
+
required:
|
|
206
|
+
- code
|
|
207
|
+
- message
|
|
208
|
+
summary: Create an agent blueprint
|
|
209
|
+
tags:
|
|
210
|
+
- agents.blueprints
|
|
211
|
+
x-feature-flag: agent-blueprints-public-api
|
|
212
|
+
get:
|
|
213
|
+
description: Lists the agent blueprints in the current environment.
|
|
214
|
+
operationId: AgentBlueprintsController_list
|
|
215
|
+
parameters:
|
|
216
|
+
- name: before
|
|
217
|
+
required: false
|
|
218
|
+
in: query
|
|
219
|
+
description: >-
|
|
220
|
+
An object ID that defines your place in the list. When the ID is not
|
|
221
|
+
present, you are at the end of the list. For example, if you make a
|
|
222
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
223
|
+
subsequent call can include `before="obj_123"` to fetch a new batch
|
|
224
|
+
of objects before `"obj_123"`.
|
|
225
|
+
schema:
|
|
226
|
+
example: xxx_01HXYZ123456789ABCDEFGHIJ
|
|
227
|
+
type: string
|
|
228
|
+
- name: after
|
|
229
|
+
required: false
|
|
230
|
+
in: query
|
|
231
|
+
description: >-
|
|
232
|
+
An object ID that defines your place in the list. When the ID is not
|
|
233
|
+
present, you are at the end of the list. For example, if you make a
|
|
234
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
235
|
+
subsequent call can include `after="obj_123"` to fetch a new batch
|
|
236
|
+
of objects after `"obj_123"`.
|
|
237
|
+
schema:
|
|
238
|
+
example: xxx_01HXYZ987654321KJIHGFEDCBA
|
|
239
|
+
type: string
|
|
240
|
+
- name: limit
|
|
241
|
+
required: false
|
|
242
|
+
in: query
|
|
243
|
+
description: >-
|
|
244
|
+
Upper limit on the number of objects to return, between `1` and
|
|
245
|
+
`100`.
|
|
246
|
+
schema:
|
|
247
|
+
minimum: 1
|
|
248
|
+
maximum: 100
|
|
249
|
+
default: 10
|
|
250
|
+
example: 10
|
|
251
|
+
type: integer
|
|
252
|
+
- name: order
|
|
253
|
+
required: false
|
|
254
|
+
in: query
|
|
255
|
+
description: >-
|
|
256
|
+
Order the results by the creation time. Supported values are `"asc"`
|
|
257
|
+
(ascending), `"desc"` (descending), and `"normal"` (descending with
|
|
258
|
+
reversed cursor semantics where `before` fetches older records and
|
|
259
|
+
`after` fetches newer records). Defaults to `normal`.
|
|
260
|
+
schema:
|
|
261
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
262
|
+
responses:
|
|
263
|
+
'200':
|
|
264
|
+
description: OK
|
|
265
|
+
content:
|
|
266
|
+
application/json:
|
|
267
|
+
schema:
|
|
268
|
+
allOf:
|
|
269
|
+
- type: object
|
|
270
|
+
properties:
|
|
271
|
+
object:
|
|
272
|
+
type: string
|
|
273
|
+
description: Indicates this is a list response.
|
|
274
|
+
const: list
|
|
275
|
+
list_metadata:
|
|
276
|
+
type: object
|
|
277
|
+
properties:
|
|
278
|
+
before:
|
|
279
|
+
type:
|
|
280
|
+
- string
|
|
281
|
+
- 'null'
|
|
282
|
+
description: >-
|
|
283
|
+
An object ID that defines your place in the list.
|
|
284
|
+
When the ID is not present, you are at the start
|
|
285
|
+
of the list.
|
|
286
|
+
example: agent_blueprint_01HXYZ123456789ABCDEFGHIJ
|
|
287
|
+
after:
|
|
288
|
+
type:
|
|
289
|
+
- string
|
|
290
|
+
- 'null'
|
|
291
|
+
description: >-
|
|
292
|
+
An object ID that defines your place in the list.
|
|
293
|
+
When the ID is not present, you are at the end of
|
|
294
|
+
the list.
|
|
295
|
+
example: agent_blueprint_01HXYZ987654321KJIHGFEDCBA
|
|
296
|
+
required:
|
|
297
|
+
- before
|
|
298
|
+
- after
|
|
299
|
+
description: >-
|
|
300
|
+
Pagination cursors for navigating between pages of
|
|
301
|
+
results.
|
|
302
|
+
- type: object
|
|
303
|
+
properties:
|
|
304
|
+
data:
|
|
305
|
+
type: array
|
|
306
|
+
description: The list of records for the current page.
|
|
307
|
+
items:
|
|
308
|
+
$ref: '#/components/schemas/AgentBlueprint'
|
|
309
|
+
'401':
|
|
310
|
+
description: Unauthorized
|
|
311
|
+
content:
|
|
312
|
+
application/json:
|
|
313
|
+
schema:
|
|
314
|
+
type: object
|
|
315
|
+
properties:
|
|
316
|
+
message:
|
|
317
|
+
type: string
|
|
318
|
+
description: A human-readable description of the error.
|
|
319
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
320
|
+
required:
|
|
321
|
+
- message
|
|
322
|
+
summary: List agent blueprints
|
|
323
|
+
tags:
|
|
324
|
+
- agents.blueprints
|
|
325
|
+
x-feature-flag: agent-blueprints-public-api
|
|
326
|
+
/agents/blueprints/{agent_blueprint_id}:
|
|
327
|
+
get:
|
|
328
|
+
description: Retrieves an agent blueprint by ID.
|
|
329
|
+
operationId: AgentBlueprintsController_get
|
|
330
|
+
parameters:
|
|
331
|
+
- name: agent_blueprint_id
|
|
332
|
+
required: true
|
|
333
|
+
in: path
|
|
334
|
+
description: The unique ID of the agent blueprint.
|
|
335
|
+
schema:
|
|
336
|
+
type: string
|
|
337
|
+
example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
338
|
+
responses:
|
|
339
|
+
'200':
|
|
340
|
+
description: OK
|
|
341
|
+
content:
|
|
342
|
+
application/json:
|
|
343
|
+
schema:
|
|
344
|
+
$ref: '#/components/schemas/AgentBlueprint'
|
|
345
|
+
'404':
|
|
346
|
+
description: Not Found
|
|
347
|
+
content:
|
|
348
|
+
application/json:
|
|
349
|
+
schema:
|
|
350
|
+
type: object
|
|
351
|
+
properties:
|
|
352
|
+
message:
|
|
353
|
+
type: string
|
|
354
|
+
description: A human-readable description of the error.
|
|
355
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
356
|
+
required:
|
|
357
|
+
- message
|
|
358
|
+
summary: Get an agent blueprint
|
|
359
|
+
tags:
|
|
360
|
+
- agents.blueprints
|
|
361
|
+
x-feature-flag: agent-blueprints-public-api
|
|
362
|
+
patch:
|
|
363
|
+
description: >-
|
|
364
|
+
Updates an agent blueprint. Omitted fields are left unchanged; provided
|
|
365
|
+
lists replace the existing configuration.
|
|
366
|
+
operationId: AgentBlueprintsController_update
|
|
367
|
+
parameters:
|
|
368
|
+
- name: agent_blueprint_id
|
|
369
|
+
required: true
|
|
370
|
+
in: path
|
|
371
|
+
description: The unique ID of the agent blueprint.
|
|
372
|
+
schema:
|
|
373
|
+
type: string
|
|
374
|
+
example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
375
|
+
requestBody:
|
|
376
|
+
required: true
|
|
377
|
+
content:
|
|
378
|
+
application/json:
|
|
379
|
+
schema:
|
|
380
|
+
type: object
|
|
381
|
+
properties:
|
|
382
|
+
name:
|
|
383
|
+
type: string
|
|
384
|
+
minLength: 1
|
|
385
|
+
maxLength: 255
|
|
386
|
+
description: Human-readable name of the agent blueprint.
|
|
387
|
+
example: Prospecting Agent
|
|
388
|
+
description:
|
|
389
|
+
type:
|
|
390
|
+
- string
|
|
391
|
+
- 'null'
|
|
392
|
+
minLength: 1
|
|
393
|
+
maxLength: 1000
|
|
394
|
+
description: >-
|
|
395
|
+
Human-readable description of the agent blueprint. Pass
|
|
396
|
+
`null` to clear it.
|
|
397
|
+
example: Finds and qualifies sales prospects.
|
|
398
|
+
permissions:
|
|
399
|
+
type: array
|
|
400
|
+
items:
|
|
401
|
+
type: string
|
|
402
|
+
minLength: 1
|
|
403
|
+
maxItems: 1000
|
|
404
|
+
description: >-
|
|
405
|
+
Permission slugs forming the ceiling on what sessions minted
|
|
406
|
+
from this blueprint may do. Each slug must exist in the
|
|
407
|
+
environment.
|
|
408
|
+
example:
|
|
409
|
+
- crm:read
|
|
410
|
+
- email:send
|
|
411
|
+
invocable_by:
|
|
412
|
+
type: object
|
|
413
|
+
properties:
|
|
414
|
+
role_slugs:
|
|
415
|
+
type: array
|
|
416
|
+
items:
|
|
417
|
+
type: string
|
|
418
|
+
minLength: 1
|
|
419
|
+
maxItems: 100
|
|
420
|
+
description: >-
|
|
421
|
+
Role slugs whose members may mint user-delegated
|
|
422
|
+
sessions from this blueprint. An empty list allows any
|
|
423
|
+
member.
|
|
424
|
+
example:
|
|
425
|
+
- manager
|
|
426
|
+
organization_ids:
|
|
427
|
+
type: array
|
|
428
|
+
items:
|
|
429
|
+
type: string
|
|
430
|
+
minLength: 1
|
|
431
|
+
maxItems: 1000
|
|
432
|
+
description: >-
|
|
433
|
+
Organizations in which sessions may be minted from this
|
|
434
|
+
blueprint, enforced on user-delegated, autonomous, and
|
|
435
|
+
agent-delegated mints. An empty list allows any
|
|
436
|
+
organization in the environment.
|
|
437
|
+
example:
|
|
438
|
+
- org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
439
|
+
description: >-
|
|
440
|
+
Who may mint sessions from this blueprint. Omitted lists are
|
|
441
|
+
left unchanged.
|
|
442
|
+
session_settings:
|
|
443
|
+
type: object
|
|
444
|
+
properties:
|
|
445
|
+
max_age_seconds:
|
|
446
|
+
type: integer
|
|
447
|
+
exclusiveMinimum: 0
|
|
448
|
+
maximum: 31536000
|
|
449
|
+
description: >-
|
|
450
|
+
Maximum lifetime of a session in seconds; refreshes
|
|
451
|
+
never extend a session past this. At most 31,536,000
|
|
452
|
+
(365 days).
|
|
453
|
+
example: 3600
|
|
454
|
+
access_token_ttl_seconds:
|
|
455
|
+
type: integer
|
|
456
|
+
exclusiveMinimum: 0
|
|
457
|
+
maximum: 3600
|
|
458
|
+
description: >-
|
|
459
|
+
Lifetime of each minted access token in seconds. At most
|
|
460
|
+
3,600 (1 hour).
|
|
461
|
+
example: 300
|
|
462
|
+
refresh_token_ttl_seconds:
|
|
463
|
+
type: integer
|
|
464
|
+
exclusiveMinimum: 0
|
|
465
|
+
maximum: 5184000
|
|
466
|
+
description: >-
|
|
467
|
+
Lifetime of each rotated refresh token in seconds. At
|
|
468
|
+
most 5,184,000 (60 days).
|
|
469
|
+
example: 3600
|
|
470
|
+
description: >-
|
|
471
|
+
Token and session lifetimes for sessions minted from this
|
|
472
|
+
blueprint. Omitted fields are left unchanged.
|
|
473
|
+
description: >-
|
|
474
|
+
Fields to update on the agent blueprint. Omitted fields are left
|
|
475
|
+
unchanged; provided lists replace the existing configuration.
|
|
476
|
+
responses:
|
|
477
|
+
'200':
|
|
478
|
+
description: OK
|
|
479
|
+
content:
|
|
480
|
+
application/json:
|
|
481
|
+
schema:
|
|
482
|
+
$ref: '#/components/schemas/AgentBlueprint'
|
|
483
|
+
'400':
|
|
484
|
+
description: Bad Request
|
|
485
|
+
content:
|
|
486
|
+
application/json:
|
|
487
|
+
schema:
|
|
488
|
+
type: object
|
|
489
|
+
properties:
|
|
490
|
+
code:
|
|
491
|
+
type: string
|
|
492
|
+
description: The error code identifying the type of error.
|
|
493
|
+
example: invalid_request
|
|
494
|
+
const: invalid_request
|
|
495
|
+
message:
|
|
496
|
+
type: string
|
|
497
|
+
description: A human-readable description of the error.
|
|
498
|
+
example: Request could not be processed.
|
|
499
|
+
required:
|
|
500
|
+
- code
|
|
501
|
+
- message
|
|
502
|
+
'404':
|
|
503
|
+
description: Not Found
|
|
504
|
+
content:
|
|
505
|
+
application/json:
|
|
506
|
+
schema:
|
|
507
|
+
type: object
|
|
508
|
+
properties:
|
|
509
|
+
message:
|
|
510
|
+
type: string
|
|
511
|
+
description: A human-readable description of the error.
|
|
512
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
513
|
+
required:
|
|
514
|
+
- message
|
|
515
|
+
'409':
|
|
516
|
+
description: ''
|
|
517
|
+
content:
|
|
518
|
+
application/json:
|
|
519
|
+
schema:
|
|
520
|
+
type: object
|
|
521
|
+
properties:
|
|
522
|
+
code:
|
|
523
|
+
type: string
|
|
524
|
+
description: The error code identifying the type of error.
|
|
525
|
+
example: name_already_in_use
|
|
526
|
+
const: name_already_in_use
|
|
527
|
+
message:
|
|
528
|
+
type: string
|
|
529
|
+
description: A human-readable description of the error.
|
|
530
|
+
example: Request could not be processed.
|
|
531
|
+
required:
|
|
532
|
+
- code
|
|
533
|
+
- message
|
|
534
|
+
'422':
|
|
535
|
+
description: Unprocessable Entity
|
|
536
|
+
content:
|
|
537
|
+
application/json:
|
|
538
|
+
schema:
|
|
539
|
+
oneOf:
|
|
540
|
+
- type: object
|
|
541
|
+
properties:
|
|
542
|
+
code:
|
|
543
|
+
type: string
|
|
544
|
+
description: The error code identifying the type of error.
|
|
545
|
+
example: permission_not_found
|
|
546
|
+
const: permission_not_found
|
|
547
|
+
message:
|
|
548
|
+
type: string
|
|
549
|
+
description: A human-readable description of the error.
|
|
550
|
+
example: Request could not be processed.
|
|
551
|
+
required:
|
|
552
|
+
- code
|
|
553
|
+
- message
|
|
554
|
+
- type: object
|
|
555
|
+
properties:
|
|
556
|
+
code:
|
|
557
|
+
type: string
|
|
558
|
+
description: The error code identifying the type of error.
|
|
559
|
+
example: role_not_found
|
|
560
|
+
const: role_not_found
|
|
561
|
+
message:
|
|
562
|
+
type: string
|
|
563
|
+
description: A human-readable description of the error.
|
|
564
|
+
example: Request could not be processed.
|
|
565
|
+
required:
|
|
566
|
+
- code
|
|
567
|
+
- message
|
|
568
|
+
- type: object
|
|
569
|
+
properties:
|
|
570
|
+
code:
|
|
571
|
+
type: string
|
|
572
|
+
description: The error code identifying the type of error.
|
|
573
|
+
example: organization_not_found
|
|
574
|
+
const: organization_not_found
|
|
575
|
+
message:
|
|
576
|
+
type: string
|
|
577
|
+
description: A human-readable description of the error.
|
|
578
|
+
example: Request could not be processed.
|
|
579
|
+
required:
|
|
580
|
+
- code
|
|
581
|
+
- message
|
|
582
|
+
summary: Update an agent blueprint
|
|
583
|
+
tags:
|
|
584
|
+
- agents.blueprints
|
|
585
|
+
x-feature-flag: agent-blueprints-public-api
|
|
586
|
+
delete:
|
|
587
|
+
description: >-
|
|
588
|
+
Deletes an agent blueprint along with its configuration, instances, and
|
|
589
|
+
sessions.
|
|
590
|
+
operationId: AgentBlueprintsController_delete
|
|
591
|
+
parameters:
|
|
592
|
+
- name: agent_blueprint_id
|
|
593
|
+
required: true
|
|
594
|
+
in: path
|
|
595
|
+
description: The unique ID of the agent blueprint.
|
|
596
|
+
schema:
|
|
597
|
+
type: string
|
|
598
|
+
example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
599
|
+
responses:
|
|
600
|
+
'204':
|
|
601
|
+
description: Agent blueprint deleted.
|
|
602
|
+
'404':
|
|
603
|
+
description: Not Found
|
|
604
|
+
content:
|
|
605
|
+
application/json:
|
|
606
|
+
schema:
|
|
607
|
+
type: object
|
|
608
|
+
properties:
|
|
609
|
+
message:
|
|
610
|
+
type: string
|
|
611
|
+
description: A human-readable description of the error.
|
|
612
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
613
|
+
required:
|
|
614
|
+
- message
|
|
615
|
+
summary: Delete an agent blueprint
|
|
616
|
+
tags:
|
|
617
|
+
- agents.blueprints
|
|
618
|
+
x-feature-flag: agent-blueprints-public-api
|
|
619
|
+
/agents/blueprints/{agent_blueprint_id}/tokens:
|
|
620
|
+
post:
|
|
621
|
+
description: >-
|
|
622
|
+
Mint an agent access token (and backing session) from an agent
|
|
623
|
+
blueprint. The session can be user-delegated (exchanging a user access
|
|
624
|
+
token), autonomous (the agent acting as itself in an organization),
|
|
625
|
+
agent-delegated (the agent exchanging its own access token for a new
|
|
626
|
+
session on the same instance), or a refresh of a previously issued
|
|
627
|
+
refresh token.
|
|
628
|
+
operationId: AgentBlueprintsTokenController_mintToken
|
|
629
|
+
parameters:
|
|
630
|
+
- name: agent_blueprint_id
|
|
631
|
+
required: true
|
|
632
|
+
in: path
|
|
633
|
+
description: The unique ID of the agent blueprint.
|
|
634
|
+
schema:
|
|
635
|
+
type: string
|
|
636
|
+
example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
637
|
+
requestBody:
|
|
638
|
+
required: true
|
|
639
|
+
content:
|
|
640
|
+
application/json:
|
|
641
|
+
schema:
|
|
642
|
+
discriminator:
|
|
643
|
+
propertyName: type
|
|
644
|
+
oneOf:
|
|
645
|
+
- type: object
|
|
646
|
+
properties:
|
|
647
|
+
type:
|
|
648
|
+
type: string
|
|
649
|
+
description: >-
|
|
650
|
+
How the session is minted: `user_delegated`,
|
|
651
|
+
`autonomous`, `agent_delegated`, or `refresh`.
|
|
652
|
+
const: user_delegated
|
|
653
|
+
user_access_token:
|
|
654
|
+
type: string
|
|
655
|
+
minLength: 1
|
|
656
|
+
description: >-
|
|
657
|
+
The access token of the user delegating to the agent.
|
|
658
|
+
The token identifies the user and organization;
|
|
659
|
+
effective permissions are resolved server-side.
|
|
660
|
+
example: eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
661
|
+
intent:
|
|
662
|
+
type: string
|
|
663
|
+
minLength: 1
|
|
664
|
+
maxLength: 255
|
|
665
|
+
description: >-
|
|
666
|
+
Optional caller-supplied context, echoed as an object
|
|
667
|
+
with a `text` field in the `intent` claim of the minted
|
|
668
|
+
access token.
|
|
669
|
+
example: renew-contract-123
|
|
670
|
+
required:
|
|
671
|
+
- type
|
|
672
|
+
- user_access_token
|
|
673
|
+
- type: object
|
|
674
|
+
properties:
|
|
675
|
+
type:
|
|
676
|
+
type: string
|
|
677
|
+
description: >-
|
|
678
|
+
How the session is minted: `user_delegated`,
|
|
679
|
+
`autonomous`, `agent_delegated`, or `refresh`.
|
|
680
|
+
const: autonomous
|
|
681
|
+
organization_id:
|
|
682
|
+
type: string
|
|
683
|
+
minLength: 1
|
|
684
|
+
description: >-
|
|
685
|
+
The organization the agent acts within when operating as
|
|
686
|
+
itself.
|
|
687
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
688
|
+
intent:
|
|
689
|
+
type: string
|
|
690
|
+
minLength: 1
|
|
691
|
+
maxLength: 255
|
|
692
|
+
description: >-
|
|
693
|
+
Optional caller-supplied context, echoed as an object
|
|
694
|
+
with a `text` field in the `intent` claim of the minted
|
|
695
|
+
access token.
|
|
696
|
+
example: renew-contract-123
|
|
697
|
+
required:
|
|
698
|
+
- type
|
|
699
|
+
- organization_id
|
|
700
|
+
- type: object
|
|
701
|
+
properties:
|
|
702
|
+
type:
|
|
703
|
+
type: string
|
|
704
|
+
description: >-
|
|
705
|
+
How the session is minted: `user_delegated`,
|
|
706
|
+
`autonomous`, `agent_delegated`, or `refresh`.
|
|
707
|
+
const: agent_delegated
|
|
708
|
+
agent_access_token:
|
|
709
|
+
type: string
|
|
710
|
+
minLength: 1
|
|
711
|
+
description: >-
|
|
712
|
+
The agent's own access token to exchange for a new
|
|
713
|
+
session on the same instance. The token must have been
|
|
714
|
+
minted from this blueprint; permissions are re-derived
|
|
715
|
+
from current authority.
|
|
716
|
+
example: eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
717
|
+
intent:
|
|
718
|
+
type: string
|
|
719
|
+
minLength: 1
|
|
720
|
+
maxLength: 255
|
|
721
|
+
description: >-
|
|
722
|
+
Optional caller-supplied context, echoed as an object
|
|
723
|
+
with a `text` field in the `intent` claim of the minted
|
|
724
|
+
access token.
|
|
725
|
+
example: renew-contract-123
|
|
726
|
+
required:
|
|
727
|
+
- type
|
|
728
|
+
- agent_access_token
|
|
729
|
+
- type: object
|
|
730
|
+
properties:
|
|
731
|
+
type:
|
|
732
|
+
type: string
|
|
733
|
+
description: >-
|
|
734
|
+
How the session is minted: `user_delegated`,
|
|
735
|
+
`autonomous`, `agent_delegated`, or `refresh`.
|
|
736
|
+
const: refresh
|
|
737
|
+
refresh_token:
|
|
738
|
+
type: string
|
|
739
|
+
minLength: 1
|
|
740
|
+
description: >-
|
|
741
|
+
The refresh token issued with a previous agent access
|
|
742
|
+
token. Refresh tokens are single-use: each refresh
|
|
743
|
+
rotates it.
|
|
744
|
+
example: njGkA8Wyht0GBEGGA0Zh1Q3wZzL2...
|
|
745
|
+
intent:
|
|
746
|
+
type: string
|
|
747
|
+
minLength: 1
|
|
748
|
+
maxLength: 255
|
|
749
|
+
description: >-
|
|
750
|
+
Optional caller-supplied context, echoed as an object
|
|
751
|
+
with a `text` field in the `intent` claim of the minted
|
|
752
|
+
access token.
|
|
753
|
+
example: renew-contract-123
|
|
754
|
+
required:
|
|
755
|
+
- type
|
|
756
|
+
- refresh_token
|
|
757
|
+
description: >-
|
|
758
|
+
How to mint the agent session, discriminated by `type`. `intent`
|
|
759
|
+
is optional on every variant.
|
|
760
|
+
responses:
|
|
761
|
+
'200':
|
|
762
|
+
description: OK
|
|
763
|
+
content:
|
|
764
|
+
application/json:
|
|
765
|
+
schema:
|
|
766
|
+
$ref: '#/components/schemas/AgentToken'
|
|
767
|
+
'400':
|
|
768
|
+
description: Bad Request
|
|
769
|
+
content:
|
|
770
|
+
application/json:
|
|
771
|
+
schema:
|
|
772
|
+
oneOf:
|
|
773
|
+
- type: object
|
|
774
|
+
properties:
|
|
775
|
+
code:
|
|
776
|
+
type: string
|
|
777
|
+
description: The error code identifying the type of error.
|
|
778
|
+
example: invalid_request
|
|
779
|
+
const: invalid_request
|
|
780
|
+
message:
|
|
781
|
+
type: string
|
|
782
|
+
description: A human-readable description of the error.
|
|
783
|
+
example: Request could not be processed.
|
|
784
|
+
required:
|
|
785
|
+
- code
|
|
786
|
+
- message
|
|
787
|
+
- type: object
|
|
788
|
+
properties:
|
|
789
|
+
code:
|
|
790
|
+
type: string
|
|
791
|
+
description: The error code identifying the type of error.
|
|
792
|
+
example: invalid_user_access_token
|
|
793
|
+
const: invalid_user_access_token
|
|
794
|
+
message:
|
|
795
|
+
type: string
|
|
796
|
+
description: A human-readable description of the error.
|
|
797
|
+
example: Request could not be processed.
|
|
798
|
+
required:
|
|
799
|
+
- code
|
|
800
|
+
- message
|
|
801
|
+
- type: object
|
|
802
|
+
properties:
|
|
803
|
+
code:
|
|
804
|
+
type: string
|
|
805
|
+
description: The error code identifying the type of error.
|
|
806
|
+
example: invalid_agent_access_token
|
|
807
|
+
const: invalid_agent_access_token
|
|
808
|
+
message:
|
|
809
|
+
type: string
|
|
810
|
+
description: A human-readable description of the error.
|
|
811
|
+
example: Request could not be processed.
|
|
812
|
+
required:
|
|
813
|
+
- code
|
|
814
|
+
- message
|
|
815
|
+
- type: object
|
|
816
|
+
properties:
|
|
817
|
+
code:
|
|
818
|
+
type: string
|
|
819
|
+
description: The error code identifying the type of error.
|
|
820
|
+
example: invalid_refresh_token
|
|
821
|
+
const: invalid_refresh_token
|
|
822
|
+
message:
|
|
823
|
+
type: string
|
|
824
|
+
description: A human-readable description of the error.
|
|
825
|
+
example: Request could not be processed.
|
|
826
|
+
required:
|
|
827
|
+
- code
|
|
828
|
+
- message
|
|
829
|
+
- type: object
|
|
830
|
+
properties:
|
|
831
|
+
code:
|
|
832
|
+
type: string
|
|
833
|
+
description: The error code identifying the type of error.
|
|
834
|
+
example: session_revoked
|
|
835
|
+
const: session_revoked
|
|
836
|
+
message:
|
|
837
|
+
type: string
|
|
838
|
+
description: A human-readable description of the error.
|
|
839
|
+
example: Request could not be processed.
|
|
840
|
+
required:
|
|
841
|
+
- code
|
|
842
|
+
- message
|
|
843
|
+
- type: object
|
|
844
|
+
properties:
|
|
845
|
+
code:
|
|
846
|
+
type: string
|
|
847
|
+
description: The error code identifying the type of error.
|
|
848
|
+
example: session_expired
|
|
849
|
+
const: session_expired
|
|
850
|
+
message:
|
|
851
|
+
type: string
|
|
852
|
+
description: A human-readable description of the error.
|
|
853
|
+
example: Request could not be processed.
|
|
854
|
+
required:
|
|
855
|
+
- code
|
|
856
|
+
- message
|
|
857
|
+
- type: object
|
|
858
|
+
properties:
|
|
859
|
+
code:
|
|
860
|
+
type: string
|
|
861
|
+
description: The error code identifying the type of error.
|
|
862
|
+
example: user_session_ended
|
|
863
|
+
const: user_session_ended
|
|
864
|
+
message:
|
|
865
|
+
type: string
|
|
866
|
+
description: A human-readable description of the error.
|
|
867
|
+
example: Request could not be processed.
|
|
868
|
+
required:
|
|
869
|
+
- code
|
|
870
|
+
- message
|
|
871
|
+
- type: object
|
|
872
|
+
properties:
|
|
873
|
+
code:
|
|
874
|
+
type: string
|
|
875
|
+
description: The error code identifying the type of error.
|
|
876
|
+
example: max_age_exceeded
|
|
877
|
+
const: max_age_exceeded
|
|
878
|
+
message:
|
|
879
|
+
type: string
|
|
880
|
+
description: A human-readable description of the error.
|
|
881
|
+
example: Request could not be processed.
|
|
882
|
+
required:
|
|
883
|
+
- code
|
|
884
|
+
- message
|
|
885
|
+
- type: object
|
|
886
|
+
properties:
|
|
887
|
+
code:
|
|
888
|
+
type: string
|
|
889
|
+
description: The error code identifying the type of error.
|
|
890
|
+
example: session_settings_not_found
|
|
891
|
+
const: session_settings_not_found
|
|
892
|
+
message:
|
|
893
|
+
type: string
|
|
894
|
+
description: A human-readable description of the error.
|
|
895
|
+
example: Request could not be processed.
|
|
896
|
+
required:
|
|
897
|
+
- code
|
|
898
|
+
- message
|
|
899
|
+
- type: object
|
|
900
|
+
properties:
|
|
901
|
+
code:
|
|
902
|
+
type: string
|
|
903
|
+
description: The error code identifying the type of error.
|
|
904
|
+
example: chain_depth_exceeded
|
|
905
|
+
const: chain_depth_exceeded
|
|
906
|
+
message:
|
|
907
|
+
type: string
|
|
908
|
+
description: A human-readable description of the error.
|
|
909
|
+
example: Request could not be processed.
|
|
910
|
+
required:
|
|
911
|
+
- code
|
|
912
|
+
- message
|
|
913
|
+
'403':
|
|
914
|
+
description: Forbidden
|
|
915
|
+
content:
|
|
916
|
+
application/json:
|
|
917
|
+
schema:
|
|
918
|
+
oneOf:
|
|
919
|
+
- type: object
|
|
920
|
+
properties:
|
|
921
|
+
code:
|
|
922
|
+
type: string
|
|
923
|
+
description: The error code identifying the type of error.
|
|
924
|
+
example: user_not_member_of_organization
|
|
925
|
+
const: user_not_member_of_organization
|
|
926
|
+
message:
|
|
927
|
+
type: string
|
|
928
|
+
description: A human-readable description of the error.
|
|
929
|
+
example: Request could not be processed.
|
|
930
|
+
required:
|
|
931
|
+
- code
|
|
932
|
+
- message
|
|
933
|
+
- type: object
|
|
934
|
+
properties:
|
|
935
|
+
code:
|
|
936
|
+
type: string
|
|
937
|
+
description: The error code identifying the type of error.
|
|
938
|
+
example: organization_not_invocable
|
|
939
|
+
const: organization_not_invocable
|
|
940
|
+
message:
|
|
941
|
+
type: string
|
|
942
|
+
description: A human-readable description of the error.
|
|
943
|
+
example: Request could not be processed.
|
|
944
|
+
required:
|
|
945
|
+
- code
|
|
946
|
+
- message
|
|
947
|
+
- type: object
|
|
948
|
+
properties:
|
|
949
|
+
code:
|
|
950
|
+
type: string
|
|
951
|
+
description: The error code identifying the type of error.
|
|
952
|
+
example: role_not_invocable
|
|
953
|
+
const: role_not_invocable
|
|
954
|
+
message:
|
|
955
|
+
type: string
|
|
956
|
+
description: A human-readable description of the error.
|
|
957
|
+
example: Request could not be processed.
|
|
958
|
+
required:
|
|
959
|
+
- code
|
|
960
|
+
- message
|
|
961
|
+
'404':
|
|
962
|
+
description: Not Found
|
|
963
|
+
content:
|
|
964
|
+
application/json:
|
|
965
|
+
schema:
|
|
966
|
+
type: object
|
|
967
|
+
properties:
|
|
968
|
+
message:
|
|
969
|
+
type: string
|
|
970
|
+
description: A human-readable description of the error.
|
|
971
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
972
|
+
required:
|
|
973
|
+
- message
|
|
974
|
+
summary: Mint an agent token
|
|
975
|
+
tags:
|
|
976
|
+
- agents.blueprints.tokens
|
|
977
|
+
x-feature-flag: agent-blueprints-public-api
|
|
3
978
|
/agents/claims/attempts:
|
|
4
979
|
patch:
|
|
5
980
|
description: >-
|
|
@@ -286,7 +1261,7 @@ paths:
|
|
|
286
1261
|
- message
|
|
287
1262
|
summary: Link a claim attempt to an external user
|
|
288
1263
|
tags:
|
|
289
|
-
- agents
|
|
1264
|
+
- agents.registrations
|
|
290
1265
|
x-feature-flag: agent-auth-public-api
|
|
291
1266
|
/agents/credentials/validate:
|
|
292
1267
|
post:
|
|
@@ -379,8 +1354,208 @@ paths:
|
|
|
379
1354
|
- message
|
|
380
1355
|
summary: Validate an agent credential
|
|
381
1356
|
tags:
|
|
382
|
-
- agents
|
|
1357
|
+
- agents.registrations
|
|
383
1358
|
x-feature-flag: agent-auth-public-api
|
|
1359
|
+
/agents/instances:
|
|
1360
|
+
get:
|
|
1361
|
+
description: >-
|
|
1362
|
+
Lists the agent instances in the current environment. Instances are
|
|
1363
|
+
created implicitly when tokens are minted.
|
|
1364
|
+
operationId: AgentInstancesController_list
|
|
1365
|
+
parameters:
|
|
1366
|
+
- name: before
|
|
1367
|
+
required: false
|
|
1368
|
+
in: query
|
|
1369
|
+
description: >-
|
|
1370
|
+
An object ID that defines your place in the list. When the ID is not
|
|
1371
|
+
present, you are at the end of the list. For example, if you make a
|
|
1372
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
1373
|
+
subsequent call can include `before="obj_123"` to fetch a new batch
|
|
1374
|
+
of objects before `"obj_123"`.
|
|
1375
|
+
schema:
|
|
1376
|
+
example: xxx_01HXYZ123456789ABCDEFGHIJ
|
|
1377
|
+
type: string
|
|
1378
|
+
- name: after
|
|
1379
|
+
required: false
|
|
1380
|
+
in: query
|
|
1381
|
+
description: >-
|
|
1382
|
+
An object ID that defines your place in the list. When the ID is not
|
|
1383
|
+
present, you are at the end of the list. For example, if you make a
|
|
1384
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
1385
|
+
subsequent call can include `after="obj_123"` to fetch a new batch
|
|
1386
|
+
of objects after `"obj_123"`.
|
|
1387
|
+
schema:
|
|
1388
|
+
example: xxx_01HXYZ987654321KJIHGFEDCBA
|
|
1389
|
+
type: string
|
|
1390
|
+
- name: limit
|
|
1391
|
+
required: false
|
|
1392
|
+
in: query
|
|
1393
|
+
description: >-
|
|
1394
|
+
Upper limit on the number of objects to return, between `1` and
|
|
1395
|
+
`100`.
|
|
1396
|
+
schema:
|
|
1397
|
+
minimum: 1
|
|
1398
|
+
maximum: 100
|
|
1399
|
+
default: 10
|
|
1400
|
+
example: 10
|
|
1401
|
+
type: integer
|
|
1402
|
+
- name: order
|
|
1403
|
+
required: false
|
|
1404
|
+
in: query
|
|
1405
|
+
description: >-
|
|
1406
|
+
Order the results by the creation time. Supported values are `"asc"`
|
|
1407
|
+
(ascending), `"desc"` (descending), and `"normal"` (descending with
|
|
1408
|
+
reversed cursor semantics where `before` fetches older records and
|
|
1409
|
+
`after` fetches newer records). Defaults to `normal`.
|
|
1410
|
+
schema:
|
|
1411
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
1412
|
+
- name: organization_id
|
|
1413
|
+
required: false
|
|
1414
|
+
in: query
|
|
1415
|
+
description: Only return instances acting within this organization.
|
|
1416
|
+
schema:
|
|
1417
|
+
type: string
|
|
1418
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
1419
|
+
- name: agent_blueprint_id
|
|
1420
|
+
required: false
|
|
1421
|
+
in: query
|
|
1422
|
+
description: Only return instances minted from this blueprint.
|
|
1423
|
+
schema:
|
|
1424
|
+
type: string
|
|
1425
|
+
example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
1426
|
+
responses:
|
|
1427
|
+
'200':
|
|
1428
|
+
description: OK
|
|
1429
|
+
content:
|
|
1430
|
+
application/json:
|
|
1431
|
+
schema:
|
|
1432
|
+
allOf:
|
|
1433
|
+
- type: object
|
|
1434
|
+
properties:
|
|
1435
|
+
object:
|
|
1436
|
+
type: string
|
|
1437
|
+
description: Indicates this is a list response.
|
|
1438
|
+
const: list
|
|
1439
|
+
list_metadata:
|
|
1440
|
+
type: object
|
|
1441
|
+
properties:
|
|
1442
|
+
before:
|
|
1443
|
+
type:
|
|
1444
|
+
- string
|
|
1445
|
+
- 'null'
|
|
1446
|
+
description: >-
|
|
1447
|
+
An object ID that defines your place in the list.
|
|
1448
|
+
When the ID is not present, you are at the start
|
|
1449
|
+
of the list.
|
|
1450
|
+
example: agent_01HXYZ123456789ABCDEFGHIJ
|
|
1451
|
+
after:
|
|
1452
|
+
type:
|
|
1453
|
+
- string
|
|
1454
|
+
- 'null'
|
|
1455
|
+
description: >-
|
|
1456
|
+
An object ID that defines your place in the list.
|
|
1457
|
+
When the ID is not present, you are at the end of
|
|
1458
|
+
the list.
|
|
1459
|
+
example: agent_01HXYZ987654321KJIHGFEDCBA
|
|
1460
|
+
required:
|
|
1461
|
+
- before
|
|
1462
|
+
- after
|
|
1463
|
+
description: >-
|
|
1464
|
+
Pagination cursors for navigating between pages of
|
|
1465
|
+
results.
|
|
1466
|
+
- type: object
|
|
1467
|
+
properties:
|
|
1468
|
+
data:
|
|
1469
|
+
type: array
|
|
1470
|
+
description: The list of records for the current page.
|
|
1471
|
+
items:
|
|
1472
|
+
$ref: '#/components/schemas/AgentInstance'
|
|
1473
|
+
'401':
|
|
1474
|
+
description: Unauthorized
|
|
1475
|
+
content:
|
|
1476
|
+
application/json:
|
|
1477
|
+
schema:
|
|
1478
|
+
type: object
|
|
1479
|
+
properties:
|
|
1480
|
+
message:
|
|
1481
|
+
type: string
|
|
1482
|
+
description: A human-readable description of the error.
|
|
1483
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1484
|
+
required:
|
|
1485
|
+
- message
|
|
1486
|
+
summary: List agent instances
|
|
1487
|
+
tags:
|
|
1488
|
+
- agents.instances
|
|
1489
|
+
x-feature-flag: agent-blueprints-public-api
|
|
1490
|
+
/agents/instances/{agent_instance_id}:
|
|
1491
|
+
get:
|
|
1492
|
+
description: Retrieves an agent instance by ID.
|
|
1493
|
+
operationId: AgentInstancesController_get
|
|
1494
|
+
parameters:
|
|
1495
|
+
- name: agent_instance_id
|
|
1496
|
+
required: true
|
|
1497
|
+
in: path
|
|
1498
|
+
description: The unique ID of the agent instance.
|
|
1499
|
+
schema:
|
|
1500
|
+
type: string
|
|
1501
|
+
example: agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
1502
|
+
responses:
|
|
1503
|
+
'200':
|
|
1504
|
+
description: OK
|
|
1505
|
+
content:
|
|
1506
|
+
application/json:
|
|
1507
|
+
schema:
|
|
1508
|
+
$ref: '#/components/schemas/AgentInstance'
|
|
1509
|
+
'404':
|
|
1510
|
+
description: Not Found
|
|
1511
|
+
content:
|
|
1512
|
+
application/json:
|
|
1513
|
+
schema:
|
|
1514
|
+
type: object
|
|
1515
|
+
properties:
|
|
1516
|
+
message:
|
|
1517
|
+
type: string
|
|
1518
|
+
description: A human-readable description of the error.
|
|
1519
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1520
|
+
required:
|
|
1521
|
+
- message
|
|
1522
|
+
summary: Get an agent instance
|
|
1523
|
+
tags:
|
|
1524
|
+
- agents.instances
|
|
1525
|
+
x-feature-flag: agent-blueprints-public-api
|
|
1526
|
+
delete:
|
|
1527
|
+
description: >-
|
|
1528
|
+
Deletes an agent instance along with its sessions, invalidating their
|
|
1529
|
+
refresh tokens.
|
|
1530
|
+
operationId: AgentInstancesController_delete
|
|
1531
|
+
parameters:
|
|
1532
|
+
- name: agent_instance_id
|
|
1533
|
+
required: true
|
|
1534
|
+
in: path
|
|
1535
|
+
description: The unique ID of the agent instance.
|
|
1536
|
+
schema:
|
|
1537
|
+
type: string
|
|
1538
|
+
example: agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
1539
|
+
responses:
|
|
1540
|
+
'204':
|
|
1541
|
+
description: Agent instance deleted.
|
|
1542
|
+
'404':
|
|
1543
|
+
description: Not Found
|
|
1544
|
+
content:
|
|
1545
|
+
application/json:
|
|
1546
|
+
schema:
|
|
1547
|
+
type: object
|
|
1548
|
+
properties:
|
|
1549
|
+
message:
|
|
1550
|
+
type: string
|
|
1551
|
+
description: A human-readable description of the error.
|
|
1552
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1553
|
+
required:
|
|
1554
|
+
- message
|
|
1555
|
+
summary: Delete an agent instance
|
|
1556
|
+
tags:
|
|
1557
|
+
- agents.instances
|
|
1558
|
+
x-feature-flag: agent-blueprints-public-api
|
|
384
1559
|
/agents/registrations/{id}:
|
|
385
1560
|
get:
|
|
386
1561
|
description: >-
|
|
@@ -418,8 +1593,247 @@ paths:
|
|
|
418
1593
|
- message
|
|
419
1594
|
summary: Get an agent registration
|
|
420
1595
|
tags:
|
|
421
|
-
- agents
|
|
1596
|
+
- agents.registrations
|
|
422
1597
|
x-feature-flag: agent-auth-public-api
|
|
1598
|
+
/agents/sessions:
|
|
1599
|
+
get:
|
|
1600
|
+
description: >-
|
|
1601
|
+
Lists the agent instance sessions in the current environment. Sessions
|
|
1602
|
+
are created when tokens are minted.
|
|
1603
|
+
operationId: AgentInstanceSessionsController_list
|
|
1604
|
+
parameters:
|
|
1605
|
+
- name: before
|
|
1606
|
+
required: false
|
|
1607
|
+
in: query
|
|
1608
|
+
description: >-
|
|
1609
|
+
An object ID that defines your place in the list. When the ID is not
|
|
1610
|
+
present, you are at the end of the list. For example, if you make a
|
|
1611
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
1612
|
+
subsequent call can include `before="obj_123"` to fetch a new batch
|
|
1613
|
+
of objects before `"obj_123"`.
|
|
1614
|
+
schema:
|
|
1615
|
+
example: xxx_01HXYZ123456789ABCDEFGHIJ
|
|
1616
|
+
type: string
|
|
1617
|
+
- name: after
|
|
1618
|
+
required: false
|
|
1619
|
+
in: query
|
|
1620
|
+
description: >-
|
|
1621
|
+
An object ID that defines your place in the list. When the ID is not
|
|
1622
|
+
present, you are at the end of the list. For example, if you make a
|
|
1623
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
1624
|
+
subsequent call can include `after="obj_123"` to fetch a new batch
|
|
1625
|
+
of objects after `"obj_123"`.
|
|
1626
|
+
schema:
|
|
1627
|
+
example: xxx_01HXYZ987654321KJIHGFEDCBA
|
|
1628
|
+
type: string
|
|
1629
|
+
- name: limit
|
|
1630
|
+
required: false
|
|
1631
|
+
in: query
|
|
1632
|
+
description: >-
|
|
1633
|
+
Upper limit on the number of objects to return, between `1` and
|
|
1634
|
+
`100`.
|
|
1635
|
+
schema:
|
|
1636
|
+
minimum: 1
|
|
1637
|
+
maximum: 100
|
|
1638
|
+
default: 10
|
|
1639
|
+
example: 10
|
|
1640
|
+
type: integer
|
|
1641
|
+
- name: order
|
|
1642
|
+
required: false
|
|
1643
|
+
in: query
|
|
1644
|
+
description: >-
|
|
1645
|
+
Order the results by the creation time. Supported values are `"asc"`
|
|
1646
|
+
(ascending), `"desc"` (descending), and `"normal"` (descending with
|
|
1647
|
+
reversed cursor semantics where `before` fetches older records and
|
|
1648
|
+
`after` fetches newer records). Defaults to `normal`.
|
|
1649
|
+
schema:
|
|
1650
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
1651
|
+
- name: agent_blueprint_id
|
|
1652
|
+
required: false
|
|
1653
|
+
in: query
|
|
1654
|
+
description: Only return sessions of instances minted from this blueprint.
|
|
1655
|
+
schema:
|
|
1656
|
+
type: string
|
|
1657
|
+
example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
1658
|
+
- name: agent_instance_id
|
|
1659
|
+
required: false
|
|
1660
|
+
in: query
|
|
1661
|
+
description: Only return sessions belonging to this agent instance.
|
|
1662
|
+
schema:
|
|
1663
|
+
type: string
|
|
1664
|
+
example: agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
1665
|
+
responses:
|
|
1666
|
+
'200':
|
|
1667
|
+
description: OK
|
|
1668
|
+
content:
|
|
1669
|
+
application/json:
|
|
1670
|
+
schema:
|
|
1671
|
+
allOf:
|
|
1672
|
+
- type: object
|
|
1673
|
+
properties:
|
|
1674
|
+
object:
|
|
1675
|
+
type: string
|
|
1676
|
+
description: Indicates this is a list response.
|
|
1677
|
+
const: list
|
|
1678
|
+
list_metadata:
|
|
1679
|
+
type: object
|
|
1680
|
+
properties:
|
|
1681
|
+
before:
|
|
1682
|
+
type:
|
|
1683
|
+
- string
|
|
1684
|
+
- 'null'
|
|
1685
|
+
description: >-
|
|
1686
|
+
An object ID that defines your place in the list.
|
|
1687
|
+
When the ID is not present, you are at the start
|
|
1688
|
+
of the list.
|
|
1689
|
+
example: agent_session_01HXYZ123456789ABCDEFGHIJ
|
|
1690
|
+
after:
|
|
1691
|
+
type:
|
|
1692
|
+
- string
|
|
1693
|
+
- 'null'
|
|
1694
|
+
description: >-
|
|
1695
|
+
An object ID that defines your place in the list.
|
|
1696
|
+
When the ID is not present, you are at the end of
|
|
1697
|
+
the list.
|
|
1698
|
+
example: agent_session_01HXYZ987654321KJIHGFEDCBA
|
|
1699
|
+
required:
|
|
1700
|
+
- before
|
|
1701
|
+
- after
|
|
1702
|
+
description: >-
|
|
1703
|
+
Pagination cursors for navigating between pages of
|
|
1704
|
+
results.
|
|
1705
|
+
- type: object
|
|
1706
|
+
properties:
|
|
1707
|
+
data:
|
|
1708
|
+
type: array
|
|
1709
|
+
description: The list of records for the current page.
|
|
1710
|
+
items:
|
|
1711
|
+
$ref: '#/components/schemas/AgentInstanceSession'
|
|
1712
|
+
'401':
|
|
1713
|
+
description: Unauthorized
|
|
1714
|
+
content:
|
|
1715
|
+
application/json:
|
|
1716
|
+
schema:
|
|
1717
|
+
type: object
|
|
1718
|
+
properties:
|
|
1719
|
+
message:
|
|
1720
|
+
type: string
|
|
1721
|
+
description: A human-readable description of the error.
|
|
1722
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1723
|
+
required:
|
|
1724
|
+
- message
|
|
1725
|
+
'422':
|
|
1726
|
+
description: Unprocessable Entity
|
|
1727
|
+
content:
|
|
1728
|
+
application/json:
|
|
1729
|
+
schema:
|
|
1730
|
+
type: object
|
|
1731
|
+
properties:
|
|
1732
|
+
message:
|
|
1733
|
+
type: string
|
|
1734
|
+
description: A human-readable description of the error.
|
|
1735
|
+
example: Validation failed.
|
|
1736
|
+
errors:
|
|
1737
|
+
type: array
|
|
1738
|
+
items:
|
|
1739
|
+
type: object
|
|
1740
|
+
properties:
|
|
1741
|
+
code:
|
|
1742
|
+
type: string
|
|
1743
|
+
description: The validation error code.
|
|
1744
|
+
example: required
|
|
1745
|
+
field:
|
|
1746
|
+
type: string
|
|
1747
|
+
description: The field that failed validation.
|
|
1748
|
+
example: event.action
|
|
1749
|
+
required:
|
|
1750
|
+
- code
|
|
1751
|
+
- field
|
|
1752
|
+
description: The list of validation errors.
|
|
1753
|
+
required:
|
|
1754
|
+
- message
|
|
1755
|
+
- errors
|
|
1756
|
+
summary: List agent instance sessions
|
|
1757
|
+
tags:
|
|
1758
|
+
- agents.sessions
|
|
1759
|
+
x-feature-flag: agent-blueprints-public-api
|
|
1760
|
+
/agents/sessions/{agent_instance_session_id}:
|
|
1761
|
+
get:
|
|
1762
|
+
description: Retrieves an agent instance session by ID.
|
|
1763
|
+
operationId: AgentInstanceSessionsController_get
|
|
1764
|
+
parameters:
|
|
1765
|
+
- name: agent_instance_session_id
|
|
1766
|
+
required: true
|
|
1767
|
+
in: path
|
|
1768
|
+
description: The unique ID of the agent instance session.
|
|
1769
|
+
schema:
|
|
1770
|
+
type: string
|
|
1771
|
+
example: agent_session_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
1772
|
+
responses:
|
|
1773
|
+
'200':
|
|
1774
|
+
description: OK
|
|
1775
|
+
content:
|
|
1776
|
+
application/json:
|
|
1777
|
+
schema:
|
|
1778
|
+
$ref: '#/components/schemas/AgentInstanceSession'
|
|
1779
|
+
'404':
|
|
1780
|
+
description: Not Found
|
|
1781
|
+
content:
|
|
1782
|
+
application/json:
|
|
1783
|
+
schema:
|
|
1784
|
+
type: object
|
|
1785
|
+
properties:
|
|
1786
|
+
message:
|
|
1787
|
+
type: string
|
|
1788
|
+
description: A human-readable description of the error.
|
|
1789
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1790
|
+
required:
|
|
1791
|
+
- message
|
|
1792
|
+
summary: Get an agent instance session
|
|
1793
|
+
tags:
|
|
1794
|
+
- agents.sessions
|
|
1795
|
+
x-feature-flag: agent-blueprints-public-api
|
|
1796
|
+
/agents/sessions/{agent_instance_session_id}/revoke:
|
|
1797
|
+
post:
|
|
1798
|
+
description: >-
|
|
1799
|
+
Revokes an agent instance session, invalidating its refresh token and
|
|
1800
|
+
every access token minted under it. Revocation is idempotent: revoking
|
|
1801
|
+
an already-revoked session keeps the original `revoked_at`, and revoking
|
|
1802
|
+
an already-expired session returns the session with `status: expired`
|
|
1803
|
+
and a null `revoked_at`.
|
|
1804
|
+
operationId: AgentInstanceSessionsController_revoke
|
|
1805
|
+
parameters:
|
|
1806
|
+
- name: agent_instance_session_id
|
|
1807
|
+
required: true
|
|
1808
|
+
in: path
|
|
1809
|
+
description: The unique ID of the agent instance session.
|
|
1810
|
+
schema:
|
|
1811
|
+
type: string
|
|
1812
|
+
example: agent_session_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
1813
|
+
responses:
|
|
1814
|
+
'200':
|
|
1815
|
+
description: OK
|
|
1816
|
+
content:
|
|
1817
|
+
application/json:
|
|
1818
|
+
schema:
|
|
1819
|
+
$ref: '#/components/schemas/AgentInstanceSession'
|
|
1820
|
+
'404':
|
|
1821
|
+
description: Not Found
|
|
1822
|
+
content:
|
|
1823
|
+
application/json:
|
|
1824
|
+
schema:
|
|
1825
|
+
type: object
|
|
1826
|
+
properties:
|
|
1827
|
+
message:
|
|
1828
|
+
type: string
|
|
1829
|
+
description: A human-readable description of the error.
|
|
1830
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1831
|
+
required:
|
|
1832
|
+
- message
|
|
1833
|
+
summary: Revoke an agent instance session
|
|
1834
|
+
tags:
|
|
1835
|
+
- agents.sessions
|
|
1836
|
+
x-feature-flag: agent-blueprints-public-api
|
|
423
1837
|
/api_keys/validations:
|
|
424
1838
|
post:
|
|
425
1839
|
description: Validate an API key value and return the API key object if valid.
|
|
@@ -2092,7 +3506,7 @@ paths:
|
|
|
2092
3506
|
summary: Check authorization
|
|
2093
3507
|
tags:
|
|
2094
3508
|
- authorization
|
|
2095
|
-
x-mutually-exclusive-body-groups: &
|
|
3509
|
+
x-mutually-exclusive-body-groups: &ref_4
|
|
2096
3510
|
resource_target:
|
|
2097
3511
|
optional: false
|
|
2098
3512
|
variants:
|
|
@@ -2735,7 +4149,7 @@ paths:
|
|
|
2735
4149
|
summary: Assign a role
|
|
2736
4150
|
tags:
|
|
2737
4151
|
- authorization
|
|
2738
|
-
x-mutually-exclusive-body-groups: &
|
|
4152
|
+
x-mutually-exclusive-body-groups: &ref_5
|
|
2739
4153
|
resource_target:
|
|
2740
4154
|
optional: false
|
|
2741
4155
|
variants:
|
|
@@ -2806,7 +4220,7 @@ paths:
|
|
|
2806
4220
|
summary: Remove a role assignment
|
|
2807
4221
|
tags:
|
|
2808
4222
|
- authorization
|
|
2809
|
-
x-mutually-exclusive-body-groups: &
|
|
4223
|
+
x-mutually-exclusive-body-groups: &ref_6
|
|
2810
4224
|
resource_target:
|
|
2811
4225
|
optional: false
|
|
2812
4226
|
variants:
|
|
@@ -5229,7 +6643,7 @@ paths:
|
|
|
5229
6643
|
summary: Create an authorization resource
|
|
5230
6644
|
tags:
|
|
5231
6645
|
- authorization
|
|
5232
|
-
x-mutually-exclusive-body-groups: &
|
|
6646
|
+
x-mutually-exclusive-body-groups: &ref_7
|
|
5233
6647
|
parent_resource:
|
|
5234
6648
|
optional: true
|
|
5235
6649
|
variants:
|
|
@@ -7368,7 +8782,7 @@ paths:
|
|
|
7368
8782
|
tags:
|
|
7369
8783
|
- connections
|
|
7370
8784
|
x-feature-flag: connections-api-migrations-capabilities-api
|
|
7371
|
-
x-mutually-exclusive-body-groups: &
|
|
8785
|
+
x-mutually-exclusive-body-groups: &ref_8
|
|
7372
8786
|
protocol_options:
|
|
7373
8787
|
optional: false
|
|
7374
8788
|
variants:
|
|
@@ -8596,7 +10010,7 @@ paths:
|
|
|
8596
10010
|
tags:
|
|
8597
10011
|
- connections
|
|
8598
10012
|
x-feature-flag: connections-api-migrations-capabilities-api
|
|
8599
|
-
x-mutually-exclusive-body-groups: &
|
|
10013
|
+
x-mutually-exclusive-body-groups: &ref_11
|
|
8600
10014
|
protocol_options:
|
|
8601
10015
|
optional: true
|
|
8602
10016
|
variants:
|
|
@@ -11550,6 +12964,14 @@ paths:
|
|
|
11550
12964
|
summary: Set Retention
|
|
11551
12965
|
tags:
|
|
11552
12966
|
- audit-logs
|
|
12967
|
+
x-mutually-exclusive-body-groups: &ref_3
|
|
12968
|
+
retention:
|
|
12969
|
+
optional: false
|
|
12970
|
+
variants:
|
|
12971
|
+
period:
|
|
12972
|
+
- retention_period
|
|
12973
|
+
period_in_days:
|
|
12974
|
+
- retention_period_in_days
|
|
11553
12975
|
/organizations/{organizationId}/api_keys:
|
|
11554
12976
|
get:
|
|
11555
12977
|
description: Get a list of all API keys for an organization.
|
|
@@ -17202,7 +18624,7 @@ paths:
|
|
|
17202
18624
|
summary: Create an organization membership
|
|
17203
18625
|
tags:
|
|
17204
18626
|
- user-management.organization-membership
|
|
17205
|
-
x-mutually-exclusive-body-groups: &
|
|
18627
|
+
x-mutually-exclusive-body-groups: &ref_15
|
|
17206
18628
|
role:
|
|
17207
18629
|
optional: true
|
|
17208
18630
|
variants:
|
|
@@ -17386,7 +18808,7 @@ paths:
|
|
|
17386
18808
|
summary: Update an organization membership
|
|
17387
18809
|
tags:
|
|
17388
18810
|
- user-management.organization-membership
|
|
17389
|
-
x-mutually-exclusive-body-groups: &
|
|
18811
|
+
x-mutually-exclusive-body-groups: &ref_16
|
|
17390
18812
|
role:
|
|
17391
18813
|
optional: true
|
|
17392
18814
|
variants:
|
|
@@ -18706,7 +20128,7 @@ paths:
|
|
|
18706
20128
|
summary: Create a user
|
|
18707
20129
|
tags:
|
|
18708
20130
|
- user-management.users
|
|
18709
|
-
x-mutually-exclusive-body-groups: &
|
|
20131
|
+
x-mutually-exclusive-body-groups: &ref_17
|
|
18710
20132
|
password:
|
|
18711
20133
|
optional: true
|
|
18712
20134
|
variants:
|
|
@@ -18999,7 +20421,7 @@ paths:
|
|
|
18999
20421
|
summary: Update a user
|
|
19000
20422
|
tags:
|
|
19001
20423
|
- user-management.users
|
|
19002
|
-
x-mutually-exclusive-body-groups: &
|
|
20424
|
+
x-mutually-exclusive-body-groups: &ref_21
|
|
19003
20425
|
password:
|
|
19004
20426
|
optional: true
|
|
19005
20427
|
variants:
|
|
@@ -22346,8 +23768,16 @@ info:
|
|
|
22346
23768
|
tags:
|
|
22347
23769
|
- name: admin-portal
|
|
22348
23770
|
description: Endpoints for the Admin Portal API.
|
|
22349
|
-
- name: agents
|
|
22350
|
-
description: Manage
|
|
23771
|
+
- name: agents.blueprints
|
|
23772
|
+
description: Manage agent blueprints.
|
|
23773
|
+
- name: agents.blueprints.tokens
|
|
23774
|
+
description: Mint and validate agent access tokens.
|
|
23775
|
+
- name: agents.instances
|
|
23776
|
+
description: Manage agent instances.
|
|
23777
|
+
- name: agents.registrations
|
|
23778
|
+
description: Register agents and validate agent credentials.
|
|
23779
|
+
- name: agents.sessions
|
|
23780
|
+
description: Manage agent instance sessions.
|
|
22351
23781
|
- name: api_keys
|
|
22352
23782
|
description: Manage API keys for environments.
|
|
22353
23783
|
- name: application.client-secrets
|
|
@@ -22563,6 +23993,13 @@ components:
|
|
|
22563
23993
|
required:
|
|
22564
23994
|
- external_auth_id
|
|
22565
23995
|
- user
|
|
23996
|
+
PaginationOrder:
|
|
23997
|
+
type: string
|
|
23998
|
+
enum:
|
|
23999
|
+
- normal
|
|
24000
|
+
- desc
|
|
24001
|
+
- asc
|
|
24002
|
+
example: desc
|
|
22566
24003
|
ValidateApiKeyDto:
|
|
22567
24004
|
type: object
|
|
22568
24005
|
properties:
|
|
@@ -22585,13 +24022,6 @@ components:
|
|
|
22585
24022
|
expiration.
|
|
22586
24023
|
example: '2030-01-01T00:00:00.000Z'
|
|
22587
24024
|
format: date-time
|
|
22588
|
-
PaginationOrder:
|
|
22589
|
-
type: string
|
|
22590
|
-
enum:
|
|
22591
|
-
- normal
|
|
22592
|
-
- desc
|
|
22593
|
-
- asc
|
|
22594
|
-
example: desc
|
|
22595
24025
|
RedirectUriDto:
|
|
22596
24026
|
type: object
|
|
22597
24027
|
properties:
|
|
@@ -22922,16 +24352,70 @@ components:
|
|
|
22922
24352
|
- range_start
|
|
22923
24353
|
- range_end
|
|
22924
24354
|
UpdateAuditLogsRetentionDto:
|
|
22925
|
-
|
|
22926
|
-
|
|
22927
|
-
|
|
22928
|
-
|
|
22929
|
-
|
|
22930
|
-
|
|
22931
|
-
|
|
22932
|
-
|
|
22933
|
-
|
|
22934
|
-
|
|
24355
|
+
x-mutually-exclusive-body-groups: *ref_3
|
|
24356
|
+
oneOf:
|
|
24357
|
+
- type: object
|
|
24358
|
+
properties:
|
|
24359
|
+
retention_period:
|
|
24360
|
+
enum:
|
|
24361
|
+
- 1_MONTH
|
|
24362
|
+
- 2_MONTHS
|
|
24363
|
+
- 3_MONTHS
|
|
24364
|
+
- 4_MONTHS
|
|
24365
|
+
- 5_MONTHS
|
|
24366
|
+
- 6_MONTHS
|
|
24367
|
+
- 7_MONTHS
|
|
24368
|
+
- 8_MONTHS
|
|
24369
|
+
- 9_MONTHS
|
|
24370
|
+
- 10_MONTHS
|
|
24371
|
+
- 11_MONTHS
|
|
24372
|
+
- 1_YEAR
|
|
24373
|
+
- 2_YEARS
|
|
24374
|
+
- 3_YEARS
|
|
24375
|
+
- 4_YEARS
|
|
24376
|
+
- 5_YEARS
|
|
24377
|
+
- 6_YEARS
|
|
24378
|
+
- 7_YEARS
|
|
24379
|
+
- 8_YEARS
|
|
24380
|
+
- 9_YEARS
|
|
24381
|
+
- 10_YEARS
|
|
24382
|
+
type: string
|
|
24383
|
+
description: >-
|
|
24384
|
+
The period Audit Log events will be retained. Valid values are
|
|
24385
|
+
`1_MONTH` through `11_MONTHS` in one-month increments and
|
|
24386
|
+
`1_YEAR` through `10_YEARS` in one-year increments. Mutually
|
|
24387
|
+
exclusive with `retention_period_in_days`.
|
|
24388
|
+
example: 1_MONTH
|
|
24389
|
+
required:
|
|
24390
|
+
- retention_period
|
|
24391
|
+
not:
|
|
24392
|
+
anyOf:
|
|
24393
|
+
- properties:
|
|
24394
|
+
retention_period_in_days:
|
|
24395
|
+
x-exclude-from-lint: true
|
|
24396
|
+
required:
|
|
24397
|
+
- retention_period_in_days
|
|
24398
|
+
- type: object
|
|
24399
|
+
properties:
|
|
24400
|
+
retention_period_in_days:
|
|
24401
|
+
type: integer
|
|
24402
|
+
description: >-
|
|
24403
|
+
The number of days Audit Log events will be retained. Valid
|
|
24404
|
+
values are `30` through `330` in 30-day increments and `365`
|
|
24405
|
+
through `3650` in 365-day increments. Deprecated: use
|
|
24406
|
+
`retention_period` instead. Mutually exclusive with
|
|
24407
|
+
`retention_period`.
|
|
24408
|
+
example: 30
|
|
24409
|
+
deprecated: true
|
|
24410
|
+
required:
|
|
24411
|
+
- retention_period_in_days
|
|
24412
|
+
not:
|
|
24413
|
+
anyOf:
|
|
24414
|
+
- properties:
|
|
24415
|
+
retention_period:
|
|
24416
|
+
x-exclude-from-lint: true
|
|
24417
|
+
required:
|
|
24418
|
+
- retention_period
|
|
22935
24419
|
AuditLogSchemaActorDto:
|
|
22936
24420
|
type: object
|
|
22937
24421
|
properties:
|
|
@@ -23051,7 +24535,7 @@ components:
|
|
|
23051
24535
|
x-exclude-from-lint: true
|
|
23052
24536
|
required:
|
|
23053
24537
|
- resource_id
|
|
23054
|
-
x-mutually-exclusive-body-groups: *
|
|
24538
|
+
x-mutually-exclusive-body-groups: *ref_4
|
|
23055
24539
|
CreateGroupRoleAssignmentDto:
|
|
23056
24540
|
type: object
|
|
23057
24541
|
properties:
|
|
@@ -23192,7 +24676,7 @@ components:
|
|
|
23192
24676
|
x-exclude-from-lint: true
|
|
23193
24677
|
required:
|
|
23194
24678
|
- resource_id
|
|
23195
|
-
x-mutually-exclusive-body-groups: *
|
|
24679
|
+
x-mutually-exclusive-body-groups: *ref_5
|
|
23196
24680
|
RemoveRoleDto:
|
|
23197
24681
|
allOf:
|
|
23198
24682
|
- type: object
|
|
@@ -23251,7 +24735,7 @@ components:
|
|
|
23251
24735
|
x-exclude-from-lint: true
|
|
23252
24736
|
required:
|
|
23253
24737
|
- resource_id
|
|
23254
|
-
x-mutually-exclusive-body-groups: *
|
|
24738
|
+
x-mutually-exclusive-body-groups: *ref_6
|
|
23255
24739
|
SetRolePermissionsDto:
|
|
23256
24740
|
type: object
|
|
23257
24741
|
properties:
|
|
@@ -23601,7 +25085,7 @@ components:
|
|
|
23601
25085
|
x-exclude-from-lint: true
|
|
23602
25086
|
required:
|
|
23603
25087
|
- parent_resource_id
|
|
23604
|
-
x-mutually-exclusive-body-groups: *
|
|
25088
|
+
x-mutually-exclusive-body-groups: *ref_7
|
|
23605
25089
|
CreateConnectionKeyPairDto:
|
|
23606
25090
|
type: object
|
|
23607
25091
|
properties:
|
|
@@ -23718,7 +25202,7 @@ components:
|
|
|
23718
25202
|
default: true
|
|
23719
25203
|
token_authentication_method:
|
|
23720
25204
|
type: string
|
|
23721
|
-
enum: &
|
|
25205
|
+
enum: &ref_9
|
|
23722
25206
|
- client_secret_post
|
|
23723
25207
|
- client_secret_basic
|
|
23724
25208
|
- private_key_jwt
|
|
@@ -23734,7 +25218,7 @@ components:
|
|
|
23734
25218
|
$ref: '#/components/schemas/CreateConnectionKeyPairDto'
|
|
23735
25219
|
id_token_signature_algorithm:
|
|
23736
25220
|
type: string
|
|
23737
|
-
enum: &
|
|
25221
|
+
enum: &ref_10
|
|
23738
25222
|
- ES256
|
|
23739
25223
|
- ES384
|
|
23740
25224
|
- ES512
|
|
@@ -23890,7 +25374,7 @@ components:
|
|
|
23890
25374
|
x-exclude-from-lint: true
|
|
23891
25375
|
required:
|
|
23892
25376
|
- saml_options
|
|
23893
|
-
x-mutually-exclusive-body-groups: *
|
|
25377
|
+
x-mutually-exclusive-body-groups: *ref_8
|
|
23894
25378
|
PatchConnectionSamlOptionsDto:
|
|
23895
25379
|
type: object
|
|
23896
25380
|
properties:
|
|
@@ -23966,7 +25450,7 @@ components:
|
|
|
23966
25450
|
example: true
|
|
23967
25451
|
token_authentication_method:
|
|
23968
25452
|
type: string
|
|
23969
|
-
enum: *
|
|
25453
|
+
enum: *ref_9
|
|
23970
25454
|
description: >-
|
|
23971
25455
|
The token-endpoint client authentication method. Moving to
|
|
23972
25456
|
`private_key_jwt` generates a signing key pair if the connection has
|
|
@@ -23976,7 +25460,7 @@ components:
|
|
|
23976
25460
|
example: client_secret_basic
|
|
23977
25461
|
id_token_signature_algorithm:
|
|
23978
25462
|
type: string
|
|
23979
|
-
enum: *
|
|
25463
|
+
enum: *ref_10
|
|
23980
25464
|
description: The ID-token signing algorithm.
|
|
23981
25465
|
example: RS256
|
|
23982
25466
|
fetch_user_info:
|
|
@@ -24120,7 +25604,7 @@ components:
|
|
|
24120
25604
|
x-exclude-from-lint: true
|
|
24121
25605
|
required:
|
|
24122
25606
|
- saml_options
|
|
24123
|
-
x-mutually-exclusive-body-groups: *
|
|
25607
|
+
x-mutually-exclusive-body-groups: *ref_11
|
|
24124
25608
|
CreateCorsOriginDto:
|
|
24125
25609
|
type: object
|
|
24126
25610
|
properties:
|
|
@@ -24302,11 +25786,11 @@ components:
|
|
|
24302
25786
|
type:
|
|
24303
25787
|
- object
|
|
24304
25788
|
- 'null'
|
|
24305
|
-
additionalProperties: &
|
|
25789
|
+
additionalProperties: &ref_12
|
|
24306
25790
|
type: string
|
|
24307
25791
|
maxLength: 600
|
|
24308
25792
|
maxProperties: 50
|
|
24309
|
-
example: &
|
|
25793
|
+
example: &ref_13
|
|
24310
25794
|
tier: diamond
|
|
24311
25795
|
description: >-
|
|
24312
25796
|
Object containing [metadata](/authkit/metadata) key/value pairs
|
|
@@ -24361,9 +25845,9 @@ components:
|
|
|
24361
25845
|
type:
|
|
24362
25846
|
- object
|
|
24363
25847
|
- 'null'
|
|
24364
|
-
additionalProperties: *
|
|
25848
|
+
additionalProperties: *ref_12
|
|
24365
25849
|
maxProperties: 50
|
|
24366
|
-
example: *
|
|
25850
|
+
example: *ref_13
|
|
24367
25851
|
description: >-
|
|
24368
25852
|
Object containing [metadata](/authkit/metadata) key/value pairs
|
|
24369
25853
|
associated with the Organization.
|
|
@@ -24497,7 +25981,7 @@ components:
|
|
|
24497
25981
|
example: application/x-www-form-urlencoded
|
|
24498
25982
|
authenticate_via:
|
|
24499
25983
|
type: string
|
|
24500
|
-
enum: &
|
|
25984
|
+
enum: &ref_14
|
|
24501
25985
|
- request_body
|
|
24502
25986
|
- basic_auth_header
|
|
24503
25987
|
description: >-
|
|
@@ -24653,7 +26137,7 @@ components:
|
|
|
24653
26137
|
example: application/x-www-form-urlencoded
|
|
24654
26138
|
authenticate_via:
|
|
24655
26139
|
type: string
|
|
24656
|
-
enum: *
|
|
26140
|
+
enum: *ref_14
|
|
24657
26141
|
description: >-
|
|
24658
26142
|
How client credentials are sent when exchanging authorization codes
|
|
24659
26143
|
and refreshing tokens.
|
|
@@ -25218,9 +26702,9 @@ components:
|
|
|
25218
26702
|
x-exclude-from-lint: true
|
|
25219
26703
|
required:
|
|
25220
26704
|
- role_slug
|
|
25221
|
-
x-mutually-exclusive-body-groups: *ref_14
|
|
25222
|
-
UpdateUserlandUserOrganizationMembershipDto:
|
|
25223
26705
|
x-mutually-exclusive-body-groups: *ref_15
|
|
26706
|
+
UpdateUserlandUserOrganizationMembershipDto:
|
|
26707
|
+
x-mutually-exclusive-body-groups: *ref_16
|
|
25224
26708
|
oneOf:
|
|
25225
26709
|
- type: object
|
|
25226
26710
|
not:
|
|
@@ -25342,9 +26826,9 @@ components:
|
|
|
25342
26826
|
type:
|
|
25343
26827
|
- object
|
|
25344
26828
|
- 'null'
|
|
25345
|
-
additionalProperties: *
|
|
26829
|
+
additionalProperties: *ref_12
|
|
25346
26830
|
maxProperties: 50
|
|
25347
|
-
example: &
|
|
26831
|
+
example: &ref_18
|
|
25348
26832
|
timezone: America/New_York
|
|
25349
26833
|
description: >-
|
|
25350
26834
|
Object containing metadata key/value pairs associated with the
|
|
@@ -25443,7 +26927,7 @@ components:
|
|
|
25443
26927
|
example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
|
|
25444
26928
|
password_hash_type:
|
|
25445
26929
|
type: string
|
|
25446
|
-
enum: &
|
|
26930
|
+
enum: &ref_19
|
|
25447
26931
|
- bcrypt
|
|
25448
26932
|
- firebase-scrypt
|
|
25449
26933
|
- ssha
|
|
@@ -25458,7 +26942,7 @@ components:
|
|
|
25458
26942
|
example: bcrypt
|
|
25459
26943
|
password_salt_position:
|
|
25460
26944
|
type: string
|
|
25461
|
-
enum: &
|
|
26945
|
+
enum: &ref_20
|
|
25462
26946
|
- prefix
|
|
25463
26947
|
- suffix
|
|
25464
26948
|
description: >-
|
|
@@ -25479,7 +26963,7 @@ components:
|
|
|
25479
26963
|
x-exclude-from-lint: true
|
|
25480
26964
|
required:
|
|
25481
26965
|
- password
|
|
25482
|
-
x-mutually-exclusive-body-groups: *
|
|
26966
|
+
x-mutually-exclusive-body-groups: *ref_17
|
|
25483
26967
|
UpdateUserlandUserDto:
|
|
25484
26968
|
allOf:
|
|
25485
26969
|
- type: object
|
|
@@ -25509,9 +26993,9 @@ components:
|
|
|
25509
26993
|
type:
|
|
25510
26994
|
- object
|
|
25511
26995
|
- 'null'
|
|
25512
|
-
additionalProperties: *
|
|
26996
|
+
additionalProperties: *ref_12
|
|
25513
26997
|
maxProperties: 50
|
|
25514
|
-
example: *
|
|
26998
|
+
example: *ref_18
|
|
25515
26999
|
description: >-
|
|
25516
27000
|
Object containing metadata key/value pairs associated with the
|
|
25517
27001
|
user.
|
|
@@ -25593,7 +27077,7 @@ components:
|
|
|
25593
27077
|
example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
|
|
25594
27078
|
password_hash_type:
|
|
25595
27079
|
type: string
|
|
25596
|
-
enum: *
|
|
27080
|
+
enum: *ref_19
|
|
25597
27081
|
description: >-
|
|
25598
27082
|
The algorithm originally used to hash the password, used
|
|
25599
27083
|
when providing a `password_hash`. Required with
|
|
@@ -25601,7 +27085,7 @@ components:
|
|
|
25601
27085
|
example: bcrypt
|
|
25602
27086
|
password_salt_position:
|
|
25603
27087
|
type: string
|
|
25604
|
-
enum: *
|
|
27088
|
+
enum: *ref_20
|
|
25605
27089
|
description: >-
|
|
25606
27090
|
The position of the salt relative to the password when the
|
|
25607
27091
|
`password_hash` digest was computed: `prefix` for `hash(salt
|
|
@@ -25620,7 +27104,7 @@ components:
|
|
|
25620
27104
|
x-exclude-from-lint: true
|
|
25621
27105
|
required:
|
|
25622
27106
|
- password
|
|
25623
|
-
x-mutually-exclusive-body-groups: *
|
|
27107
|
+
x-mutually-exclusive-body-groups: *ref_21
|
|
25624
27108
|
VerifyEmailAddressDto:
|
|
25625
27109
|
type: object
|
|
25626
27110
|
properties:
|
|
@@ -25727,7 +27211,7 @@ components:
|
|
|
25727
27211
|
description: The events that the Webhook Endpoint is subscribed to.
|
|
25728
27212
|
items:
|
|
25729
27213
|
type: string
|
|
25730
|
-
enum: &
|
|
27214
|
+
enum: &ref_22
|
|
25731
27215
|
- agent.blueprint.created
|
|
25732
27216
|
- agent.blueprint.deleted
|
|
25733
27217
|
- agent.blueprint.updated
|
|
@@ -25853,7 +27337,7 @@ components:
|
|
|
25853
27337
|
description: The events that the Webhook Endpoint is subscribed to.
|
|
25854
27338
|
items:
|
|
25855
27339
|
type: string
|
|
25856
|
-
enum: *
|
|
27340
|
+
enum: *ref_22
|
|
25857
27341
|
example:
|
|
25858
27342
|
- user.created
|
|
25859
27343
|
- dsync.user.created
|
|
@@ -26544,6 +28028,268 @@ components:
|
|
|
26544
28028
|
- status
|
|
26545
28029
|
- user_code
|
|
26546
28030
|
- organizations
|
|
28031
|
+
AgentBlueprint:
|
|
28032
|
+
type: object
|
|
28033
|
+
properties:
|
|
28034
|
+
object:
|
|
28035
|
+
type: string
|
|
28036
|
+
description: Distinguishes the agent blueprint object.
|
|
28037
|
+
const: agent_blueprint
|
|
28038
|
+
id:
|
|
28039
|
+
type: string
|
|
28040
|
+
description: Unique identifier of the agent blueprint.
|
|
28041
|
+
example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28042
|
+
name:
|
|
28043
|
+
type: string
|
|
28044
|
+
description: Human-readable name of the agent blueprint.
|
|
28045
|
+
example: Prospecting Agent
|
|
28046
|
+
description:
|
|
28047
|
+
type:
|
|
28048
|
+
- string
|
|
28049
|
+
- 'null'
|
|
28050
|
+
description: Human-readable description of the agent blueprint.
|
|
28051
|
+
example: Finds and qualifies sales prospects.
|
|
28052
|
+
permissions:
|
|
28053
|
+
type: array
|
|
28054
|
+
items:
|
|
28055
|
+
type: string
|
|
28056
|
+
description: >-
|
|
28057
|
+
Permission slugs forming the ceiling on what sessions minted from
|
|
28058
|
+
this blueprint may do.
|
|
28059
|
+
example:
|
|
28060
|
+
- crm:read
|
|
28061
|
+
- email:send
|
|
28062
|
+
invocable_by:
|
|
28063
|
+
type: object
|
|
28064
|
+
properties:
|
|
28065
|
+
role_slugs:
|
|
28066
|
+
type: array
|
|
28067
|
+
items:
|
|
28068
|
+
type: string
|
|
28069
|
+
description: >-
|
|
28070
|
+
Role slugs whose members may mint user-delegated sessions from
|
|
28071
|
+
this blueprint.
|
|
28072
|
+
example:
|
|
28073
|
+
- manager
|
|
28074
|
+
organization_ids:
|
|
28075
|
+
type: array
|
|
28076
|
+
items:
|
|
28077
|
+
type: string
|
|
28078
|
+
description: >-
|
|
28079
|
+
Organizations in which sessions may be minted from this
|
|
28080
|
+
blueprint, enforced on user-delegated, autonomous, and
|
|
28081
|
+
agent-delegated mints.
|
|
28082
|
+
example:
|
|
28083
|
+
- org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28084
|
+
required:
|
|
28085
|
+
- role_slugs
|
|
28086
|
+
- organization_ids
|
|
28087
|
+
description: Who may mint sessions from this blueprint.
|
|
28088
|
+
session_settings:
|
|
28089
|
+
type: object
|
|
28090
|
+
properties:
|
|
28091
|
+
max_age_seconds:
|
|
28092
|
+
type: integer
|
|
28093
|
+
description: >-
|
|
28094
|
+
Maximum lifetime of a session in seconds; refreshes never extend
|
|
28095
|
+
a session past this.
|
|
28096
|
+
example: 3600
|
|
28097
|
+
access_token_ttl_seconds:
|
|
28098
|
+
type: integer
|
|
28099
|
+
description: Lifetime of each minted access token in seconds.
|
|
28100
|
+
example: 300
|
|
28101
|
+
refresh_token_ttl_seconds:
|
|
28102
|
+
type: integer
|
|
28103
|
+
description: Lifetime of each rotated refresh token in seconds.
|
|
28104
|
+
example: 3600
|
|
28105
|
+
required:
|
|
28106
|
+
- max_age_seconds
|
|
28107
|
+
- access_token_ttl_seconds
|
|
28108
|
+
- refresh_token_ttl_seconds
|
|
28109
|
+
description: Token and session lifetimes for sessions minted from this blueprint.
|
|
28110
|
+
created_at:
|
|
28111
|
+
type: string
|
|
28112
|
+
format: date-time
|
|
28113
|
+
description: Timestamp when the agent blueprint was created.
|
|
28114
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
28115
|
+
updated_at:
|
|
28116
|
+
type: string
|
|
28117
|
+
format: date-time
|
|
28118
|
+
description: Timestamp when the agent blueprint was last updated.
|
|
28119
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
28120
|
+
required:
|
|
28121
|
+
- object
|
|
28122
|
+
- id
|
|
28123
|
+
- name
|
|
28124
|
+
- description
|
|
28125
|
+
- permissions
|
|
28126
|
+
- invocable_by
|
|
28127
|
+
- session_settings
|
|
28128
|
+
- created_at
|
|
28129
|
+
- updated_at
|
|
28130
|
+
AgentInstance:
|
|
28131
|
+
type: object
|
|
28132
|
+
properties:
|
|
28133
|
+
object:
|
|
28134
|
+
type: string
|
|
28135
|
+
description: Distinguishes the agent instance object.
|
|
28136
|
+
const: agent_instance
|
|
28137
|
+
id:
|
|
28138
|
+
type: string
|
|
28139
|
+
description: Unique identifier of the agent instance.
|
|
28140
|
+
example: agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28141
|
+
agent_blueprint_id:
|
|
28142
|
+
type: string
|
|
28143
|
+
description: The blueprint this instance was minted from.
|
|
28144
|
+
example: agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28145
|
+
organization_id:
|
|
28146
|
+
type: string
|
|
28147
|
+
description: The organization the instance acts within.
|
|
28148
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28149
|
+
organization_membership_id:
|
|
28150
|
+
type:
|
|
28151
|
+
- string
|
|
28152
|
+
- 'null'
|
|
28153
|
+
description: >-
|
|
28154
|
+
The organization membership of the delegating user; `null` for
|
|
28155
|
+
autonomous instances.
|
|
28156
|
+
example: om_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28157
|
+
type:
|
|
28158
|
+
type: string
|
|
28159
|
+
enum:
|
|
28160
|
+
- delegated
|
|
28161
|
+
- autonomous
|
|
28162
|
+
description: >-
|
|
28163
|
+
Whether the instance acts on behalf of a specific user (`delegated`)
|
|
28164
|
+
or as itself (`autonomous`).
|
|
28165
|
+
created_at:
|
|
28166
|
+
type: string
|
|
28167
|
+
format: date-time
|
|
28168
|
+
description: Timestamp when the agent instance was created.
|
|
28169
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
28170
|
+
updated_at:
|
|
28171
|
+
type: string
|
|
28172
|
+
format: date-time
|
|
28173
|
+
description: Timestamp when the agent instance was last updated.
|
|
28174
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
28175
|
+
required:
|
|
28176
|
+
- object
|
|
28177
|
+
- id
|
|
28178
|
+
- agent_blueprint_id
|
|
28179
|
+
- organization_id
|
|
28180
|
+
- organization_membership_id
|
|
28181
|
+
- type
|
|
28182
|
+
- created_at
|
|
28183
|
+
- updated_at
|
|
28184
|
+
AgentToken:
|
|
28185
|
+
type: object
|
|
28186
|
+
properties:
|
|
28187
|
+
access_token:
|
|
28188
|
+
type: string
|
|
28189
|
+
description: The agent access token (a JWT) carrying the effective permissions.
|
|
28190
|
+
example: eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
28191
|
+
token_type:
|
|
28192
|
+
type: string
|
|
28193
|
+
description: Always `Bearer`.
|
|
28194
|
+
const: Bearer
|
|
28195
|
+
expires_in:
|
|
28196
|
+
type: integer
|
|
28197
|
+
description: Number of seconds until the access token expires.
|
|
28198
|
+
example: 300
|
|
28199
|
+
refresh_token:
|
|
28200
|
+
type: string
|
|
28201
|
+
description: >-
|
|
28202
|
+
Single-use refresh token for rotating the access token within the
|
|
28203
|
+
session lifetime.
|
|
28204
|
+
example: njGkA8Wyht0GBEGGA0Zh1Q3wZzL2...
|
|
28205
|
+
agent_instance_id:
|
|
28206
|
+
type: string
|
|
28207
|
+
description: The agent instance the session belongs to.
|
|
28208
|
+
example: agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28209
|
+
new_instance:
|
|
28210
|
+
type: boolean
|
|
28211
|
+
description: >-
|
|
28212
|
+
Whether this mint created the agent instance: `true` only for the
|
|
28213
|
+
mint that inserted the row, `false` when an existing instance was
|
|
28214
|
+
reused (including when a concurrent mint inserted it first).
|
|
28215
|
+
example: false
|
|
28216
|
+
agent_instance_session_id:
|
|
28217
|
+
type: string
|
|
28218
|
+
description: The backing agent instance session.
|
|
28219
|
+
example: agent_session_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28220
|
+
permissions:
|
|
28221
|
+
type: array
|
|
28222
|
+
items:
|
|
28223
|
+
type: string
|
|
28224
|
+
description: The effective permission slugs carried by the token.
|
|
28225
|
+
example:
|
|
28226
|
+
- crm:read
|
|
28227
|
+
required:
|
|
28228
|
+
- access_token
|
|
28229
|
+
- token_type
|
|
28230
|
+
- expires_in
|
|
28231
|
+
- refresh_token
|
|
28232
|
+
- agent_instance_id
|
|
28233
|
+
- new_instance
|
|
28234
|
+
- agent_instance_session_id
|
|
28235
|
+
- permissions
|
|
28236
|
+
AgentInstanceSession:
|
|
28237
|
+
type: object
|
|
28238
|
+
properties:
|
|
28239
|
+
object:
|
|
28240
|
+
type: string
|
|
28241
|
+
description: Distinguishes the agent instance session object.
|
|
28242
|
+
const: agent_instance_session
|
|
28243
|
+
id:
|
|
28244
|
+
type: string
|
|
28245
|
+
description: Unique identifier of the agent instance session.
|
|
28246
|
+
example: agent_session_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28247
|
+
agent_instance_id:
|
|
28248
|
+
type: string
|
|
28249
|
+
description: The agent instance the session belongs to.
|
|
28250
|
+
example: agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
28251
|
+
status:
|
|
28252
|
+
type: string
|
|
28253
|
+
enum:
|
|
28254
|
+
- active
|
|
28255
|
+
- revoked
|
|
28256
|
+
- expired
|
|
28257
|
+
description: >-
|
|
28258
|
+
Derived from `revoked_at` and `expires_at` at read time; a revoked
|
|
28259
|
+
session stays `revoked` even after it expires.
|
|
28260
|
+
expires_at:
|
|
28261
|
+
type: string
|
|
28262
|
+
format: date-time
|
|
28263
|
+
description: Timestamp when the session expires.
|
|
28264
|
+
example: '2026-01-15T13:00:00.000Z'
|
|
28265
|
+
revoked_at:
|
|
28266
|
+
type:
|
|
28267
|
+
- string
|
|
28268
|
+
- 'null'
|
|
28269
|
+
format: date-time
|
|
28270
|
+
description: >-
|
|
28271
|
+
Timestamp when the session was revoked; `null` if it has not been
|
|
28272
|
+
revoked.
|
|
28273
|
+
example: null
|
|
28274
|
+
created_at:
|
|
28275
|
+
type: string
|
|
28276
|
+
format: date-time
|
|
28277
|
+
description: Timestamp when the session was created.
|
|
28278
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
28279
|
+
updated_at:
|
|
28280
|
+
type: string
|
|
28281
|
+
format: date-time
|
|
28282
|
+
description: Timestamp when the session was last updated.
|
|
28283
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
28284
|
+
required:
|
|
28285
|
+
- object
|
|
28286
|
+
- id
|
|
28287
|
+
- agent_instance_id
|
|
28288
|
+
- status
|
|
28289
|
+
- expires_at
|
|
28290
|
+
- revoked_at
|
|
28291
|
+
- created_at
|
|
28292
|
+
- updated_at
|
|
26547
28293
|
ApiKey:
|
|
26548
28294
|
type: object
|
|
26549
28295
|
properties:
|
|
@@ -29179,7 +30925,7 @@ components:
|
|
|
29179
30925
|
description: >-
|
|
29180
30926
|
An object containing the custom attribute mapping for the Directory
|
|
29181
30927
|
Provider.
|
|
29182
|
-
example: &
|
|
30928
|
+
example: &ref_28
|
|
29183
30929
|
department: Engineering
|
|
29184
30930
|
job_title: Software Engineer
|
|
29185
30931
|
role:
|
|
@@ -29373,7 +31119,7 @@ components:
|
|
|
29373
31119
|
type: object
|
|
29374
31120
|
additionalProperties: {}
|
|
29375
31121
|
description: The event payload.
|
|
29376
|
-
example: &
|
|
31122
|
+
example: &ref_23
|
|
29377
31123
|
id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
|
|
29378
31124
|
directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
|
|
29379
31125
|
organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
|
|
@@ -29408,11 +31154,11 @@ components:
|
|
|
29408
31154
|
- data
|
|
29409
31155
|
- created_at
|
|
29410
31156
|
description: An event emitted by WorkOS.
|
|
29411
|
-
example: &
|
|
31157
|
+
example: &ref_33
|
|
29412
31158
|
object: event
|
|
29413
31159
|
id: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
29414
31160
|
event: dsync.user.created
|
|
29415
|
-
data: *
|
|
31161
|
+
data: *ref_23
|
|
29416
31162
|
created_at: '2021-06-25T19:07:33.155Z'
|
|
29417
31163
|
context: {}
|
|
29418
31164
|
- oneOf:
|
|
@@ -29612,7 +31358,7 @@ components:
|
|
|
29612
31358
|
description: >-
|
|
29613
31359
|
Permission slugs forming the ceiling on what sessions
|
|
29614
31360
|
minted from this blueprint may do.
|
|
29615
|
-
example: &
|
|
31361
|
+
example: &ref_24
|
|
29616
31362
|
- crm:read
|
|
29617
31363
|
- email:send
|
|
29618
31364
|
invocable_by:
|
|
@@ -29625,7 +31371,7 @@ components:
|
|
|
29625
31371
|
description: >-
|
|
29626
31372
|
Role slugs whose members may mint user-delegated
|
|
29627
31373
|
sessions from this blueprint.
|
|
29628
|
-
example: &
|
|
31374
|
+
example: &ref_25
|
|
29629
31375
|
- manager
|
|
29630
31376
|
organization_ids:
|
|
29631
31377
|
type: array
|
|
@@ -29634,7 +31380,7 @@ components:
|
|
|
29634
31380
|
description: >-
|
|
29635
31381
|
Organizations in which autonomous sessions may be
|
|
29636
31382
|
minted from this blueprint.
|
|
29637
|
-
example: &
|
|
31383
|
+
example: &ref_26
|
|
29638
31384
|
- org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
29639
31385
|
required:
|
|
29640
31386
|
- role_slugs
|
|
@@ -29793,7 +31539,7 @@ components:
|
|
|
29793
31539
|
description: >-
|
|
29794
31540
|
Permission slugs forming the ceiling on what sessions
|
|
29795
31541
|
minted from this blueprint may do.
|
|
29796
|
-
example: *
|
|
31542
|
+
example: *ref_24
|
|
29797
31543
|
invocable_by:
|
|
29798
31544
|
type: object
|
|
29799
31545
|
properties:
|
|
@@ -29804,7 +31550,7 @@ components:
|
|
|
29804
31550
|
description: >-
|
|
29805
31551
|
Role slugs whose members may mint user-delegated
|
|
29806
31552
|
sessions from this blueprint.
|
|
29807
|
-
example: *
|
|
31553
|
+
example: *ref_25
|
|
29808
31554
|
organization_ids:
|
|
29809
31555
|
type: array
|
|
29810
31556
|
items:
|
|
@@ -29812,7 +31558,7 @@ components:
|
|
|
29812
31558
|
description: >-
|
|
29813
31559
|
Organizations in which autonomous sessions may be
|
|
29814
31560
|
minted from this blueprint.
|
|
29815
|
-
example: *
|
|
31561
|
+
example: *ref_26
|
|
29816
31562
|
required:
|
|
29817
31563
|
- role_slugs
|
|
29818
31564
|
- organization_ids
|
|
@@ -30848,7 +32594,7 @@ components:
|
|
|
30848
32594
|
items:
|
|
30849
32595
|
type: string
|
|
30850
32596
|
description: The permissions granted to the API key.
|
|
30851
|
-
example: &
|
|
32597
|
+
example: &ref_27
|
|
30852
32598
|
- users:read
|
|
30853
32599
|
- users:write
|
|
30854
32600
|
created_at:
|
|
@@ -30974,7 +32720,7 @@ components:
|
|
|
30974
32720
|
items:
|
|
30975
32721
|
type: string
|
|
30976
32722
|
description: The permissions granted to the API key.
|
|
30977
|
-
example: *
|
|
32723
|
+
example: *ref_27
|
|
30978
32724
|
created_at:
|
|
30979
32725
|
type: string
|
|
30980
32726
|
description: The timestamp when the API key was created.
|
|
@@ -31098,7 +32844,7 @@ components:
|
|
|
31098
32844
|
items:
|
|
31099
32845
|
type: string
|
|
31100
32846
|
description: The permissions granted to the API key.
|
|
31101
|
-
example: *
|
|
32847
|
+
example: *ref_27
|
|
31102
32848
|
created_at:
|
|
31103
32849
|
type: string
|
|
31104
32850
|
description: The timestamp when the API key was created.
|
|
@@ -33965,7 +35711,7 @@ components:
|
|
|
33965
35711
|
description: >-
|
|
33966
35712
|
An object containing the custom attribute mapping for
|
|
33967
35713
|
the Directory Provider.
|
|
33968
|
-
example: *
|
|
35714
|
+
example: *ref_28
|
|
33969
35715
|
role:
|
|
33970
35716
|
$ref: '#/components/schemas/SlimRole'
|
|
33971
35717
|
roles:
|
|
@@ -34155,7 +35901,7 @@ components:
|
|
|
34155
35901
|
description: >-
|
|
34156
35902
|
Labels assigned to the Feature Flag for categorizing and
|
|
34157
35903
|
filtering.
|
|
34158
|
-
example: &
|
|
35904
|
+
example: &ref_29
|
|
34159
35905
|
- reports
|
|
34160
35906
|
enabled:
|
|
34161
35907
|
type: boolean
|
|
@@ -34316,7 +36062,7 @@ components:
|
|
|
34316
36062
|
description: >-
|
|
34317
36063
|
Labels assigned to the Feature Flag for categorizing and
|
|
34318
36064
|
filtering.
|
|
34319
|
-
example: *
|
|
36065
|
+
example: *ref_29
|
|
34320
36066
|
enabled:
|
|
34321
36067
|
type: boolean
|
|
34322
36068
|
description: >-
|
|
@@ -34476,7 +36222,7 @@ components:
|
|
|
34476
36222
|
description: >-
|
|
34477
36223
|
Labels assigned to the Feature Flag for categorizing and
|
|
34478
36224
|
filtering.
|
|
34479
|
-
example: *
|
|
36225
|
+
example: *ref_29
|
|
34480
36226
|
enabled:
|
|
34481
36227
|
type: boolean
|
|
34482
36228
|
description: >-
|
|
@@ -34756,7 +36502,7 @@ components:
|
|
|
34756
36502
|
description: >-
|
|
34757
36503
|
Labels assigned to the Feature Flag for categorizing and
|
|
34758
36504
|
filtering.
|
|
34759
|
-
example: *
|
|
36505
|
+
example: *ref_29
|
|
34760
36506
|
enabled:
|
|
34761
36507
|
type: boolean
|
|
34762
36508
|
description: >-
|
|
@@ -35744,7 +37490,7 @@ components:
|
|
|
35744
37490
|
description: >-
|
|
35745
37491
|
Object containing [metadata](/authkit/metadata)
|
|
35746
37492
|
key/value pairs associated with the Organization.
|
|
35747
|
-
example: &
|
|
37493
|
+
example: &ref_30
|
|
35748
37494
|
tier: diamond
|
|
35749
37495
|
propertyNames:
|
|
35750
37496
|
maxLength: 40
|
|
@@ -35894,7 +37640,7 @@ components:
|
|
|
35894
37640
|
description: >-
|
|
35895
37641
|
Object containing [metadata](/authkit/metadata)
|
|
35896
37642
|
key/value pairs associated with the Organization.
|
|
35897
|
-
example: *
|
|
37643
|
+
example: *ref_30
|
|
35898
37644
|
propertyNames:
|
|
35899
37645
|
maxLength: 40
|
|
35900
37646
|
maxProperties: 50
|
|
@@ -36721,7 +38467,7 @@ components:
|
|
|
36721
38467
|
items:
|
|
36722
38468
|
type: string
|
|
36723
38469
|
description: The permissions granted by the role.
|
|
36724
|
-
example: &
|
|
38470
|
+
example: &ref_31
|
|
36725
38471
|
- users:read
|
|
36726
38472
|
- users:write
|
|
36727
38473
|
created_at:
|
|
@@ -36805,7 +38551,7 @@ components:
|
|
|
36805
38551
|
items:
|
|
36806
38552
|
type: string
|
|
36807
38553
|
description: The permissions granted by the role.
|
|
36808
|
-
example: *
|
|
38554
|
+
example: *ref_31
|
|
36809
38555
|
created_at:
|
|
36810
38556
|
format: date-time
|
|
36811
38557
|
type: string
|
|
@@ -36887,7 +38633,7 @@ components:
|
|
|
36887
38633
|
items:
|
|
36888
38634
|
type: string
|
|
36889
38635
|
description: The permissions granted by the role.
|
|
36890
|
-
example: *
|
|
38636
|
+
example: *ref_31
|
|
36891
38637
|
created_at:
|
|
36892
38638
|
format: date-time
|
|
36893
38639
|
type: string
|
|
@@ -37024,7 +38770,7 @@ components:
|
|
|
37024
38770
|
description: >-
|
|
37025
38771
|
Object containing [metadata](/authkit/metadata)
|
|
37026
38772
|
key/value pairs associated with the Organization.
|
|
37027
|
-
example: *
|
|
38773
|
+
example: *ref_30
|
|
37028
38774
|
propertyNames:
|
|
37029
38775
|
maxLength: 40
|
|
37030
38776
|
maxProperties: 50
|
|
@@ -37701,6 +39447,7 @@ components:
|
|
|
37701
39447
|
- organizations
|
|
37702
39448
|
- events
|
|
37703
39449
|
- sessions
|
|
39450
|
+
- auditLogEvents
|
|
37704
39451
|
description: The type of resource being exported.
|
|
37705
39452
|
example: users
|
|
37706
39453
|
required:
|
|
@@ -37747,6 +39494,7 @@ components:
|
|
|
37747
39494
|
- organizations
|
|
37748
39495
|
- events
|
|
37749
39496
|
- sessions
|
|
39497
|
+
- auditLogEvents
|
|
37750
39498
|
description: The type of resource being exported.
|
|
37751
39499
|
example: users
|
|
37752
39500
|
required:
|
|
@@ -37793,6 +39541,7 @@ components:
|
|
|
37793
39541
|
- organizations
|
|
37794
39542
|
- events
|
|
37795
39543
|
- sessions
|
|
39544
|
+
- auditLogEvents
|
|
37796
39545
|
description: The type of resource being exported.
|
|
37797
39546
|
example: users
|
|
37798
39547
|
required:
|
|
@@ -37839,6 +39588,7 @@ components:
|
|
|
37839
39588
|
- organizations
|
|
37840
39589
|
- events
|
|
37841
39590
|
- sessions
|
|
39591
|
+
- auditLogEvents
|
|
37842
39592
|
description: The type of resource being exported.
|
|
37843
39593
|
example: users
|
|
37844
39594
|
required:
|
|
@@ -37891,7 +39641,7 @@ components:
|
|
|
37891
39641
|
items:
|
|
37892
39642
|
type: string
|
|
37893
39643
|
description: The permissions granted by the role.
|
|
37894
|
-
example: &
|
|
39644
|
+
example: &ref_32
|
|
37895
39645
|
- users:read
|
|
37896
39646
|
- users:write
|
|
37897
39647
|
created_at:
|
|
@@ -37957,7 +39707,7 @@ components:
|
|
|
37957
39707
|
items:
|
|
37958
39708
|
type: string
|
|
37959
39709
|
description: The permissions granted by the role.
|
|
37960
|
-
example: *
|
|
39710
|
+
example: *ref_32
|
|
37961
39711
|
created_at:
|
|
37962
39712
|
format: date-time
|
|
37963
39713
|
type: string
|
|
@@ -38021,7 +39771,7 @@ components:
|
|
|
38021
39771
|
items:
|
|
38022
39772
|
type: string
|
|
38023
39773
|
description: The permissions granted by the role.
|
|
38024
|
-
example: *
|
|
39774
|
+
example: *ref_32
|
|
38025
39775
|
created_at:
|
|
38026
39776
|
format: date-time
|
|
38027
39777
|
type: string
|
|
@@ -39161,7 +40911,7 @@ components:
|
|
|
39161
40911
|
- data
|
|
39162
40912
|
- created_at
|
|
39163
40913
|
- object
|
|
39164
|
-
example: *
|
|
40914
|
+
example: *ref_33
|
|
39165
40915
|
description: An event emitted by WorkOS.
|
|
39166
40916
|
EventList:
|
|
39167
40917
|
type: object
|
|
@@ -39196,7 +40946,7 @@ components:
|
|
|
39196
40946
|
example:
|
|
39197
40947
|
object: list
|
|
39198
40948
|
data:
|
|
39199
|
-
- *
|
|
40949
|
+
- *ref_33
|
|
39200
40950
|
list_metadata:
|
|
39201
40951
|
after: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
39202
40952
|
JwtTemplate:
|