@coffre/client 0.14.7 → 0.16.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.
@@ -1,219 +1,176 @@
1
1
  //#region src/api.d.ts
2
2
  /** Every route, by `METHOD /path`: what a caller sends (the body, or the query of a GET) and gets back. */
3
3
  type Api = {
4
- "GET /me": {
5
- input: undefined;
4
+ "GET /audit": {
5
+ input: {
6
+ path?: string;
7
+ actor?: string;
8
+ decision?: "allow" | "deny";
9
+ detail?: "1" | "true";
10
+ before?: unknown;
11
+ limit?: unknown;
12
+ };
6
13
  output: {
7
- principal: {
8
- type: "service" | "user";
9
- id: string;
10
- };
11
- registered: boolean;
12
- tampered: boolean;
13
- instanceRole: "admin" | "auditor" | "developer" | "member" | "owner";
14
- scope: {
15
- projects: "all" | {
16
- only: string[];
17
- } | {
18
- except: string[];
19
- };
20
- environments: "all" | {
21
- only: string[];
22
- } | {
23
- except: string[];
24
- };
25
- };
26
- runsInstance: boolean;
27
- canReadAudit: boolean;
28
- setsUpServices: boolean;
29
- serviceSetup: null | {
30
- projects: "all" | {
31
- only: string[];
32
- } | {
33
- except: string[];
14
+ entries: {
15
+ seq: number;
16
+ author: "app" | "vault";
17
+ occurredAt: string;
18
+ actorType: "service" | "system" | "user";
19
+ actorId: string;
20
+ action: string;
21
+ decision: "allow" | "deny";
22
+ reason: string | null;
23
+ detail: boolean;
24
+ subject: string | null;
25
+ project: string | null;
26
+ environment: string | null;
27
+ key: string | null;
28
+ version: number | null;
29
+ secrets: null | {
30
+ key: string | null;
31
+ version: number | null;
32
+ }[];
33
+ operationId: string | null;
34
+ relatedSeq: number | null;
35
+ requestId: string | null;
36
+ run: null | {
37
+ exchangeSeq: number;
38
+ claims: {
39
+ [key: string]: string | number;
40
+ };
34
41
  };
35
- environments: "all" | {
36
- only: string[];
37
- } | {
38
- except: string[];
42
+ token: null | {
43
+ id: string;
44
+ label: string;
39
45
  };
40
- };
41
- features: {
42
- mcp: string | null;
43
- workloads: boolean;
44
- };
45
- personalToken: null | {
46
- id: string;
47
- label: string;
48
- expiresAt: string;
49
- scope: {
50
- [key: string]: string;
46
+ metadata: {
47
+ [key: string]: unknown;
51
48
  };
52
- };
53
- credentialExpiresAt: string | null;
54
- environments: {
55
- project: string;
56
- environment: string;
57
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
49
+ proof: "failed" | "proven" | "unproven";
58
50
  }[];
59
- };
60
- };
61
- "GET /projects": {
62
- input: undefined;
63
- output: {
64
- projects: {
65
- slug: string;
66
- name: string;
67
- archivedAt: string | null;
68
- folder: string | null;
69
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
70
- environments: {
71
- slug: string;
72
- name: string;
73
- accessible: boolean;
74
- parent: string | null;
75
- protected: boolean;
76
- unprotectable: boolean;
77
- personal: boolean;
78
- details: null | {
79
- archivedAt: string | null;
80
- secretCount: number | null;
81
- };
82
- }[];
83
- secretCount: number | null;
51
+ more: boolean;
52
+ next: number | null;
53
+ hidden?: {
54
+ action: string;
55
+ count: number;
56
+ }[];
57
+ head: null | {
58
+ size: number;
59
+ signedAt: string;
60
+ };
61
+ holes: null | {
62
+ above: number | null;
63
+ below: number | null;
64
+ kept: number;
65
+ aging: number;
84
66
  }[];
85
67
  };
86
68
  };
87
- "PUT /projects/:project": {
69
+ "POST /reveals": {
88
70
  input: {
89
- name?: string;
71
+ path: string;
72
+ keys?: string[];
90
73
  };
91
74
  output: {
92
- project: {
93
- slug: string;
94
- name: string;
95
- archivedAt: string | null;
75
+ operationId: string | null;
76
+ values: {
77
+ [key: string]: string;
96
78
  };
97
- created: boolean;
79
+ versions: {
80
+ [key: string]: number;
81
+ };
82
+ secrets: {
83
+ [key: string]: string;
84
+ };
85
+ sensitive: string[];
86
+ useOnly: string[];
87
+ version: string | null;
98
88
  };
99
89
  };
100
- "PATCH /projects/:project": {
90
+ "PATCH /secrets/:project/:environment": {
101
91
  input: {
102
- name?: string;
103
- slug?: string;
104
- archived?: boolean;
105
- folder?: string | null;
106
- };
107
- output: {
108
- project: {
109
- slug: string;
110
- name: string;
111
- archivedAt: string | null;
112
- folder: string | null;
92
+ [key: string]: string | null | {
93
+ value: string;
94
+ generated: {
95
+ recipe: string;
96
+ pair?: {
97
+ private: string;
98
+ public: string;
99
+ };
100
+ };
101
+ replaces?: string;
102
+ sensitivity?: "secret" | "sensitive";
103
+ } | {
104
+ value: string;
105
+ sensitivity: "plain" | "secret" | "sensitive";
106
+ replaces?: string;
107
+ } | {
108
+ ref: string;
109
+ } | {
110
+ sensitivity: "plain" | "secret" | "sensitive";
113
111
  };
114
112
  };
115
- };
116
- "DELETE /projects/:project": {
117
- input: undefined;
118
113
  output: {
119
- dryRun: boolean;
120
- deletion: {
121
- path: string;
122
- tombstone: string;
123
- environments: string[];
124
- keys: number;
125
- versions: number;
126
- grants: {
127
- member: string;
128
- place: string;
129
- role: string;
130
- }[];
131
- references: {
132
- holder: string;
133
- source: string;
134
- }[];
135
- stranded: string[];
114
+ operationId: string | null;
115
+ keys: {
116
+ [key: string]: {
117
+ version: number;
118
+ sensitivity: "plain" | "secret" | "sensitive";
119
+ } | {
120
+ archived: true;
121
+ } | {
122
+ reference: string;
123
+ };
124
+ };
125
+ } | {
126
+ dryRun: true;
127
+ keys: {
128
+ [key: string]: "added" | "archived" | "changed" | "unchanged";
136
129
  };
137
130
  };
138
131
  };
139
- "PUT /projects/:project/:environment": {
132
+ "PATCH /secrets/:project/:environment/:key": {
140
133
  input: {
141
- name?: string;
142
- from?: string;
143
- references?: boolean;
134
+ key?: string;
135
+ archived?: boolean;
136
+ folder?: string | null;
144
137
  inherit?: boolean;
145
138
  };
146
139
  output: {
147
- environment: {
148
- slug: string;
149
- name: string;
150
- archivedAt: string | null;
151
- protected: boolean;
152
- };
153
- created: boolean;
154
- forked: null | {
155
- from: string;
156
- keys: number;
157
- references: number;
158
- copied: string[];
159
- inherits: boolean;
160
- };
140
+ inherit?: boolean;
141
+ folder?: string | null;
142
+ archived?: boolean;
143
+ operationId: string | null;
144
+ key: string;
161
145
  };
162
146
  };
163
- "PATCH /projects/:project/:environment": {
147
+ "POST /secrets/:project/:environment/:key/restore": {
164
148
  input: {
165
- name?: string;
166
- archived?: boolean;
167
- slug?: string;
168
- protected?: boolean;
149
+ version: number;
169
150
  };
170
151
  output: {
171
- environment: {
172
- slug: string;
173
- name: string;
174
- archivedAt: string | null;
175
- protected: boolean;
176
- };
152
+ operationId: string | null;
153
+ key: string;
154
+ version: number;
155
+ sensitivity: "plain" | "secret" | "sensitive";
177
156
  };
178
157
  };
179
- "DELETE /projects/:project/:environment": {
180
- input: undefined;
158
+ "PATCH /folders/:project/:environment/:folder": {
159
+ input: {
160
+ name: string;
161
+ };
181
162
  output: {
182
- dryRun: boolean;
183
- deletion: {
184
- path: string;
185
- tombstone: string;
186
- environments: string[];
187
- keys: number;
188
- versions: number;
189
- grants: {
190
- member: string;
191
- place: string;
192
- role: string;
193
- }[];
194
- references: {
195
- holder: string;
196
- source: string;
197
- }[];
198
- stranded: string[];
199
- };
163
+ operationId: string | null;
164
+ folder: string;
165
+ moved: string[];
200
166
  };
201
167
  };
202
- "GET /projects/:project/:environment/missing": {
168
+ "DELETE /folders/:project/:environment/:folder": {
203
169
  input: undefined;
204
170
  output: {
205
- missing: {
206
- key: string;
207
- in: string[];
208
- folder: string | null;
209
- }[];
210
- dismissed: {
211
- key: string;
212
- in: string[];
213
- folder: string | null;
214
- dismissedBy: string;
215
- dismissedAt: string;
216
- }[];
171
+ operationId: string | null;
172
+ folder: null;
173
+ moved: string[];
217
174
  };
218
175
  };
219
176
  "PATCH /projects/:project/:environment/dismissals": {
@@ -221,12 +178,23 @@ type Api = {
221
178
  [key: string]: null | true;
222
179
  };
223
180
  output: {
224
- operationId: string;
181
+ operationId: string | null;
225
182
  keys: {
226
183
  [key: string]: "dismissed" | "restored" | "unchanged";
227
184
  };
228
185
  };
229
186
  };
187
+ "DELETE /secrets/:project/:environment/:key/reference": {
188
+ input: undefined;
189
+ output: {
190
+ operationId: string | null;
191
+ reference: {
192
+ holder: string;
193
+ source: string;
194
+ state: "broken";
195
+ };
196
+ };
197
+ };
230
198
  "GET /secrets/:project/:environment": {
231
199
  input: undefined;
232
200
  output: {
@@ -237,20 +205,22 @@ type Api = {
237
205
  id: string;
238
206
  holder: string;
239
207
  source: string;
240
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
208
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
241
209
  version: number | null;
242
- createdBy: string;
243
- createdAt: string;
244
- endedBy: string | null;
245
- endedAt: string | null;
210
+ createdBy: string | null;
211
+ createdAt: string | null;
212
+ endedBy: null;
213
+ endedAt: null;
214
+ sourceId: string;
246
215
  canOpenSource: boolean;
247
216
  };
248
217
  folder: string | null;
249
218
  archived: boolean;
250
219
  version: number | null;
220
+ versionId: string | null;
221
+ secret: string | null;
251
222
  updatedAt: string | null;
252
223
  updatedBy: string | null;
253
- versionId: string | null;
254
224
  generated: null | {
255
225
  recipe: string;
256
226
  pair?: {
@@ -280,173 +250,293 @@ type Api = {
280
250
  rotateAfterDays: number | null;
281
251
  };
282
252
  };
283
- "PATCH /secrets/:project/:environment": {
253
+ "GET /secrets/:project/:environment/:key/versions": {
284
254
  input: {
285
- [key: string]: string | null | {
286
- value: string;
287
- generated: {
288
- recipe: string;
289
- pair?: {
290
- private: string;
291
- public: string;
255
+ before?: string;
256
+ };
257
+ output: {
258
+ key: string;
259
+ archived: boolean;
260
+ versions: {
261
+ version: number;
262
+ createdAt: string;
263
+ createdBy: string;
264
+ current: boolean;
265
+ kek: string;
266
+ recipe: string | null;
267
+ plain: boolean;
268
+ sensitivity: "plain" | "secret" | "sensitive";
269
+ }[];
270
+ more: boolean;
271
+ };
272
+ };
273
+ "GET /references": {
274
+ input: {
275
+ path: string;
276
+ };
277
+ output: {
278
+ references: {
279
+ readers: null | string[];
280
+ canBreak: boolean;
281
+ holderArchived: boolean;
282
+ id: string;
283
+ holder: string;
284
+ source: string;
285
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
286
+ version: number | null;
287
+ createdBy: string | null;
288
+ createdAt: string | null;
289
+ endedBy: null;
290
+ endedAt: null;
291
+ }[];
292
+ };
293
+ };
294
+ "GET /projects/:project/:environment/missing": {
295
+ input: undefined;
296
+ output: {
297
+ missing: {
298
+ key: string;
299
+ in: string[];
300
+ folder: string | null;
301
+ }[];
302
+ dismissed: {
303
+ dismissedBy: string;
304
+ dismissedAt: string;
305
+ key: string;
306
+ in: string[];
307
+ folder: string | null;
308
+ }[];
309
+ };
310
+ };
311
+ "GET /projects/:project/:environment/version": {
312
+ input: undefined;
313
+ output: {
314
+ version: string;
315
+ };
316
+ };
317
+ "GET /members/:member/bindings": {
318
+ input: undefined;
319
+ output: {
320
+ bindings: {
321
+ id: string;
322
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
323
+ issuer: string;
324
+ jwksUri: string;
325
+ keys: null | {
326
+ kid: string | null;
327
+ alg: "ES256" | "RS256";
328
+ thumbprint: string;
329
+ }[];
330
+ claims: {
331
+ [key: string]: string | string[];
332
+ };
333
+ scope: null | {
334
+ [key: string]: string;
335
+ };
336
+ policy: null | {
337
+ sources?: string[];
338
+ audience?: string;
339
+ keyAudience?: true;
340
+ sessionHours?: number;
341
+ replicas?: number;
342
+ sessionDays?: number;
343
+ overlapMinutes?: number;
344
+ mintedBy?: string;
345
+ approve?: true;
346
+ onContention?: "alert";
347
+ unsignedUploads?: true;
348
+ reads?: {
349
+ [key: string]: "*" | string[];
292
350
  };
293
351
  };
294
- replaces?: string;
295
- sensitivity?: "secret" | "sensitive";
296
- } | {
297
- value: string;
298
- plain: true;
299
- replaces?: string;
300
- } | {
301
- value: string;
302
- sensitivity: "plain" | "secret" | "sensitive";
303
- replaces?: string;
304
- } | {
305
- sensitivity: "plain" | "secret" | "sensitive";
306
- } | {
307
- ref: string;
352
+ label: string | null;
353
+ createdAt: string;
354
+ createdBy: string;
355
+ lastUsedAt: string | null;
356
+ }[];
357
+ };
358
+ };
359
+ "POST /members/:member/bindings": {
360
+ input: {
361
+ profile: string;
362
+ claims: {
363
+ [key: string]: unknown;
364
+ };
365
+ issuer?: string | null;
366
+ scope?: {
367
+ [key: string]: string;
368
+ };
369
+ label?: string | null;
370
+ replaces?: string[];
371
+ jwks?: {
372
+ [key: string]: unknown;
373
+ keys: {
374
+ [key: string]: unknown;
375
+ }[];
376
+ };
377
+ policy?: {
378
+ [key: string]: unknown;
308
379
  };
309
380
  };
310
381
  output: {
311
- operationId: string;
312
- keys: {
313
- [key: string]: {
314
- version: number;
315
- sensitivity: "plain" | "secret" | "sensitive";
316
- } | {
317
- archived: true;
318
- } | {
319
- reference: string;
382
+ binding: {
383
+ id: string;
384
+ scope: {
385
+ [key: string]: string;
320
386
  };
321
387
  };
388
+ replaced: string[];
322
389
  } | {
323
- dryRun: true;
324
- keys: {
325
- [key: string]: "added" | "archived" | "changed" | "unchanged";
390
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
391
+ issuer: string;
392
+ jwksUri: string;
393
+ keys: null | {
394
+ kid: string | null;
395
+ alg: "ES256" | "RS256";
396
+ thumbprint: string;
397
+ }[];
398
+ claims: {
399
+ [key: string]: string | string[];
400
+ };
401
+ scope: {
402
+ [key: string]: string;
403
+ };
404
+ policy: null | {
405
+ sources?: string[];
406
+ audience?: string;
407
+ keyAudience?: true;
408
+ sessionHours?: number;
409
+ replicas?: number;
410
+ sessionDays?: number;
411
+ overlapMinutes?: number;
412
+ mintedBy?: string;
413
+ approve?: true;
414
+ onContention?: "alert";
415
+ unsignedUploads?: true;
416
+ reads?: {
417
+ [key: string]: "*" | string[];
418
+ };
326
419
  };
420
+ withheld: string[];
421
+ replaces: {
422
+ id: string;
423
+ why: "asked" | "keys_moved";
424
+ }[];
327
425
  };
328
426
  };
329
- "PATCH /secrets/:project/:environment/:key": {
427
+ "POST /members/:member/bindings/keys": {
330
428
  input: {
331
- key?: string;
332
- archived?: boolean;
333
- folder?: string | null;
334
- inherit?: boolean;
335
- };
336
- output: {
337
- key: string;
338
- archived: boolean;
339
- folder: string | null;
429
+ issuer: string;
430
+ jwks: {
431
+ [key: string]: unknown;
432
+ keys: {
433
+ [key: string]: unknown;
434
+ }[];
435
+ };
340
436
  };
341
- };
342
- "GET /secrets/:project/:environment/:key/versions": {
343
- input: undefined;
344
437
  output: {
345
- key: string;
346
- archived: boolean;
347
- versions: {
348
- version: number;
349
- createdAt: string;
350
- createdBy: string;
351
- current: boolean;
352
- kek: string;
353
- recipe: string | null;
354
- plain: boolean;
355
- sensitivity: "plain" | "secret" | "sensitive";
438
+ issuer: string;
439
+ jwksUri: string;
440
+ keys: {
441
+ kid: string | null;
442
+ alg: "ES256" | "RS256";
443
+ thumbprint: string;
444
+ }[];
445
+ replaces: string[];
446
+ withheld: string[];
447
+ } | {
448
+ bindings: {
449
+ id: string;
450
+ scope: {
451
+ [key: string]: string;
452
+ };
356
453
  }[];
454
+ replaced: string[];
357
455
  };
358
456
  };
359
- "POST /secrets/:project/:environment/:key/restore": {
360
- input: {
361
- version: number;
362
- };
457
+ "DELETE /members/:member/bindings/:id": {
458
+ input: undefined;
363
459
  output: {
364
- key: string;
365
- version: number;
460
+ unbound: true;
366
461
  };
367
462
  };
368
- "DELETE /secrets/:project/:environment/:key/reference": {
463
+ "GET /members/:member/tokens": {
369
464
  input: undefined;
370
465
  output: {
371
- reference: {
466
+ tokens: {
372
467
  id: string;
373
- holder: string;
374
- source: string;
375
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
376
- version: number | null;
377
- createdBy: string;
468
+ label: string | null;
469
+ hint: string;
378
470
  createdAt: string;
379
- endedBy: string | null;
380
- endedAt: string | null;
381
- };
471
+ createdBy: string;
472
+ expiresAt: string;
473
+ lastUsedAt: string | null;
474
+ lastUsedIp: string | null;
475
+ scope: null | {
476
+ [key: string]: string;
477
+ };
478
+ session?: {
479
+ bindingId: string | null;
480
+ };
481
+ }[];
382
482
  };
383
483
  };
384
- "PATCH /folders/:folder": {
484
+ "POST /members/:member/tokens": {
385
485
  input: {
386
- name: string;
486
+ label?: string | null;
487
+ expiresInDays?: number;
488
+ expiresInMinutes?: number;
489
+ scope?: {
490
+ [key: string]: string;
491
+ };
387
492
  };
388
493
  output: {
389
- folder: string | null;
390
- moved: string[];
494
+ id: string;
495
+ token: string;
496
+ expiresAt: string;
497
+ scope: {
498
+ [key: string]: string;
499
+ };
500
+ withheld?: string[];
501
+ } | {
502
+ scope: {
503
+ [key: string]: string;
504
+ };
505
+ withheld?: string[];
391
506
  };
392
507
  };
393
- "DELETE /folders/:folder": {
508
+ "DELETE /members/:member/tokens/:id": {
394
509
  input: undefined;
395
510
  output: {
396
- folder: string | null;
397
- moved: string[];
511
+ revoked: true;
398
512
  };
399
513
  };
400
- "PATCH /folders/:project/:environment/:folder": {
514
+ "POST /handles": {
401
515
  input: {
402
- name: string;
516
+ label: string;
517
+ paths: string[];
518
+ expiresInMinutes?: number;
403
519
  };
404
520
  output: {
405
- folder: string | null;
406
- moved: string[];
521
+ id: string;
522
+ token: string;
523
+ expiresAt: string;
524
+ scope: {
525
+ [key: string]: string;
526
+ };
527
+ withheld?: string[];
407
528
  };
408
529
  };
409
- "DELETE /folders/:project/:environment/:folder": {
530
+ "DELETE /handles/:id": {
410
531
  input: undefined;
411
532
  output: {
412
- folder: string | null;
413
- moved: string[];
414
- };
415
- };
416
- "GET /references": {
417
- input: {
418
- path: string;
419
- };
420
- output: {
421
- references: {
422
- id: string;
423
- holder: string;
424
- source: string;
425
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
426
- version: number | null;
427
- createdBy: string;
428
- createdAt: string;
429
- endedBy: string | null;
430
- endedAt: string | null;
431
- readers: null | string[];
432
- canBreak: boolean;
433
- holderArchived: boolean;
434
- }[];
533
+ revoked: true;
435
534
  };
436
535
  };
437
- "POST /reveals": {
438
- input: {
439
- path: string;
440
- keys?: string[];
441
- };
536
+ "DELETE /sessions/:id": {
537
+ input: undefined;
442
538
  output: {
443
- operationId: string;
444
- values: {
445
- [key: string]: string;
446
- };
447
- sensitive: string[];
448
- useOnly: string[];
449
- version: string | null;
539
+ revoked: true;
450
540
  };
451
541
  };
452
542
  "GET /members": {
@@ -530,7 +620,7 @@ type Api = {
530
620
  at: string;
531
621
  }[];
532
622
  rotated: number;
533
- issuedTokens: {
623
+ issuedTokens: null | {
534
624
  id: string;
535
625
  service: string;
536
626
  label: string | null;
@@ -541,7 +631,7 @@ type Api = {
541
631
  [key: string]: string;
542
632
  };
543
633
  }[];
544
- apps: {
634
+ apps: null | {
545
635
  id: string;
546
636
  name: string;
547
637
  host: string | null;
@@ -552,7 +642,7 @@ type Api = {
552
642
  lastUsedIp: string | null;
553
643
  expiresAt: string;
554
644
  }[];
555
- personalTokens: {
645
+ personalTokens: null | {
556
646
  id: string;
557
647
  label: string | null;
558
648
  hint: string;
@@ -568,17 +658,22 @@ type Api = {
568
658
  bindingId: string | null;
569
659
  };
570
660
  }[];
571
- references: {
661
+ references: null | {
662
+ version: number | null;
663
+ source: string;
572
664
  id: string;
665
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
573
666
  holder: string;
574
- source: string;
575
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
576
- version: number | null;
667
+ endedBy: null;
668
+ endedAt: null;
577
669
  createdBy: string;
578
670
  createdAt: string;
579
- endedBy: string | null;
580
- endedAt: string | null;
581
671
  }[];
672
+ totals: {
673
+ issuedTokens: number | null;
674
+ personalTokens: number | null;
675
+ references: number | null;
676
+ };
582
677
  personal: {
583
678
  project: string;
584
679
  of: string;
@@ -586,6 +681,38 @@ type Api = {
586
681
  }[];
587
682
  };
588
683
  };
684
+ "GET /members/:member/access": {
685
+ input: undefined;
686
+ output: {
687
+ member: string;
688
+ principalType: "service" | "user";
689
+ principalId: string;
690
+ status: "active" | "removed" | "tampered";
691
+ instanceRole: "admin" | "auditor" | "developer" | "member" | "owner";
692
+ scope: null | {
693
+ projects: "all" | {
694
+ only: string[];
695
+ } | {
696
+ except: string[];
697
+ };
698
+ environments: "all" | {
699
+ only: string[];
700
+ } | {
701
+ except: string[];
702
+ };
703
+ };
704
+ managed: boolean;
705
+ grants: {
706
+ id: string;
707
+ project: string;
708
+ environment: string | null;
709
+ role: string;
710
+ roleName: string;
711
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
712
+ expiresAt: string | null;
713
+ }[];
714
+ };
715
+ };
589
716
  "PUT /members/:member": {
590
717
  input: {
591
718
  role?: "admin" | "auditor" | "developer" | "member" | "owner";
@@ -675,7 +802,7 @@ type Api = {
675
802
  at: string;
676
803
  }[];
677
804
  rotated: number;
678
- issuedTokens: {
805
+ issuedTokens: null | {
679
806
  id: string;
680
807
  service: string;
681
808
  label: string | null;
@@ -686,7 +813,7 @@ type Api = {
686
813
  [key: string]: string;
687
814
  };
688
815
  }[];
689
- apps: {
816
+ apps: null | {
690
817
  id: string;
691
818
  name: string;
692
819
  host: string | null;
@@ -697,7 +824,7 @@ type Api = {
697
824
  lastUsedIp: string | null;
698
825
  expiresAt: string;
699
826
  }[];
700
- personalTokens: {
827
+ personalTokens: null | {
701
828
  id: string;
702
829
  label: string | null;
703
830
  hint: string;
@@ -713,17 +840,22 @@ type Api = {
713
840
  bindingId: string | null;
714
841
  };
715
842
  }[];
716
- references: {
843
+ references: null | {
844
+ version: number | null;
845
+ source: string;
717
846
  id: string;
847
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
718
848
  holder: string;
719
- source: string;
720
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
721
- version: number | null;
849
+ endedBy: null;
850
+ endedAt: null;
722
851
  createdBy: string;
723
852
  createdAt: string;
724
- endedBy: string | null;
725
- endedAt: string | null;
726
853
  }[];
854
+ totals: {
855
+ issuedTokens: number | null;
856
+ personalTokens: number | null;
857
+ references: number | null;
858
+ };
727
859
  personal: {
728
860
  project: string;
729
861
  of: string;
@@ -732,195 +864,258 @@ type Api = {
732
864
  };
733
865
  };
734
866
  };
735
- "GET /members/:member/tokens": {
867
+ "PATCH /access/:member": {
868
+ input: {
869
+ [key: string]: string | null | {
870
+ role: string;
871
+ until: string | null;
872
+ };
873
+ };
874
+ output: {
875
+ changes: {
876
+ [key: string]: "created" | "revoked" | "unchanged" | "updated";
877
+ };
878
+ };
879
+ };
880
+ "GET /freezes": {
736
881
  input: undefined;
737
882
  output: {
738
- tokens: {
739
- id: string;
740
- label: string | null;
741
- hint: string;
742
- createdAt: string;
743
- createdBy: string;
744
- expiresAt: string;
745
- lastUsedAt: string | null;
746
- lastUsedIp: string | null;
747
- scope: null | {
748
- [key: string]: string;
749
- };
750
- session?: {
751
- bindingId: string | null;
752
- };
883
+ freezes: {
884
+ target: string;
885
+ service: string | null;
886
+ frozenAt: string;
753
887
  }[];
754
888
  };
755
889
  };
756
- "POST /members/:member/tokens": {
890
+ "POST /freezes": {
757
891
  input: {
758
- label?: string | null;
759
- expiresInDays?: number;
760
- expiresInMinutes?: number;
761
- scope?: {
762
- [key: string]: string;
763
- };
892
+ target: string;
893
+ reason: string;
764
894
  };
765
895
  output: {
766
- scope: {
767
- [key: string]: string;
768
- };
769
- withheld?: string[];
770
- } | {
771
- id: string;
772
- token: string;
773
- expiresAt: string;
774
- scope: {
775
- [key: string]: string;
776
- };
777
- withheld?: string[];
896
+ target: string;
897
+ frozenAt: string | null;
778
898
  };
779
899
  };
780
- "DELETE /members/:member/tokens/:id": {
900
+ "DELETE /freezes/:target": {
781
901
  input: undefined;
782
902
  output: {
783
- revoked: true;
903
+ target: string;
904
+ frozenAt: string | null;
784
905
  };
785
906
  };
786
- "GET /members/:member/bindings": {
907
+ "GET /me": {
787
908
  input: undefined;
788
909
  output: {
789
- bindings: {
910
+ principal: {
911
+ type: "service" | "user";
790
912
  id: string;
791
- profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
792
- issuer: string;
793
- jwksUri: string;
794
- keys: null | {
795
- kid: string | null;
796
- alg: "ES256" | "RS256";
797
- thumbprint: string;
798
- }[];
799
- claims: {
800
- [key: string]: string | string[];
913
+ };
914
+ registered: boolean;
915
+ tampered: boolean;
916
+ instanceRole: "admin" | "auditor" | "developer" | "member" | "owner";
917
+ scope: {
918
+ projects: "all" | {
919
+ only: string[];
920
+ } | {
921
+ except: string[];
801
922
  };
802
- scope: null | {
923
+ environments: "all" | {
924
+ only: string[];
925
+ } | {
926
+ except: string[];
927
+ };
928
+ };
929
+ runsInstance: boolean;
930
+ canReadAudit: boolean;
931
+ setsUpServices: boolean;
932
+ serviceSetup: null | {
933
+ projects: "all" | {
934
+ only: string[];
935
+ } | {
936
+ except: string[];
937
+ };
938
+ environments: "all" | {
939
+ only: string[];
940
+ } | {
941
+ except: string[];
942
+ };
943
+ };
944
+ features: {
945
+ mcp: string | null;
946
+ workloads: boolean;
947
+ };
948
+ personalToken: null | {
949
+ id: string;
950
+ label: string;
951
+ expiresAt: string;
952
+ scope: {
803
953
  [key: string]: string;
804
954
  };
805
- policy: null | {
806
- sources?: string[];
807
- audience?: string;
808
- keyAudience?: true;
809
- sessionHours?: number;
810
- replicas?: number;
811
- sessionDays?: number;
812
- overlapMinutes?: number;
813
- mintedBy?: string;
814
- approve?: true;
815
- onContention?: "alert";
816
- unsignedUploads?: true;
817
- reads?: {
818
- [key: string]: "*" | string[];
955
+ };
956
+ credentialExpiresAt: string | null;
957
+ environments: {
958
+ project: string;
959
+ environment: string;
960
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
961
+ }[];
962
+ };
963
+ };
964
+ "GET /projects": {
965
+ input: undefined;
966
+ output: {
967
+ projects: {
968
+ slug: string;
969
+ name: string;
970
+ archivedAt: string | null;
971
+ folder: string | null;
972
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
973
+ environments: {
974
+ slug: string;
975
+ name: string;
976
+ accessible: boolean;
977
+ parent: string | null;
978
+ protected: boolean;
979
+ unprotectable: boolean;
980
+ personal: boolean;
981
+ details: null | {
982
+ archivedAt: string | null;
983
+ secretCount: number | null;
819
984
  };
820
- };
821
- label: string | null;
822
- createdAt: string;
823
- createdBy: string;
824
- lastUsedAt: string | null;
985
+ }[];
986
+ secretCount: number | null;
825
987
  }[];
826
988
  };
827
989
  };
828
- "POST /members/:member/bindings": {
990
+ "PUT /projects/:project": {
829
991
  input: {
830
- profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
831
- claims: {
832
- [key: string]: string | string[];
992
+ name?: string;
993
+ };
994
+ output: {
995
+ project: {
996
+ slug: string;
997
+ name: string;
998
+ archivedAt: string | null;
833
999
  };
834
- issuer?: string | null;
835
- scope?: {
836
- [key: string]: string;
1000
+ created: boolean;
1001
+ };
1002
+ };
1003
+ "PATCH /projects/:project": {
1004
+ input: {
1005
+ name?: string;
1006
+ slug?: string;
1007
+ archived?: boolean;
1008
+ folder?: string | null;
1009
+ };
1010
+ output: {
1011
+ project: {
1012
+ slug: string;
1013
+ name: string;
1014
+ archivedAt: string | null;
1015
+ folder: string | null;
837
1016
  };
838
- label?: string | null;
839
- replaces?: string[];
840
- jwks?: {
841
- keys: {
842
- [key: string]: unknown;
1017
+ };
1018
+ };
1019
+ "DELETE /projects/:project": {
1020
+ input: undefined;
1021
+ output: {
1022
+ dryRun: boolean;
1023
+ deletion: {
1024
+ path: string;
1025
+ tombstone: string;
1026
+ environments: string[];
1027
+ keys: number;
1028
+ versions: number;
1029
+ grants: {
1030
+ member: string;
1031
+ place: string;
1032
+ role: string;
1033
+ }[];
1034
+ references: {
1035
+ holder: string;
1036
+ source: string;
843
1037
  }[];
1038
+ stranded: string[];
844
1039
  };
845
- policy?: {
846
- [key: string]: unknown;
1040
+ };
1041
+ };
1042
+ "PUT /projects/:project/:environment": {
1043
+ input: {
1044
+ name?: string;
1045
+ from?: string;
1046
+ references?: boolean;
1047
+ inherit?: boolean;
1048
+ };
1049
+ output: {
1050
+ environment: {
1051
+ slug: string;
1052
+ name: string;
1053
+ archivedAt: string | null;
1054
+ protected: boolean;
1055
+ };
1056
+ created: boolean;
1057
+ forked: null | {
1058
+ keys: number;
1059
+ references: number;
1060
+ copied: string[];
1061
+ from: string;
1062
+ inherits: boolean;
847
1063
  };
848
1064
  };
1065
+ };
1066
+ "PATCH /projects/:project/:environment": {
1067
+ input: {
1068
+ name?: string;
1069
+ slug?: string;
1070
+ archived?: boolean;
1071
+ protected?: boolean;
1072
+ };
849
1073
  output: {
850
- profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
851
- issuer: string;
852
- jwksUri: string;
853
- keys: null | {
854
- kid: string | null;
855
- alg: "ES256" | "RS256";
856
- thumbprint: string;
857
- }[];
858
- claims: {
859
- [key: string]: string | string[];
860
- };
861
- scope: {
862
- [key: string]: string;
863
- };
864
- policy: null | {
865
- sources?: string[];
866
- audience?: string;
867
- keyAudience?: true;
868
- sessionHours?: number;
869
- replicas?: number;
870
- sessionDays?: number;
871
- overlapMinutes?: number;
872
- mintedBy?: string;
873
- approve?: true;
874
- onContention?: "alert";
875
- unsignedUploads?: true;
876
- reads?: {
877
- [key: string]: "*" | string[];
878
- };
1074
+ environment: {
1075
+ slug: string;
1076
+ name: string;
1077
+ archivedAt: string | null;
1078
+ protected: boolean;
879
1079
  };
880
- withheld: string[];
881
- replaces: {
882
- id: string;
883
- why: "asked" | "keys_moved";
884
- }[];
885
- } | {
886
- binding: {
887
- id: string;
888
- profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
889
- issuer: string;
890
- jwksUri: string;
891
- keys: null | {
892
- kid: string | null;
893
- alg: "ES256" | "RS256";
894
- thumbprint: string;
1080
+ };
1081
+ };
1082
+ "DELETE /projects/:project/:environment": {
1083
+ input: undefined;
1084
+ output: {
1085
+ dryRun: boolean;
1086
+ deletion: {
1087
+ path: string;
1088
+ tombstone: string;
1089
+ environments: string[];
1090
+ keys: number;
1091
+ versions: number;
1092
+ grants: {
1093
+ member: string;
1094
+ place: string;
1095
+ role: string;
895
1096
  }[];
896
- claims: {
897
- [key: string]: string | string[];
898
- };
899
- scope: null | {
900
- [key: string]: string;
901
- };
902
- policy: null | {
903
- sources?: string[];
904
- audience?: string;
905
- keyAudience?: true;
906
- sessionHours?: number;
907
- replicas?: number;
908
- sessionDays?: number;
909
- overlapMinutes?: number;
910
- mintedBy?: string;
911
- approve?: true;
912
- onContention?: "alert";
913
- unsignedUploads?: true;
914
- reads?: {
915
- [key: string]: "*" | string[];
916
- };
917
- };
918
- label: string | null;
919
- createdAt: string;
920
- createdBy: string;
921
- lastUsedAt: string | null;
1097
+ references: {
1098
+ holder: string;
1099
+ source: string;
1100
+ }[];
1101
+ stranded: string[];
922
1102
  };
923
- replaced: string[];
1103
+ };
1104
+ };
1105
+ "PATCH /folders/:folder": {
1106
+ input: {
1107
+ name: string;
1108
+ };
1109
+ output: {
1110
+ folder: string;
1111
+ moved: string[];
1112
+ };
1113
+ };
1114
+ "DELETE /folders/:folder": {
1115
+ input: undefined;
1116
+ output: {
1117
+ folder: null;
1118
+ moved: string[];
924
1119
  };
925
1120
  };
926
1121
  "GET /workloads/lookup": {
@@ -942,42 +1137,6 @@ type Api = {
942
1137
  namespaceId: string;
943
1138
  };
944
1139
  };
945
- "DELETE /members/:member/bindings/:id": {
946
- input: undefined;
947
- output: {
948
- unbound: true;
949
- };
950
- };
951
- "PATCH /access/:member": {
952
- input: {
953
- [key: string]: string | null | {
954
- role: string;
955
- until: string | null;
956
- };
957
- };
958
- output: {
959
- changes: {
960
- [key: string]: "created" | "revoked" | "unchanged" | "updated";
961
- };
962
- admitted?: {
963
- created: boolean;
964
- role: "admin" | "auditor" | "developer" | "member" | "owner";
965
- scope: {
966
- projects: "all" | {
967
- only: string[];
968
- } | {
969
- except: string[];
970
- };
971
- environments: "all" | {
972
- only: string[];
973
- } | {
974
- except: string[];
975
- };
976
- };
977
- generation: number;
978
- };
979
- };
980
- };
981
1140
  "GET /sessions": {
982
1141
  input: undefined;
983
1142
  output: {
@@ -993,12 +1152,7 @@ type Api = {
993
1152
  lastUsedIp: string | null;
994
1153
  current: boolean;
995
1154
  }[];
996
- };
997
- };
998
- "DELETE /sessions/:id": {
999
- input: undefined;
1000
- output: {
1001
- revoked: true;
1155
+ more: boolean;
1002
1156
  };
1003
1157
  };
1004
1158
  "GET /identities": {
@@ -1011,6 +1165,7 @@ type Api = {
1011
1165
  createdAt: string;
1012
1166
  lastSignInAt: string | null;
1013
1167
  }[];
1168
+ more: boolean;
1014
1169
  };
1015
1170
  };
1016
1171
  "DELETE /identities/:id": {
@@ -1062,155 +1217,70 @@ type Api = {
1062
1217
  status: "ready";
1063
1218
  client: {
1064
1219
  id: string;
1065
- name: string;
1066
- host: string | null;
1067
- registration: "cimd" | "dcr";
1068
- };
1069
- redirectHost: string;
1070
- loopbackOnly: boolean;
1071
- scopes: ("manage-access" | "read" | "reveal" | "write")[];
1072
- connections: ("manage-access" | "read" | "reveal" | "write")[][];
1073
- days: number;
1074
- };
1075
- };
1076
- "POST /oauth/authorizations": {
1077
- input: {
1078
- request: {
1079
- client_id?: string;
1080
- redirect_uri?: string;
1081
- response_type?: string;
1082
- code_challenge?: string;
1083
- code_challenge_method?: string;
1084
- state?: string;
1085
- scope?: string;
1086
- resource?: string;
1087
- };
1088
- approve: boolean;
1089
- scopes?: string[];
1090
- };
1091
- output: {
1092
- redirect: string;
1093
- };
1094
- };
1095
- "GET /apps": {
1096
- input: undefined;
1097
- output: {
1098
- apps: {
1099
- id: string;
1100
- name: string;
1101
- host: string | null;
1102
- registration: "cimd" | "dcr";
1103
- scopes: ("manage-access" | "read" | "reveal" | "write")[];
1104
- createdAt: string;
1105
- lastUsedAt: string | null;
1106
- lastUsedIp: string | null;
1107
- expiresAt: string;
1108
- }[];
1109
- };
1110
- };
1111
- "DELETE /apps/:id": {
1112
- input: undefined;
1113
- output: {
1114
- disconnected: true;
1115
- };
1116
- };
1117
- "GET /audit": {
1118
- input: {
1119
- path?: string;
1120
- actor?: string;
1121
- decision?: "allow" | "deny";
1122
- detail?: "1" | "true";
1123
- before?: unknown;
1124
- limit?: unknown;
1125
- };
1126
- output: {
1127
- entries: {
1128
- seq: number;
1129
- author: "app" | "vault";
1130
- occurredAt: string;
1131
- actorType: "service" | "system" | "user";
1132
- actorId: string;
1133
- action: string;
1134
- decision: "allow" | "deny";
1135
- reason: string | null;
1136
- detail: boolean;
1137
- subject: string | null;
1138
- project: string | null;
1139
- environment: string | null;
1140
- key: string | null;
1141
- version: number | null;
1142
- secrets: null | {
1143
- key: string | null;
1144
- version: number | null;
1145
- }[];
1146
- operationId: string | null;
1147
- relatedSeq: number | null;
1148
- requestId: string | null;
1149
- run: null | {
1150
- exchangeSeq: number;
1151
- claims: {
1152
- [key: string]: string | number;
1153
- };
1154
- };
1155
- token: null | {
1156
- id: string;
1157
- label: string;
1158
- };
1159
- metadata: {
1160
- [key: string]: unknown;
1161
- };
1162
- }[];
1163
- more: boolean;
1164
- hidden?: {
1165
- action: string;
1166
- count: number;
1167
- }[];
1220
+ name: string;
1221
+ host: string | null;
1222
+ registration: "cimd" | "dcr";
1223
+ };
1224
+ redirectHost: string;
1225
+ loopbackOnly: boolean;
1226
+ scopes: ("manage-access" | "read" | "reveal" | "write")[];
1227
+ connections: ("manage-access" | "read" | "reveal" | "write")[][];
1228
+ days: number;
1168
1229
  };
1169
1230
  };
1170
- "GET /audit/verification": {
1231
+ "POST /oauth/authorizations": {
1171
1232
  input: {
1172
- from?: string;
1233
+ request: {
1234
+ client_id?: string;
1235
+ redirect_uri?: string;
1236
+ response_type?: string;
1237
+ code_challenge?: string;
1238
+ code_challenge_method?: string;
1239
+ state?: string;
1240
+ scope?: string;
1241
+ resource?: string;
1242
+ };
1243
+ approve: boolean;
1244
+ scopes?: string[];
1173
1245
  };
1174
1246
  output: {
1175
- ok: true;
1176
- through: number | null;
1177
- entries: number;
1178
- from: number;
1179
- remaining: number;
1180
- next?: string | null;
1181
- checkpoint: null | {
1182
- seq: number;
1183
- signedAt: string;
1184
- };
1185
- pending?: number;
1186
- } | {
1187
- ok: false;
1188
- through: number | null;
1189
- failedAtSeq: number | null;
1190
- author: "app" | "vault";
1191
- reason: string;
1247
+ redirect: string;
1248
+ };
1249
+ };
1250
+ "GET /apps": {
1251
+ input: undefined;
1252
+ output: {
1253
+ apps: {
1254
+ id: string;
1255
+ name: string;
1256
+ host: string | null;
1257
+ registration: "cimd" | "dcr";
1258
+ scopes: ("manage-access" | "read" | "reveal" | "write")[];
1259
+ createdAt: string;
1260
+ lastUsedAt: string | null;
1261
+ lastUsedIp: string | null;
1262
+ expiresAt: string;
1263
+ }[];
1264
+ };
1265
+ };
1266
+ "DELETE /apps/:id": {
1267
+ input: undefined;
1268
+ output: {
1269
+ disconnected: true;
1192
1270
  };
1193
1271
  };
1194
1272
  "GET /audit/keys": {
1195
1273
  input: undefined;
1196
1274
  output: {
1197
- app: {
1198
- keyId: string;
1199
- previous?: string[];
1200
- };
1201
- vault: {
1202
- current: {
1203
- vaultId: string;
1204
- provider: string;
1205
- };
1206
- checks: {
1207
- seq: number;
1208
- vaultId: string;
1209
- provider: string;
1210
- version: string;
1211
- wrapped: string;
1212
- }[];
1275
+ kek: {
1276
+ provider: string;
1277
+ id: string;
1213
1278
  };
1279
+ previous: {
1280
+ provider: string;
1281
+ id: string;
1282
+ }[];
1283
+ checks: string[];
1214
1284
  };
1215
1285
  };
1216
1286
  "GET /approvals/:id": {
@@ -1281,38 +1351,6 @@ type Api = {
1281
1351
  }[];
1282
1352
  };
1283
1353
  };
1284
- "GET /members/:member/access": {
1285
- input: undefined;
1286
- output: {
1287
- member: string;
1288
- principalType: "service" | "user";
1289
- principalId: string;
1290
- status: "active" | "removed" | "tampered";
1291
- instanceRole: "admin" | "auditor" | "developer" | "member" | "owner";
1292
- scope: null | {
1293
- projects: "all" | {
1294
- only: string[];
1295
- } | {
1296
- except: string[];
1297
- };
1298
- environments: "all" | {
1299
- only: string[];
1300
- } | {
1301
- except: string[];
1302
- };
1303
- };
1304
- managed: boolean;
1305
- grants: {
1306
- id: string;
1307
- project: string;
1308
- environment: string | null;
1309
- role: string;
1310
- roleName: string;
1311
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1312
- expiresAt: string | null;
1313
- }[];
1314
- };
1315
- };
1316
1354
  "PUT /settings": {
1317
1355
  input: {
1318
1356
  serviceAccounts: {
@@ -1379,78 +1417,12 @@ type Api = {
1379
1417
  app: null;
1380
1418
  };
1381
1419
  };
1382
- "GET /projects/:project/:environment/version": {
1383
- input: undefined;
1384
- output: {
1385
- version: string;
1386
- };
1387
- };
1388
- "POST /members/:member/bindings/keys": {
1389
- input: {
1390
- issuer: string;
1391
- jwks: {
1392
- keys: {
1393
- [key: string]: unknown;
1394
- }[];
1395
- };
1396
- };
1397
- output: {
1398
- issuer: string;
1399
- jwksUri: string;
1400
- keys: {
1401
- kid: string | null;
1402
- alg: "ES256" | "RS256";
1403
- thumbprint: string;
1404
- }[];
1405
- replaces: string[];
1406
- withheld: string[];
1407
- } | {
1408
- bindings: {
1409
- id: string;
1410
- profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
1411
- issuer: string;
1412
- jwksUri: string;
1413
- keys: null | {
1414
- kid: string | null;
1415
- alg: "ES256" | "RS256";
1416
- thumbprint: string;
1417
- }[];
1418
- claims: {
1419
- [key: string]: string | string[];
1420
- };
1421
- scope: null | {
1422
- [key: string]: string;
1423
- };
1424
- policy: null | {
1425
- sources?: string[];
1426
- audience?: string;
1427
- keyAudience?: true;
1428
- sessionHours?: number;
1429
- replicas?: number;
1430
- sessionDays?: number;
1431
- overlapMinutes?: number;
1432
- mintedBy?: string;
1433
- approve?: true;
1434
- onContention?: "alert";
1435
- unsignedUploads?: true;
1436
- reads?: {
1437
- [key: string]: "*" | string[];
1438
- };
1439
- };
1440
- label: string | null;
1441
- createdAt: string;
1442
- createdBy: string;
1443
- lastUsedAt: string | null;
1444
- }[];
1445
- replaced: string[];
1446
- };
1447
- };
1448
1420
  "GET /personal/:project": {
1449
1421
  input: undefined;
1450
1422
  output: {
1451
1423
  configs: {
1452
- owner: string;
1453
1424
  of: string;
1425
+ owner: string;
1454
1426
  slug: string;
1455
1427
  keys: string[];
1456
1428
  archived: boolean;
@@ -1458,22 +1430,6 @@ type Api = {
1458
1430
  }[];
1459
1431
  };
1460
1432
  };
1461
- "POST /handles": {
1462
- input: {
1463
- label: string;
1464
- paths: string[];
1465
- expiresInMinutes?: number;
1466
- };
1467
- output: {
1468
- id: string;
1469
- token: string;
1470
- expiresAt: string;
1471
- scope: {
1472
- [key: string]: string;
1473
- };
1474
- withheld?: string[];
1475
- };
1476
- };
1477
1433
  "GET /roles": {
1478
1434
  input: undefined;
1479
1435
  output: {
@@ -1538,22 +1494,22 @@ type Api = {
1538
1494
  revision: string;
1539
1495
  } | {
1540
1496
  role: null | {
1497
+ fixed: boolean;
1541
1498
  name: string;
1542
1499
  description: string;
1543
1500
  permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1544
1501
  protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1545
- id: string;
1546
- builtin: boolean;
1547
- edited: boolean;
1548
- fixed: boolean;
1549
1502
  default: null | {
1550
1503
  name: string;
1551
1504
  description: string;
1552
1505
  permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1553
1506
  protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1554
1507
  };
1508
+ id: string;
1509
+ builtin: boolean;
1510
+ edited: boolean;
1555
1511
  assignableToEnvironment: boolean;
1556
- grants: number;
1512
+ grants: number | null;
1557
1513
  };
1558
1514
  };
1559
1515
  };
@@ -1574,22 +1530,22 @@ type Api = {
1574
1530
  revision: string;
1575
1531
  } | {
1576
1532
  role: null | {
1533
+ fixed: boolean;
1577
1534
  name: string;
1578
1535
  description: string;
1579
1536
  permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1580
1537
  protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1581
- id: string;
1582
- builtin: boolean;
1583
- edited: boolean;
1584
- fixed: boolean;
1585
1538
  default: null | {
1586
1539
  name: string;
1587
1540
  description: string;
1588
1541
  permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1589
1542
  protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1590
1543
  };
1544
+ id: string;
1545
+ builtin: boolean;
1546
+ edited: boolean;
1591
1547
  assignableToEnvironment: boolean;
1592
- grants: number;
1548
+ grants: number | null;
1593
1549
  };
1594
1550
  };
1595
1551
  };
@@ -1615,22 +1571,22 @@ type Api = {
1615
1571
  revision: string;
1616
1572
  } | {
1617
1573
  role: null | {
1574
+ fixed: boolean;
1618
1575
  name: string;
1619
1576
  description: string;
1620
1577
  permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1621
1578
  protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1622
- id: string;
1623
- builtin: boolean;
1624
- edited: boolean;
1625
- fixed: boolean;
1626
1579
  default: null | {
1627
1580
  name: string;
1628
1581
  description: string;
1629
1582
  permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1630
1583
  protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1631
1584
  };
1585
+ id: string;
1586
+ builtin: boolean;
1587
+ edited: boolean;
1632
1588
  assignableToEnvironment: boolean;
1633
- grants: number;
1589
+ grants: number | null;
1634
1590
  };
1635
1591
  };
1636
1592
  };
@@ -1651,22 +1607,22 @@ type Api = {
1651
1607
  revision: string;
1652
1608
  } | {
1653
1609
  role: null | {
1610
+ fixed: boolean;
1654
1611
  name: string;
1655
1612
  description: string;
1656
1613
  permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1657
1614
  protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1658
- id: string;
1659
- builtin: boolean;
1660
- edited: boolean;
1661
- fixed: boolean;
1662
1615
  default: null | {
1663
1616
  name: string;
1664
1617
  description: string;
1665
1618
  permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1666
1619
  protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1667
1620
  };
1621
+ id: string;
1622
+ builtin: boolean;
1623
+ edited: boolean;
1668
1624
  assignableToEnvironment: boolean;
1669
- grants: number;
1625
+ grants: number | null;
1670
1626
  };
1671
1627
  };
1672
1628
  };
@@ -1675,51 +1631,17 @@ type Api = {
1675
1631
  output: never;
1676
1632
  };
1677
1633
  "POST /members/:member/bindings/:id/enrollments": {
1678
- input: {
1679
- [key: string]: never;
1680
- };
1681
- output: never;
1682
- };
1683
- "POST /members/:member/bindings/:id/enrollments/:enrollment/promote": {
1684
- input: {
1685
- now?: boolean;
1686
- };
1687
- output: never;
1688
- };
1689
- "POST /members/:member/tokens/:id/approve": {
1690
1634
  input: undefined;
1691
1635
  output: never;
1692
1636
  };
1693
- "GET /freezes": {
1637
+ "POST /members/:member/bindings/:id/enrollments/:enrollment/promote": {
1694
1638
  input: undefined;
1695
1639
  output: never;
1696
1640
  };
1697
- "POST /freezes": {
1698
- input: {
1699
- target: string;
1700
- reason: string;
1701
- };
1702
- output: never;
1703
- };
1704
- "DELETE /freezes/:target": {
1641
+ "POST /members/:member/tokens/:id/approve": {
1705
1642
  input: undefined;
1706
1643
  output: never;
1707
1644
  };
1708
- "DELETE /handles/:id": {
1709
- input: undefined;
1710
- output: {
1711
- revoked: true;
1712
- };
1713
- };
1714
- "POST /audit/loss": {
1715
- input: {
1716
- from: number;
1717
- to: number;
1718
- };
1719
- output: {
1720
- resumes: number | null;
1721
- };
1722
- };
1723
1645
  };
1724
1646
  type AccessValue = string | null | {
1725
1647
  role: string;
@@ -1798,6 +1720,7 @@ type AuditEntryView = {
1798
1720
  metadata: {
1799
1721
  [key: string]: unknown;
1800
1722
  };
1723
+ proof: "failed" | "proven" | "unproven";
1801
1724
  };
1802
1725
  type AuthInfo = {
1803
1726
  signin: null | {
@@ -1919,16 +1842,22 @@ type ConnectedApp = {
1919
1842
  lastUsedIp: string | null;
1920
1843
  expiresAt: string;
1921
1844
  };
1922
- type KeysPlan = {
1923
- issuer: string;
1924
- jwksUri: string;
1925
- keys: {
1926
- kid: string | null;
1927
- alg: "ES256" | "RS256";
1928
- thumbprint: string;
1845
+ type Decision = {
1846
+ status: "approved" | "cancelled" | "denied" | "expired" | "failed" | "pending";
1847
+ outcome: {
1848
+ text: string;
1849
+ result?: {
1850
+ [key: string]: unknown;
1851
+ };
1852
+ error?: string;
1853
+ };
1854
+ shown: {
1855
+ label: string;
1856
+ value: string;
1857
+ kind?: "mono" | "time";
1858
+ note?: string;
1859
+ warn?: true;
1929
1860
  }[];
1930
- replaces: string[];
1931
- withheld: string[];
1932
1861
  };
1933
1862
  type Deletion = {
1934
1863
  path: string;
@@ -1947,23 +1876,6 @@ type Deletion = {
1947
1876
  }[];
1948
1877
  stranded: string[];
1949
1878
  };
1950
- type Decision = {
1951
- status: "approved" | "cancelled" | "denied" | "expired" | "failed" | "pending";
1952
- outcome: {
1953
- text: string;
1954
- result?: {
1955
- [key: string]: unknown;
1956
- };
1957
- error?: string;
1958
- };
1959
- shown: {
1960
- label: string;
1961
- value: string;
1962
- kind?: "mono" | "time";
1963
- note?: string;
1964
- warn?: true;
1965
- }[];
1966
- };
1967
1879
  type DeletionResult = {
1968
1880
  dryRun: boolean;
1969
1881
  deletion: {
@@ -1984,24 +1896,12 @@ type DeletionResult = {
1984
1896
  stranded: string[];
1985
1897
  };
1986
1898
  };
1987
- type WorkloadIds = {
1988
- github: string;
1989
- repositoryId: string;
1990
- ownerId: string;
1991
- } | {
1992
- github: string;
1993
- ownerId: string;
1994
- } | {
1995
- gitlab: string;
1996
- projectId: string;
1997
- namespaceId: string;
1998
- };
1999
1899
  type DismissedKey = {
1900
+ dismissedBy: string;
1901
+ dismissedAt: string;
2000
1902
  key: string;
2001
1903
  in: string[];
2002
1904
  folder: string | null;
2003
- dismissedBy: string;
2004
- dismissedAt: string;
2005
1905
  };
2006
1906
  type DryRunOutcome = "added" | "archived" | "changed" | "unchanged";
2007
1907
  type DryRunResult = {
@@ -2010,6 +1910,12 @@ type DryRunResult = {
2010
1910
  [key: string]: "added" | "archived" | "changed" | "unchanged";
2011
1911
  };
2012
1912
  };
1913
+ type EnvironmentView = {
1914
+ slug: string;
1915
+ name: string;
1916
+ archivedAt: string | null;
1917
+ protected: boolean;
1918
+ };
2013
1919
  type IdentityRow = {
2014
1920
  id: string;
2015
1921
  provider: string;
@@ -2017,11 +1923,47 @@ type IdentityRow = {
2017
1923
  createdAt: string;
2018
1924
  lastSignInAt: string | null;
2019
1925
  };
1926
+ type ImpactLine = {
1927
+ change: "narrows" | "widens";
1928
+ permission: "audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write";
1929
+ protected: boolean;
1930
+ people: number;
1931
+ services: number;
1932
+ environments: number;
1933
+ projects: number;
1934
+ examples: string[];
1935
+ };
2020
1936
  type InheritResult = {
1937
+ inherit?: boolean;
1938
+ folder?: string | null;
1939
+ archived?: boolean;
1940
+ operationId: string | null;
2021
1941
  key: string;
2022
- archived: boolean;
2023
- folder: string | null;
2024
- from: string;
1942
+ };
1943
+ type KeysPlan = {
1944
+ issuer: string;
1945
+ jwksUri: string;
1946
+ keys: {
1947
+ kid: string | null;
1948
+ alg: "ES256" | "RS256";
1949
+ thumbprint: string;
1950
+ }[];
1951
+ replaces: string[];
1952
+ withheld: string[];
1953
+ };
1954
+ type ListedReference = {
1955
+ readers: null | string[];
1956
+ canBreak: boolean;
1957
+ holderArchived: boolean;
1958
+ id: string;
1959
+ holder: string;
1960
+ source: string;
1961
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
1962
+ version: number | null;
1963
+ createdBy: string | null;
1964
+ createdAt: string | null;
1965
+ endedBy: null;
1966
+ endedAt: null;
2025
1967
  };
2026
1968
  type Me = {
2027
1969
  principal: {
@@ -2178,7 +2120,7 @@ type OffboardingReport = {
2178
2120
  at: string;
2179
2121
  }[];
2180
2122
  rotated: number;
2181
- issuedTokens: {
2123
+ issuedTokens: null | {
2182
2124
  id: string;
2183
2125
  service: string;
2184
2126
  label: string | null;
@@ -2189,7 +2131,7 @@ type OffboardingReport = {
2189
2131
  [key: string]: string;
2190
2132
  };
2191
2133
  }[];
2192
- apps: {
2134
+ apps: null | {
2193
2135
  id: string;
2194
2136
  name: string;
2195
2137
  host: string | null;
@@ -2200,7 +2142,7 @@ type OffboardingReport = {
2200
2142
  lastUsedIp: string | null;
2201
2143
  expiresAt: string;
2202
2144
  }[];
2203
- personalTokens: {
2145
+ personalTokens: null | {
2204
2146
  id: string;
2205
2147
  label: string | null;
2206
2148
  hint: string;
@@ -2216,17 +2158,22 @@ type OffboardingReport = {
2216
2158
  bindingId: string | null;
2217
2159
  };
2218
2160
  }[];
2219
- references: {
2161
+ references: null | {
2162
+ version: number | null;
2163
+ source: string;
2220
2164
  id: string;
2165
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2221
2166
  holder: string;
2222
- source: string;
2223
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2224
- version: number | null;
2167
+ endedBy: null;
2168
+ endedAt: null;
2225
2169
  createdBy: string;
2226
2170
  createdAt: string;
2227
- endedBy: string | null;
2228
- endedAt: string | null;
2229
2171
  }[];
2172
+ totals: {
2173
+ issuedTokens: number | null;
2174
+ personalTokens: number | null;
2175
+ references: number | null;
2176
+ };
2230
2177
  personal: {
2231
2178
  project: string;
2232
2179
  of: string;
@@ -2234,27 +2181,13 @@ type OffboardingReport = {
2234
2181
  }[];
2235
2182
  };
2236
2183
  type PersonalConfig = {
2237
- owner: string;
2238
2184
  of: string;
2185
+ owner: string;
2239
2186
  slug: string;
2240
2187
  keys: string[];
2241
2188
  archived: boolean;
2242
2189
  createdAt: string;
2243
2190
  };
2244
- type ListedReference = {
2245
- id: string;
2246
- holder: string;
2247
- source: string;
2248
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2249
- version: number | null;
2250
- createdBy: string;
2251
- createdAt: string;
2252
- endedBy: string | null;
2253
- endedAt: string | null;
2254
- readers: null | string[];
2255
- canBreak: boolean;
2256
- holderArchived: boolean;
2257
- };
2258
2191
  type ProjectSummary = {
2259
2192
  slug: string;
2260
2193
  name: string;
@@ -2280,28 +2213,18 @@ type ReferenceView = {
2280
2213
  id: string;
2281
2214
  holder: string;
2282
2215
  source: string;
2283
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2216
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2284
2217
  version: number | null;
2285
- createdBy: string;
2286
- createdAt: string;
2287
- endedBy: string | null;
2288
- endedAt: string | null;
2218
+ createdBy: string | null;
2219
+ createdAt: string | null;
2220
+ endedBy: null;
2221
+ endedAt: null;
2289
2222
  };
2290
2223
  type RemovedMember = {
2291
2224
  principalType: "service" | "user";
2292
2225
  principalId: string;
2293
2226
  toRotate: number;
2294
2227
  };
2295
- type ImpactLine = {
2296
- change: "narrows" | "widens";
2297
- permission: "audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write";
2298
- protected: boolean;
2299
- people: number;
2300
- services: number;
2301
- environments: number;
2302
- projects: number;
2303
- examples: string[];
2304
- };
2305
2228
  type RoleImpact = {
2306
2229
  impact: {
2307
2230
  change: "narrows" | "widens";
@@ -2373,32 +2296,28 @@ type RolesView = {
2373
2296
  }[];
2374
2297
  editable: boolean;
2375
2298
  };
2376
- type EnvironmentView = {
2377
- slug: string;
2378
- name: string;
2379
- archivedAt: string | null;
2380
- protected: boolean;
2381
- };
2382
2299
  type SecretKey = {
2383
2300
  key: string;
2384
2301
  reference: null | {
2385
2302
  id: string;
2386
2303
  holder: string;
2387
2304
  source: string;
2388
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2305
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2389
2306
  version: number | null;
2390
- createdBy: string;
2391
- createdAt: string;
2392
- endedBy: string | null;
2393
- endedAt: string | null;
2307
+ createdBy: string | null;
2308
+ createdAt: string | null;
2309
+ endedBy: null;
2310
+ endedAt: null;
2311
+ sourceId: string;
2394
2312
  canOpenSource: boolean;
2395
2313
  };
2396
2314
  folder: string | null;
2397
2315
  archived: boolean;
2398
2316
  version: number | null;
2317
+ versionId: string | null;
2318
+ secret: string | null;
2399
2319
  updatedAt: string | null;
2400
2320
  updatedBy: string | null;
2401
- versionId: string | null;
2402
2321
  generated: null | {
2403
2322
  recipe: string;
2404
2323
  pair?: {
@@ -2440,7 +2359,7 @@ type SessionRow = {
2440
2359
  current: boolean;
2441
2360
  };
2442
2361
  type SetResult = {
2443
- operationId: string;
2362
+ operationId: string | null;
2444
2363
  keys: {
2445
2364
  [key: string]: {
2446
2365
  version: number;
@@ -2474,6 +2393,18 @@ type TokenRow = {
2474
2393
  bindingId: string | null;
2475
2394
  };
2476
2395
  };
2396
+ type WorkloadIds = {
2397
+ github: string;
2398
+ repositoryId: string;
2399
+ ownerId: string;
2400
+ } | {
2401
+ github: string;
2402
+ ownerId: string;
2403
+ } | {
2404
+ gitlab: string;
2405
+ projectId: string;
2406
+ namespaceId: string;
2407
+ };
2477
2408
  //#endregion
2478
2409
  //#region src/age.d.ts
2479
2410
  /**
@@ -2518,6 +2449,29 @@ declare function apiMember(member: string): string;
2518
2449
  /** A service account's name alone, from any of its forms: `deploy`, `service:deploy` or `token:deploy`. */
2519
2450
  declare function serviceName(member: string): string;
2520
2451
  //#endregion
2452
+ //#region src/proofs.d.ts
2453
+ type Page = Api['GET /audit']['output'];
2454
+ type ProofJudgment = {
2455
+ /** The vault's head the page was proven against; none stands before the signer's first batch. */
2456
+ head: Page['head'];
2457
+ /** Entries the head numbers, which a page waits for: a batch signed between the head's read and the log's can put every one past it. */
2458
+ numbered: number;
2459
+ proven: number;
2460
+ /** Within the head and not what it signed. */
2461
+ failed: AuditEntryView[];
2462
+ /** Neither failed nor as the head places it: unproven though the head numbers it, or proven past it. The signer signs in order, so the head numbers the log's first `size` entries. */
2463
+ misplaced: AuditEntryView[];
2464
+ /** What the page's stretch lacks, by the trees' counts: null when it cannot say, on a page that is not of the whole log, or with no head. */
2465
+ missing: Page['holes'];
2466
+ /**
2467
+ * A page to ask again before judging it, as a race between the head's read and the log's can leave it, honestly:
2468
+ * a batch signed in between puts every listed entry past the head, and a pruning committed in between leaves the
2469
+ * older head counting uses it removed, a stretch lacking aging entries alone. A fresh page past the race says neither.
2470
+ */
2471
+ racing: boolean;
2472
+ };
2473
+ declare function judgeProofs(page: Page): ProofJudgment;
2474
+ //#endregion
2521
2475
  //#region src/reach.d.ts
2522
2476
  /**
2523
2477
  * Why an instance could not be reached, from what `fetch` threw. Node's
@@ -2704,10 +2658,10 @@ declare function createClient(options: ClientOptions): {
2704
2658
  };
2705
2659
  created: boolean;
2706
2660
  forked: null | {
2707
- from: string;
2708
2661
  keys: number;
2709
2662
  references: number;
2710
2663
  copied: string[];
2664
+ from: string;
2711
2665
  inherits: boolean;
2712
2666
  };
2713
2667
  }>;
@@ -2763,18 +2717,18 @@ declare function createClient(options: ClientOptions): {
2763
2717
  folder: string | null;
2764
2718
  }[];
2765
2719
  dismissed: {
2720
+ dismissedBy: string;
2721
+ dismissedAt: string;
2766
2722
  key: string;
2767
2723
  in: string[];
2768
2724
  folder: string | null;
2769
- dismissedBy: string;
2770
- dismissedAt: string;
2771
2725
  }[];
2772
2726
  }>;
2773
2727
  /** A project's personal configs, for whoever manages its environments: whose, of what, and their key names. */
2774
2728
  personal: (project: string) => Promise<{
2775
2729
  configs: {
2776
- owner: string;
2777
2730
  of: string;
2731
+ owner: string;
2778
2732
  slug: string;
2779
2733
  keys: string[];
2780
2734
  archived: boolean;
@@ -2791,7 +2745,7 @@ declare function createClient(options: ClientOptions): {
2791
2745
  }>;
2792
2746
  /** Dismiss missing keys (`true`) or restore them (`null`). */
2793
2747
  dismiss: (path: string, patch: RouteInput<"PATCH /projects/:project/:environment/dismissals">) => Promise<{
2794
- operationId: string;
2748
+ operationId: string | null;
2795
2749
  keys: {
2796
2750
  [key: string]: "dismissed" | "restored" | "unchanged";
2797
2751
  };
@@ -2807,25 +2761,25 @@ declare function createClient(options: ClientOptions): {
2807
2761
  id: string;
2808
2762
  holder: string;
2809
2763
  source: string;
2810
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2764
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2811
2765
  version: number | null;
2812
- createdBy: string;
2813
- createdAt: string;
2814
- endedBy: string | null;
2815
- endedAt: string | null;
2766
+ createdBy: string | null;
2767
+ createdAt: string | null;
2768
+ endedBy: null;
2769
+ endedAt: null;
2770
+ sourceId: string;
2816
2771
  canOpenSource: boolean;
2817
2772
  };
2818
2773
  folder: string | null;
2819
2774
  archived: boolean;
2820
2775
  version: number | null;
2776
+ versionId: string | null;
2777
+ secret: string | null;
2821
2778
  updatedAt: string | null;
2822
2779
  updatedBy: string | null;
2823
- versionId: string | null;
2824
2780
  generated: null | {
2825
2781
  recipe: string;
2826
- pair?
2827
- /** Who I am, and every place I can reach. */
2828
- /** Who I am, and every place I can reach. */ : {
2782
+ pair?: {
2829
2783
  private: string;
2830
2784
  public: string;
2831
2785
  };
@@ -2853,10 +2807,16 @@ declare function createClient(options: ClientOptions): {
2853
2807
  }>;
2854
2808
  /** Decrypts one secret, or every secret in an environment, or, `keys` named, those of it only. Logged in your name. */
2855
2809
  reveal: (path: string, keys?: string[]) => Promise<{
2856
- operationId: string;
2810
+ operationId: string | null;
2857
2811
  values: {
2858
2812
  [key: string]: string;
2859
2813
  };
2814
+ versions: {
2815
+ [key: string]: number;
2816
+ };
2817
+ secrets: {
2818
+ [key: string]: string;
2819
+ };
2860
2820
  sensitive: string[];
2861
2821
  useOnly: string[];
2862
2822
  version: string | null;
@@ -2882,27 +2842,40 @@ declare function createClient(options: ClientOptions): {
2882
2842
  plain: boolean;
2883
2843
  sensitivity: "plain" | "secret" | "sensitive";
2884
2844
  }[];
2845
+ more: boolean;
2885
2846
  }>;
2886
2847
  /** A new version holding the old one's value. */
2887
2848
  restore: (path: string, version: number) => Promise<{
2849
+ operationId: string | null;
2888
2850
  key: string;
2889
2851
  version: number;
2852
+ sensitivity: "plain" | "secret" | "sensitive";
2890
2853
  }>;
2891
2854
  rename: (path: string, key: string) => Promise<{
2855
+ inherit?: boolean;
2856
+ folder?: string | null;
2857
+ archived?: boolean;
2858
+ operationId: string | null;
2892
2859
  key: string;
2893
- archived: boolean;
2894
- folder: string | null;
2895
2860
  }>;
2896
2861
  update: (path: string, patch: RouteInput<"PATCH /secrets/:project/:environment/:key">) => Promise<{
2862
+ inherit?: boolean;
2863
+ folder?: string | null;
2864
+ archived?: boolean;
2865
+ operationId: string | null;
2897
2866
  key: string;
2898
- archived: boolean;
2899
- folder: string | null;
2900
2867
  }>;
2901
2868
  /**
2902
2869
  * In a fork, a key back to its parent's value (`true`), its own kept,
2903
- * or its own served again (`false`); `from` holds the parent's.
2870
+ * or its own served again (`false`); the answer says which, `inherit`.
2904
2871
  */
2905
- inherit: (path: string, inherit: boolean) => Promise<InheritResult>;
2872
+ inherit: (path: string, inherit: boolean) => Promise<{
2873
+ inherit?: boolean;
2874
+ folder?: string | null;
2875
+ archived?: boolean;
2876
+ operationId: string | null;
2877
+ key: string;
2878
+ }>;
2906
2879
  };
2907
2880
  /**
2908
2881
  * References: secrets read through others (docs/design/environments.md).
@@ -2912,32 +2885,27 @@ declare function createClient(options: ClientOptions): {
2912
2885
  /** The live references into and out of a place, `market`, `market/prod` or `market/prod/KEY`, and who reads through them. */
2913
2886
  list: (path: string) => Promise<{
2914
2887
  references: {
2888
+ readers: null | string[];
2889
+ canBreak: boolean;
2890
+ holderArchived: boolean;
2915
2891
  id: string;
2916
2892
  holder: string;
2917
2893
  source: string;
2918
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2894
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2919
2895
  version: number | null;
2920
- createdBy: string;
2921
- createdAt: string;
2922
- endedBy: string | null;
2923
- endedAt: string | null;
2924
- readers: null | string[];
2925
- canBreak: boolean;
2926
- holderArchived: boolean;
2896
+ createdBy: string | null;
2897
+ createdAt: string | null;
2898
+ endedBy: null;
2899
+ endedAt: null;
2927
2900
  }[];
2928
2901
  }>;
2929
2902
  /** Break the reference a secret is: its readers stop reading the source through it. */
2930
2903
  break: (path: string) => Promise<{
2904
+ operationId: string | null;
2931
2905
  reference: {
2932
- id: string;
2933
2906
  holder: string;
2934
2907
  source: string;
2935
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
2936
- version: number | null;
2937
- createdBy: string;
2938
- createdAt: string;
2939
- endedBy: string | null;
2940
- endedAt: string | null;
2908
+ state: "broken";
2941
2909
  };
2942
2910
  }>;
2943
2911
  };
@@ -3018,7 +2986,7 @@ declare function createClient(options: ClientOptions): {
3018
2986
  at: string;
3019
2987
  }[];
3020
2988
  rotated: number;
3021
- issuedTokens: {
2989
+ issuedTokens: null | {
3022
2990
  id: string;
3023
2991
  service: string;
3024
2992
  label: string | null;
@@ -3029,7 +2997,7 @@ declare function createClient(options: ClientOptions): {
3029
2997
  [key: string]: string;
3030
2998
  };
3031
2999
  }[];
3032
- apps: {
3000
+ apps: null | {
3033
3001
  id: string;
3034
3002
  name: string;
3035
3003
  host: string | null;
@@ -3040,7 +3008,7 @@ declare function createClient(options: ClientOptions): {
3040
3008
  lastUsedIp: string | null;
3041
3009
  expiresAt: string;
3042
3010
  }[];
3043
- personalTokens: {
3011
+ personalTokens: null | {
3044
3012
  id: string;
3045
3013
  label: string | null;
3046
3014
  hint: string;
@@ -3056,17 +3024,22 @@ declare function createClient(options: ClientOptions): {
3056
3024
  bindingId: string | null;
3057
3025
  };
3058
3026
  }[];
3059
- references: {
3027
+ references: null | {
3028
+ version: number | null;
3029
+ source: string;
3060
3030
  id: string;
3031
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
3061
3032
  holder: string;
3062
- source: string;
3063
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
3064
- version: number | null;
3033
+ endedBy: null;
3034
+ endedAt: null;
3065
3035
  createdBy: string;
3066
3036
  createdAt: string;
3067
- endedBy: string | null;
3068
- endedAt: string | null;
3069
3037
  }[];
3038
+ totals: {
3039
+ issuedTokens: number | null;
3040
+ personalTokens: number | null;
3041
+ references: number | null;
3042
+ };
3070
3043
  personal: {
3071
3044
  project: string;
3072
3045
  of: string;
@@ -3168,7 +3141,7 @@ declare function createClient(options: ClientOptions): {
3168
3141
  at: string;
3169
3142
  }[];
3170
3143
  rotated: number;
3171
- issuedTokens: {
3144
+ issuedTokens: null | {
3172
3145
  id: string;
3173
3146
  service: string;
3174
3147
  label: string | null;
@@ -3179,7 +3152,7 @@ declare function createClient(options: ClientOptions): {
3179
3152
  [key: string]: string;
3180
3153
  };
3181
3154
  }[];
3182
- apps: {
3155
+ apps: null | {
3183
3156
  id: string;
3184
3157
  name: string;
3185
3158
  host: string | null;
@@ -3190,7 +3163,7 @@ declare function createClient(options: ClientOptions): {
3190
3163
  lastUsedIp: string | null;
3191
3164
  expiresAt: string;
3192
3165
  }[];
3193
- personalTokens: {
3166
+ personalTokens: null | {
3194
3167
  id: string;
3195
3168
  label: string | null;
3196
3169
  hint: string;
@@ -3206,17 +3179,22 @@ declare function createClient(options: ClientOptions): {
3206
3179
  bindingId: string | null;
3207
3180
  };
3208
3181
  }[];
3209
- references: {
3182
+ references: null | {
3183
+ version: number | null;
3184
+ source: string;
3210
3185
  id: string;
3186
+ state: "broken" | "live" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
3211
3187
  holder: string;
3212
- source: string;
3213
- state: "broken" | "live" | "replaced" | "source_archived" | "source_deleted" | "source_empty" | "source_is_reference";
3214
- version: number | null;
3188
+ endedBy: null;
3189
+ endedAt: null;
3215
3190
  createdBy: string;
3216
3191
  createdAt: string;
3217
- endedBy: string | null;
3218
- endedAt: string | null;
3219
3192
  }[];
3193
+ totals: {
3194
+ issuedTokens: number | null;
3195
+ personalTokens: number | null;
3196
+ references: number | null;
3197
+ };
3220
3198
  personal: {
3221
3199
  project: string;
3222
3200
  of: string;
@@ -3303,16 +3281,9 @@ declare function createClient(options: ClientOptions): {
3303
3281
  keyAudience?: true;
3304
3282
  sessionHours?: number;
3305
3283
  replicas?: number;
3306
- sessionDays?: number;
3284
+ sessionDays? /** Delete an archived environment for good, as a project is. Owners only. */ : number;
3307
3285
  overlapMinutes?: number;
3308
- mintedBy?
3309
- /**
3310
- * The instance's roles, in two columns, an environment's that is not
3311
- * protected and one's that is (docs/design/roles.md). Any member lists
3312
- * them; an Owner of the whole instance edits them. `instance` is about
3313
- * instance roles, a person's across every project in their scope.
3314
- */
3315
- : string;
3286
+ mintedBy?: string;
3316
3287
  approve?: true;
3317
3288
  onContention?: "alert";
3318
3289
  unsignedUploads?: true;
@@ -3328,17 +3299,15 @@ declare function createClient(options: ClientOptions): {
3328
3299
  }>;
3329
3300
  /** The binding as it would be saved, the keys its issuer names, and what it replaces; writes nothing. */
3330
3301
  preview: (member: string, input: RouteInput<"POST /members/:member/bindings">) => Promise<BindingPlan>;
3331
- create: (member: string, input: RouteInput<"POST /members/:member/bindings">) => Promise<{
3332
- binding: BindingView;
3333
- replaced: string[];
3334
- }>;
3335
- /** The service's bindings on an issuer that new keys would replace, and the keys as checked; writes nothing. */
3302
+ create: (member: string, input: RouteInput<"POST /members/:member/bindings">) => Promise<Extract<RouteOutput<"POST /members/:member/bindings">, {
3303
+ binding: unknown;
3304
+ }>>;
3305
+ /** The service's bindings on an issuer that new keys would replace, the keys as checked, and the places they would withhold; writes nothing. */
3336
3306
  previewKeys: (member: string, input: RouteInput<"POST /members/:member/bindings/keys">) => Promise<KeysPlan>;
3337
3307
  /** New keys, uploaded, for every binding of the service on the issuer: each replaced by one the same but for them. */
3338
- replaceKeys: (member: string, input: RouteInput<"POST /members/:member/bindings/keys">) => Promise<{
3339
- bindings: BindingView[];
3340
- replaced: string[];
3341
- }>;
3308
+ replaceKeys: (member: string, input: RouteInput<"POST /members/:member/bindings/keys">) => Promise<Extract<RouteOutput<"POST /members/:member/bindings/keys">, {
3309
+ bindings: unknown;
3310
+ }>>;
3342
3311
  remove: (member: string, id: string) => Promise<{
3343
3312
  unbound: true;
3344
3313
  }>;
@@ -3373,29 +3342,36 @@ declare function createClient(options: ClientOptions): {
3373
3342
  app: null;
3374
3343
  }>;
3375
3344
  };
3345
+ /**
3346
+ * Freezes: every use under a target refused from its next request, its
3347
+ * sessions kept, until lifted. A target is `instance`, `service:<name>`,
3348
+ * `binding:<id>` or `session:<id>`.
3349
+ */
3350
+ freezes: {
3351
+ /** The freezes standing that you may know of: the instance's, and those of the service accounts you manage. */
3352
+ list: () => Promise<{
3353
+ freezes: {
3354
+ target: string;
3355
+ service: string | null;
3356
+ frozenAt: string;
3357
+ }[];
3358
+ }>;
3359
+ freeze: (target: string, reason: string) => Promise<{
3360
+ target: string;
3361
+ frozenAt: string | null;
3362
+ }>;
3363
+ /** Lifts it; a target that is not frozen stays so. */
3364
+ unfreeze: (target: string) => Promise<{
3365
+ target: string;
3366
+ frozenAt: string | null;
3367
+ }>;
3368
+ };
3376
3369
  access: {
3377
3370
  /** What they should hold at each place; the server applies the difference. `null` revokes. */
3378
3371
  set: (member: string, access: RouteInput<"PATCH /access/:member">) => Promise<{
3379
3372
  changes: {
3380
3373
  [key: string]: "created" | "revoked" | "unchanged" | "updated";
3381
3374
  };
3382
- admitted?: {
3383
- created: boolean;
3384
- role: "admin" | "auditor" | "developer" | "member" | "owner";
3385
- scope: {
3386
- projects: "all" | {
3387
- only: string[];
3388
- } | {
3389
- except: string[];
3390
- };
3391
- environments: "all" | {
3392
- only: string[];
3393
- } | {
3394
- except: string[];
3395
- };
3396
- };
3397
- generation: number;
3398
- };
3399
3375
  }>;
3400
3376
  };
3401
3377
  /** Where I am signed in. Only where coffre runs its own sign-in. */
@@ -3413,6 +3389,7 @@ declare function createClient(options: ClientOptions): {
3413
3389
  lastUsedIp: string | null;
3414
3390
  current: boolean;
3415
3391
  }[];
3392
+ more: boolean;
3416
3393
  }>;
3417
3394
  revoke: (id: string) => Promise<{
3418
3395
  revoked: true;
@@ -3428,6 +3405,7 @@ declare function createClient(options: ClientOptions): {
3428
3405
  createdAt: string;
3429
3406
  lastSignInAt: string | null;
3430
3407
  }[];
3408
+ more: boolean;
3431
3409
  }>;
3432
3410
  unlink: (id: string) => Promise<{
3433
3411
  unlinked: true;
@@ -3459,22 +3437,24 @@ declare function createClient(options: ClientOptions): {
3459
3437
  folders: {
3460
3438
  /** A folder of projects, renamed. Takes managing every project in it. */
3461
3439
  rename: (folder: string, name: string) => Promise<{
3462
- folder: string | null;
3440
+ folder: string;
3463
3441
  moved: string[];
3464
3442
  }>;
3465
3443
  /** Every project out of a folder. */
3466
3444
  remove: (folder: string) => Promise<{
3467
- folder: string | null;
3445
+ folder: null;
3468
3446
  moved: string[];
3469
3447
  }>;
3470
3448
  /** One of an environment's key folders, `market/prod`, renamed. Takes writing there. */
3471
3449
  renameKeys: (environment: string, folder: string, name: string) => Promise<{
3472
- folder: string | null;
3450
+ operationId: string | null;
3451
+ folder: string;
3473
3452
  moved: string[];
3474
3453
  }>;
3475
3454
  /** Every key out of one of an environment's folders. */
3476
3455
  removeKeys: (environment: string, folder: string) => Promise<{
3477
- folder: string | null;
3456
+ operationId: string | null;
3457
+ folder: null;
3478
3458
  moved: string[];
3479
3459
  }>;
3480
3460
  };
@@ -3722,88 +3702,36 @@ declare function createClient(options: ClientOptions): {
3722
3702
  metadata: {
3723
3703
  [key: string]: unknown;
3724
3704
  };
3705
+ proof: "failed" | "proven" | "unproven";
3725
3706
  }[];
3726
3707
  more: boolean;
3708
+ next: number | null;
3727
3709
  hidden?: {
3728
3710
  action: string;
3729
3711
  count: number;
3730
3712
  }[];
3731
- }>;
3732
- /**
3733
- * Whether the log holds, from the newest checkpoint; or, with `from`, a
3734
- * stretch of the walk from the first entry: `start`, then each `next`
3735
- * until it is null (`verifyWhole`).
3736
- */
3737
- verify: (query?: RouteInput<"GET /audit/verification">) => Promise<{
3738
- ok: true;
3739
- through: number | null;
3740
- entries: number;
3741
- from: number;
3742
- remaining: number;
3743
- next?: string | null;
3744
- checkpoint: null | {
3745
- seq: number;
3746
- signedAt: string;
3747
- };
3748
- pending?: number;
3749
- } | {
3750
- ok: false;
3751
- through: number | null;
3752
- failedAtSeq: number | null;
3753
- author: "app" | "vault";
3754
- reason: string;
3755
- }>;
3756
- /**
3757
- * The walk from the first entry to the head, a stretch a request, each
3758
- * as long as the server walks in one: the first stretch that fails, or
3759
- * the last. `onStretch` sees each verdict as it comes.
3760
- */
3761
- verifyWhole: (onStretch?: (verdict: RouteOutput<"GET /audit/verification">) => void) => Promise<{
3762
- ok: true;
3763
- through: number | null;
3764
- entries: number;
3765
- from: number;
3766
- remaining: number;
3767
- next?: string | null;
3768
- checkpoint: null | {
3769
- seq: number;
3713
+ head: null | {
3714
+ size: number;
3770
3715
  signedAt: string;
3771
3716
  };
3772
- pending?: number;
3773
- } | {
3774
- ok: false;
3775
- through: number | null;
3776
- failedAtSeq: number | null;
3777
- author: "app" | "vault";
3778
- reason: string;
3717
+ holes: null | {
3718
+ above: number | null;
3719
+ below: number | null;
3720
+ kept: number;
3721
+ aging: number;
3722
+ }[];
3779
3723
  }>;
3780
3724
  /** What an escrowed key is checked against: public material, for admins and owners of the whole instance. */
3781
3725
  keys: () => Promise<{
3782
- app: {
3783
- keyId: string;
3784
- previous?: string[];
3785
- };
3786
- vault: {
3787
- current: {
3788
- vaultId: string;
3789
- provider: string;
3790
- };
3791
- checks: {
3792
- seq: number;
3793
- vaultId: string;
3794
- provider: string;
3795
- version: string;
3796
- wrapped: string;
3797
- }[];
3726
+ kek: {
3727
+ provider: string;
3728
+ id: string;
3798
3729
  };
3799
- }>;
3800
- /**
3801
- * Accept that entries `from` to `to` are lost for good, as an Owner of
3802
- * the whole instance: the audit watch's finding, inside the range, stays
3803
- * in the log, and its anchor goes on past them.
3804
- */
3805
- acceptLoss: (range: RouteInput<"POST /audit/loss">) => Promise<{
3806
- resumes: number | null;
3730
+ previous: {
3731
+ provider: string;
3732
+ id: string;
3733
+ }[];
3734
+ checks: string[];
3807
3735
  }>;
3808
3736
  };
3809
3737
  };
@@ -3828,4 +3756,4 @@ declare function planImport(coffre: CoffreClient, path: string, entries: readonl
3828
3756
  changes: Record<string, string>;
3829
3757
  }>;
3830
3758
  //#endregion
3831
- export { RolesView as $, Decision as A, KeysPlan as B, ApprovalView as C, BindingPlan as D, AuthorizationView as E, DryRunResult as F, MissingKey as G, Me as H, EnvironmentView as I, ProjectSummary as J, OffboardingReport as K, IdentityRow as L, DeletionResult as M, DismissedKey as N, BindingView as O, DryRunOutcome as P, RoleView as Q, ImpactLine as R, Api as S, AuthInfo as T, Member as U, ListedReference as V, MemberAccess as W, RemovedMember as X, ReferenceView as Y, RoleImpact as Z, byFolder as _, Params as a, TokenRow as at, olderThan as b, RouteOutput as c, planImport as d, SecretKey as et, Unreachable as f, shownMember as g, serviceName as h, ImportAction as i, TokenPlan as it, Deletion as j, ConnectedApp as k, Transport as l, apiMember as m, CoffreClient as n, SessionRow as nt, RouteInput as o, WorkloadIds as ot, unreachable as p, PersonalConfig as q, CoffreError as r, SetResult as rt, RouteKey as s, ClientOptions as t, SecretVersion as tt, createClient as u, foldersOf as v, AuditEntryView as w, AccessValue as x, ageInDays as y, InheritResult as z };
3759
+ export { RoleImpact as $, BindingView as A, ImpactLine as B, AccessValue as C, AuthInfo as D, AuditEntryView as E, DismissedKey as F, Member as G, KeysPlan as H, DryRunOutcome as I, OffboardingReport as J, MemberAccess as K, DryRunResult as L, Decision as M, Deletion as N, AuthorizationView as O, DeletionResult as P, RemovedMember as Q, EnvironmentView as R, olderThan as S, ApprovalView as T, ListedReference as U, InheritResult as V, Me as W, ProjectSummary as X, PersonalConfig as Y, ReferenceView as Z, serviceName as _, Params as a, SetResult as at, foldersOf as b, RouteOutput as c, WorkloadIds as ct, planImport as d, RoleView as et, Unreachable as f, apiMember as g, judgeProofs as h, ImportAction as i, SessionRow as it, ConnectedApp as j, BindingPlan as k, Transport as l, ProofJudgment as m, CoffreClient as n, SecretKey as nt, RouteInput as o, TokenPlan as ot, unreachable as p, MissingKey as q, CoffreError as r, SecretVersion as rt, RouteKey as s, TokenRow as st, ClientOptions as t, RolesView as tt, createClient as u, shownMember as v, Api as w, ageInDays as x, byFolder as y, IdentityRow as z };