@meshery/schemas 1.3.111 → 1.3.112

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.
@@ -0,0 +1,466 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ "/api/identity/oauth/consents": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ /**
15
+ * List OAuth consents
16
+ * @description Returns a page of the live OAuth consents of the signed-in user, one
17
+ * entry per client, ordered by updatedAt descending (a re-consent moves
18
+ * a consent to the top). Revoked consents are
19
+ * not listed. A user with no consented client receives an empty page.
20
+ * `scopes` is the set the latest consent granted. A re-consent also
21
+ * changes the client's existing tokens, as the OauthConsent schema
22
+ * description states.
23
+ *
24
+ * Only a request authenticated by the person's signed-in session may
25
+ * list consents. A request authenticated by a token, of any kind, answers
26
+ * 403 and lists nothing. The page holds the consents of every client the
27
+ * user has allowed, so listing it to a client would disclose other
28
+ * clients' consents to that client, which is why a token may not list.
29
+ */
30
+ get: operations["getOauthConsents"];
31
+ put?: never;
32
+ post?: never;
33
+ /**
34
+ * Revoke an OAuth consent
35
+ * @description Revokes the signed-in user's consent for the client named by the
36
+ * required `clientId` query parameter, and revokes every access and
37
+ * refresh token that client holds for the user. The consents and tokens
38
+ * of other users of the same client are untouched. Answers 204 with no
39
+ * body. The consent is soft-deleted: its `deletedAt` is set and it is no
40
+ * longer listed. For a session, and for a token naming its own client, a
41
+ * client the user has no live consent for, whether it never existed, was
42
+ * never consented to or was already revoked, is a 404.
43
+ *
44
+ * Who may revoke depends on how the request is authenticated:
45
+ * - A request authenticated by the person's signed-in session may revoke
46
+ * any of that user's consents.
47
+ * - A request authenticated by a token issued to an OAuth client may
48
+ * revoke only the consent of the client the token was issued to. Naming
49
+ * any other `clientId` answers 403 and changes nothing. The 403 does
50
+ * not depend on whether that client has a live consent, so the answer
51
+ * reveals nothing about another client.
52
+ * - A personal API token, one not issued to an OAuth client, cannot revoke
53
+ * a consent. Every such request answers 403 and changes nothing.
54
+ */
55
+ delete: operations["deleteOauthConsent"];
56
+ options?: never;
57
+ head?: never;
58
+ patch?: never;
59
+ trace?: never;
60
+ };
61
+ }
62
+ export type webhooks = Record<string, never>;
63
+ export interface components {
64
+ schemas: {
65
+ /**
66
+ * OAuth Consent Schema
67
+ * @description Server-returned OAuth consent: one OAuth client (a connected app) the
68
+ * signed-in user has allowed to act on their behalf, with what it was granted.
69
+ * Unique key: (user, `clientId`) among live consents (`deletedAt` null). A
70
+ * user has at most one live consent per client, so `clientId` identifies the
71
+ * consent among the user's own; `id` is the stored row's ID. The consent
72
+ * names one root organization; the client acts only in that organization and
73
+ * its descendants. Created by the authorization server's consent step and
74
+ * soft-deleted by revoking it; there is no write payload. A re-consent by the
75
+ * same user to a client with a live consent updates that consent in place:
76
+ * its scopes are replaced and `updatedAt` advances, while `id` and
77
+ * `createdAt` are kept.
78
+ * A re-consent keeps the consent's `organizationId`. The consent moves to
79
+ * another organization only when the user explicitly chooses that organization
80
+ * on the consent screen. Then every existing token issued to that client for
81
+ * that user is revoked in the same transaction, whatever its keychains, and this
82
+ * overrides the token rules below. Tokens are never re-bound to a new
83
+ * organization silently: the client gets a token for the new organization only
84
+ * under the consent that names it.
85
+ * A consent must name a keychain scope. The server refuses a first consent
86
+ * in which no scope maps to a keychain in its scope map, with `400` and nothing
87
+ * stored; a re-consent that names no keychain scope revokes (below). The schema cannot state this: `scopes` has minItems 1,
88
+ * which stops only an empty list. The rule is enforced by the server against
89
+ * the scope map, not by the schema. A scope string the scope map does not know
90
+ * is refused with `400`, never silently dropped. Standard non-keychain scopes,
91
+ * if the server accepts them at all (an open question), never count toward the
92
+ * keychain-scope minimum. A token is never issued under a consent with an empty
93
+ * keychain list, because a token limited to no keychains would hold no keys.
94
+ * Re-consent changes the client's existing tokens, in the same transaction as
95
+ * the consent update, by whether each token is scoped (`keychainScoped` true,
96
+ * or a non-empty `keychainIds`). Every token matches exactly one branch:
97
+ * - A scoped token gets `keychainIds` set to the
98
+ * intersection of its keychains and the keychains of the new scopes. A
99
+ * re-consent never adds keychains to a scoped token: a narrower re-consent
100
+ * narrows it, and a broader one leaves it unchanged. A token whose
101
+ * intersection is empty is revoked, not left with an empty list, because a
102
+ * scoped token with no keychains holds no keys. This also holds when the token's
103
+ * keychains were all deleted: its intersection is empty, so it is revoked,
104
+ * and it never gains keys.
105
+ * - An unrestricted token (`keychainScoped` false or absent and `keychainIds`
106
+ * empty or absent) gets `keychainIds` set to
107
+ * exactly the keychains of the new scopes, and `keychainScoped` set to true.
108
+ * - A re-consent that names no keychain scope (only scopes
109
+ * that map to no keychain) revokes: the consent is revoked (soft-deleted) and
110
+ * every token issued to that client for that user is revoked, in the same
111
+ * transaction. An unknown scope string is still refused with `400`.
112
+ * A scope added by a re-consent takes effect only for tokens issued after that
113
+ * consent, which is the user's fresh consent.
114
+ */
115
+ OauthConsent: {
116
+ /**
117
+ * Format: uuid
118
+ * @description Server-generated consent ID.
119
+ */
120
+ id: string;
121
+ /** @description OAuth client ID the consent was granted to. An identifier issued by the authorization server, not a UUID. Unique per user among live consents. */
122
+ clientId: string;
123
+ /** @description Display name the client registered, shown to the user as the connected app's name. */
124
+ clientName: string;
125
+ /**
126
+ * Format: uri
127
+ * @description Home page of the client, when it registered one. Omitted otherwise.
128
+ */
129
+ clientUri?: string;
130
+ /**
131
+ * Format: uri
132
+ * @description Logo of the client, when it registered one. Omitted otherwise.
133
+ */
134
+ logoUri?: string;
135
+ /** @description Scopes the user granted the client, as the strings the authorization server issues. A scope names one keychain, so the client's tokens are limited to the keys of those keychains (see the token scoping contract). At least one scope must map to a keychain in the server's scope map. The server refuses (`400`, nothing stored) a first consent without one (a re-consent without one revokes the consent and the client's tokens), and refuses a scope string the scope map does not know; it never drops one silently. Standard non-keychain scopes never count toward that minimum. The schema enforces only that the list is not empty; the rule is enforced by the server against the scope map. See the description of this schema. */
136
+ scopes: string[];
137
+ /**
138
+ * Format: uuid
139
+ * @description ID of the root organization the consent names. The client acts only in this organization and its descendants. A re-consent keeps it unless the user explicitly chooses another organization on the consent screen; see the description of this schema.
140
+ */
141
+ organizationId: string;
142
+ /**
143
+ * Format: date-time
144
+ * @description Time the user first granted the consent. A re-consent keeps it.
145
+ */
146
+ readonly createdAt: string;
147
+ /**
148
+ * Format: date-time
149
+ * @description Time the consent was last granted or changed. Server-set: equal to `createdAt` when the consent is created, and advanced when the same user consents to the same live client again, which replaces `scopes`.
150
+ */
151
+ readonly updatedAt: string;
152
+ /**
153
+ * Format: date-time
154
+ * @description Time the client last used a token issued under this consent. Null when the client has not used it yet or the server does not record use.
155
+ */
156
+ lastUsedAt?: string | null;
157
+ /**
158
+ * Format: date-time
159
+ * @description Time the consent was revoked (soft-deleted). Null while the consent is live. getOauthConsents returns live consents only.
160
+ */
161
+ deletedAt?: string | null;
162
+ };
163
+ /** @description Paginated collection of the signed-in user's live OAuth consents. */
164
+ OauthConsentPage: {
165
+ /** @description Current page number of the result set. */
166
+ page: number;
167
+ /** @description Number of items per page. */
168
+ pageSize: number;
169
+ /** @description Total number of items available. */
170
+ totalCount: number;
171
+ /** @description OAuth consents included on this page of results. */
172
+ oauthConsents: {
173
+ /**
174
+ * Format: uuid
175
+ * @description Server-generated consent ID.
176
+ */
177
+ id: string;
178
+ /** @description OAuth client ID the consent was granted to. An identifier issued by the authorization server, not a UUID. Unique per user among live consents. */
179
+ clientId: string;
180
+ /** @description Display name the client registered, shown to the user as the connected app's name. */
181
+ clientName: string;
182
+ /**
183
+ * Format: uri
184
+ * @description Home page of the client, when it registered one. Omitted otherwise.
185
+ */
186
+ clientUri?: string;
187
+ /**
188
+ * Format: uri
189
+ * @description Logo of the client, when it registered one. Omitted otherwise.
190
+ */
191
+ logoUri?: string;
192
+ /** @description Scopes the user granted the client, as the strings the authorization server issues. A scope names one keychain, so the client's tokens are limited to the keys of those keychains (see the token scoping contract). At least one scope must map to a keychain in the server's scope map. The server refuses (`400`, nothing stored) a first consent without one (a re-consent without one revokes the consent and the client's tokens), and refuses a scope string the scope map does not know; it never drops one silently. Standard non-keychain scopes never count toward that minimum. The schema enforces only that the list is not empty; the rule is enforced by the server against the scope map. See the description of this schema. */
193
+ scopes: string[];
194
+ /**
195
+ * Format: uuid
196
+ * @description ID of the root organization the consent names. The client acts only in this organization and its descendants. A re-consent keeps it unless the user explicitly chooses another organization on the consent screen; see the description of this schema.
197
+ */
198
+ organizationId: string;
199
+ /**
200
+ * Format: date-time
201
+ * @description Time the user first granted the consent. A re-consent keeps it.
202
+ */
203
+ readonly createdAt: string;
204
+ /**
205
+ * Format: date-time
206
+ * @description Time the consent was last granted or changed. Server-set: equal to `createdAt` when the consent is created, and advanced when the same user consents to the same live client again, which replaces `scopes`.
207
+ */
208
+ readonly updatedAt: string;
209
+ /**
210
+ * Format: date-time
211
+ * @description Time the client last used a token issued under this consent. Null when the client has not used it yet or the server does not record use.
212
+ */
213
+ lastUsedAt?: string | null;
214
+ /**
215
+ * Format: date-time
216
+ * @description Time the consent was revoked (soft-deleted). Null while the consent is live. getOauthConsents returns live consents only.
217
+ */
218
+ deletedAt?: string | null;
219
+ }[];
220
+ };
221
+ };
222
+ responses: {
223
+ /** @description Invalid request body or request param */
224
+ 400: {
225
+ headers: {
226
+ [name: string]: unknown;
227
+ };
228
+ content: {
229
+ "text/plain": string;
230
+ };
231
+ };
232
+ /** @description Expired JWT token used or insufficient privilege */
233
+ 401: {
234
+ headers: {
235
+ [name: string]: unknown;
236
+ };
237
+ content: {
238
+ "text/plain": string;
239
+ };
240
+ };
241
+ /** @description Forbidden */
242
+ 403: {
243
+ headers: {
244
+ [name: string]: unknown;
245
+ };
246
+ content: {
247
+ "text/plain": string;
248
+ };
249
+ };
250
+ /** @description Result not found */
251
+ 404: {
252
+ headers: {
253
+ [name: string]: unknown;
254
+ };
255
+ content: {
256
+ "text/plain": string;
257
+ };
258
+ };
259
+ /** @description Internal server error */
260
+ 500: {
261
+ headers: {
262
+ [name: string]: unknown;
263
+ };
264
+ content: {
265
+ "text/plain": string;
266
+ };
267
+ };
268
+ };
269
+ parameters: {
270
+ /** @description Get responses by page */
271
+ page: number;
272
+ /** @description Number of consents per page, at most 1000. Bounded here because the list is the signed-in user's whole consent set. */
273
+ oauthConsentPageSize: number;
274
+ /** @description OAuth client ID of the consent to revoke. An identifier issued by the authorization server, not a UUID. */
275
+ clientId: string;
276
+ };
277
+ requestBodies: never;
278
+ headers: never;
279
+ pathItems: never;
280
+ }
281
+ export type $defs = Record<string, never>;
282
+ export interface operations {
283
+ getOauthConsents: {
284
+ parameters: {
285
+ query?: {
286
+ /** @description Get responses by page */
287
+ page?: number;
288
+ /** @description Number of consents per page, at most 1000. Bounded here because the list is the signed-in user's whole consent set. */
289
+ pageSize?: number;
290
+ };
291
+ header?: never;
292
+ path?: never;
293
+ cookie?: never;
294
+ };
295
+ requestBody?: never;
296
+ responses: {
297
+ /** @description OAuth consents of the signed-in user */
298
+ 200: {
299
+ headers: {
300
+ [name: string]: unknown;
301
+ };
302
+ content: {
303
+ "application/json": {
304
+ /** @description Current page number of the result set. */
305
+ page: number;
306
+ /** @description Number of items per page. */
307
+ pageSize: number;
308
+ /** @description Total number of items available. */
309
+ totalCount: number;
310
+ /** @description OAuth consents included on this page of results. */
311
+ oauthConsents: {
312
+ /**
313
+ * Format: uuid
314
+ * @description Server-generated consent ID.
315
+ */
316
+ id: string;
317
+ /** @description OAuth client ID the consent was granted to. An identifier issued by the authorization server, not a UUID. Unique per user among live consents. */
318
+ clientId: string;
319
+ /** @description Display name the client registered, shown to the user as the connected app's name. */
320
+ clientName: string;
321
+ /**
322
+ * Format: uri
323
+ * @description Home page of the client, when it registered one. Omitted otherwise.
324
+ */
325
+ clientUri?: string;
326
+ /**
327
+ * Format: uri
328
+ * @description Logo of the client, when it registered one. Omitted otherwise.
329
+ */
330
+ logoUri?: string;
331
+ /** @description Scopes the user granted the client, as the strings the authorization server issues. A scope names one keychain, so the client's tokens are limited to the keys of those keychains (see the token scoping contract). At least one scope must map to a keychain in the server's scope map. The server refuses (`400`, nothing stored) a first consent without one (a re-consent without one revokes the consent and the client's tokens), and refuses a scope string the scope map does not know; it never drops one silently. Standard non-keychain scopes never count toward that minimum. The schema enforces only that the list is not empty; the rule is enforced by the server against the scope map. See the description of this schema. */
332
+ scopes: string[];
333
+ /**
334
+ * Format: uuid
335
+ * @description ID of the root organization the consent names. The client acts only in this organization and its descendants. A re-consent keeps it unless the user explicitly chooses another organization on the consent screen; see the description of this schema.
336
+ */
337
+ organizationId: string;
338
+ /**
339
+ * Format: date-time
340
+ * @description Time the user first granted the consent. A re-consent keeps it.
341
+ */
342
+ readonly createdAt: string;
343
+ /**
344
+ * Format: date-time
345
+ * @description Time the consent was last granted or changed. Server-set: equal to `createdAt` when the consent is created, and advanced when the same user consents to the same live client again, which replaces `scopes`.
346
+ */
347
+ readonly updatedAt: string;
348
+ /**
349
+ * Format: date-time
350
+ * @description Time the client last used a token issued under this consent. Null when the client has not used it yet or the server does not record use.
351
+ */
352
+ lastUsedAt?: string | null;
353
+ /**
354
+ * Format: date-time
355
+ * @description Time the consent was revoked (soft-deleted). Null while the consent is live. getOauthConsents returns live consents only.
356
+ */
357
+ deletedAt?: string | null;
358
+ }[];
359
+ };
360
+ };
361
+ };
362
+ /** @description Invalid request body or request param */
363
+ 400: {
364
+ headers: {
365
+ [name: string]: unknown;
366
+ };
367
+ content: {
368
+ "text/plain": string;
369
+ };
370
+ };
371
+ /** @description Expired JWT token used or insufficient privilege */
372
+ 401: {
373
+ headers: {
374
+ [name: string]: unknown;
375
+ };
376
+ content: {
377
+ "text/plain": string;
378
+ };
379
+ };
380
+ /** @description Forbidden */
381
+ 403: {
382
+ headers: {
383
+ [name: string]: unknown;
384
+ };
385
+ content: {
386
+ "text/plain": string;
387
+ };
388
+ };
389
+ /** @description Internal server error */
390
+ 500: {
391
+ headers: {
392
+ [name: string]: unknown;
393
+ };
394
+ content: {
395
+ "text/plain": string;
396
+ };
397
+ };
398
+ };
399
+ };
400
+ deleteOauthConsent: {
401
+ parameters: {
402
+ query: {
403
+ /** @description OAuth client ID of the consent to revoke. An identifier issued by the authorization server, not a UUID. */
404
+ clientId: string;
405
+ };
406
+ header?: never;
407
+ path?: never;
408
+ cookie?: never;
409
+ };
410
+ requestBody?: never;
411
+ responses: {
412
+ /** @description OAuth consent revoked */
413
+ 204: {
414
+ headers: {
415
+ [name: string]: unknown;
416
+ };
417
+ content?: never;
418
+ };
419
+ /** @description Invalid request body or request param */
420
+ 400: {
421
+ headers: {
422
+ [name: string]: unknown;
423
+ };
424
+ content: {
425
+ "text/plain": string;
426
+ };
427
+ };
428
+ /** @description Expired JWT token used or insufficient privilege */
429
+ 401: {
430
+ headers: {
431
+ [name: string]: unknown;
432
+ };
433
+ content: {
434
+ "text/plain": string;
435
+ };
436
+ };
437
+ /** @description Forbidden */
438
+ 403: {
439
+ headers: {
440
+ [name: string]: unknown;
441
+ };
442
+ content: {
443
+ "text/plain": string;
444
+ };
445
+ };
446
+ /** @description Result not found */
447
+ 404: {
448
+ headers: {
449
+ [name: string]: unknown;
450
+ };
451
+ content: {
452
+ "text/plain": string;
453
+ };
454
+ };
455
+ /** @description Internal server error */
456
+ 500: {
457
+ headers: {
458
+ [name: string]: unknown;
459
+ };
460
+ content: {
461
+ "text/plain": string;
462
+ };
463
+ };
464
+ };
465
+ };
466
+ }
@@ -0,0 +1 @@
1
+ 'use strict';
@@ -0,0 +1,2 @@
1
+ declare const OauthConsentSchema: Record<string, unknown>;
2
+ export default OauthConsentSchema;