@meshery/schemas 1.3.123 → 1.3.124
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +6 -4
- package/dist/cloudApi.d.ts +6 -4
- package/dist/constructs/v1beta3/oauth_consent_request/OauthConsentRequest.d.ts +36 -17
- package/dist/constructs/v1beta3/oauth_consent_request/OauthConsentRequestSchema.js +27 -15
- package/dist/constructs/v1beta3/oauth_consent_request/OauthConsentRequestSchema.mjs +27 -15
- package/package.json +1 -1
package/dist/cloudApi.d.mts
CHANGED
|
@@ -16450,14 +16450,16 @@ type GetOauthConsentRequestApiResponse = {
|
|
|
16450
16450
|
client: {
|
|
16451
16451
|
/** OAuth client ID. An identifier issued by the identity provider, not a UUID. */
|
|
16452
16452
|
clientId: string;
|
|
16453
|
-
/** Display name the client registered. Empty when it registered none. Self-asserted by
|
|
16453
|
+
/** Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust. */
|
|
16454
16454
|
clientName: string;
|
|
16455
|
-
/** The network hosts the client can send the user to after the decision: the host of each https redirect URI
|
|
16455
|
+
/** The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
|
|
16456
16456
|
redirectHosts: string[];
|
|
16457
|
-
/** The
|
|
16457
|
+
/** The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty. */
|
|
16458
16458
|
appSchemes: string[];
|
|
16459
|
-
/**
|
|
16459
|
+
/** Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it. */
|
|
16460
16460
|
verified: boolean;
|
|
16461
|
+
/** An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none. */
|
|
16462
|
+
logoUri?: string;
|
|
16461
16463
|
};
|
|
16462
16464
|
/** Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none. */
|
|
16463
16465
|
requestedScopes: string[];
|
package/dist/cloudApi.d.ts
CHANGED
|
@@ -16450,14 +16450,16 @@ type GetOauthConsentRequestApiResponse = {
|
|
|
16450
16450
|
client: {
|
|
16451
16451
|
/** OAuth client ID. An identifier issued by the identity provider, not a UUID. */
|
|
16452
16452
|
clientId: string;
|
|
16453
|
-
/** Display name the client registered. Empty when it registered none. Self-asserted by
|
|
16453
|
+
/** Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust. */
|
|
16454
16454
|
clientName: string;
|
|
16455
|
-
/** The network hosts the client can send the user to after the decision: the host of each https redirect URI
|
|
16455
|
+
/** The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
|
|
16456
16456
|
redirectHosts: string[];
|
|
16457
|
-
/** The
|
|
16457
|
+
/** The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty. */
|
|
16458
16458
|
appSchemes: string[];
|
|
16459
|
-
/**
|
|
16459
|
+
/** Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it. */
|
|
16460
16460
|
verified: boolean;
|
|
16461
|
+
/** An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none. */
|
|
16462
|
+
logoUri?: string;
|
|
16461
16463
|
};
|
|
16462
16464
|
/** Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none. */
|
|
16463
16465
|
requestedScopes: string[];
|
|
@@ -123,10 +123,14 @@ export interface components {
|
|
|
123
123
|
*
|
|
124
124
|
* The request belongs to the one signed-in user it was issued for. Only that
|
|
125
125
|
* user may read it or decide it, and a challenge is single use: once accepted
|
|
126
|
-
* or rejected it can no longer be read or decided. `client.verified`
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
* the
|
|
126
|
+
* or rejected it can no longer be read or decided. `client.verified` marks
|
|
127
|
+
* trust and never blocks. For a dynamically registered client it is true only
|
|
128
|
+
* when every redirect URI matches one operator-listed known-client entry; for
|
|
129
|
+
* an operator-managed client it is true when the operator set the verified
|
|
130
|
+
* mark in the client's identity-provider metadata (admin-only; a client can
|
|
131
|
+
* never set or clear it). It is never derived from a self-asserted name or
|
|
132
|
+
* from the client ID. An unverified client is shown as such, and the user may
|
|
133
|
+
* still allow it.
|
|
130
134
|
*/
|
|
131
135
|
OauthConsentRequest: {
|
|
132
136
|
/** @description Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request. */
|
|
@@ -135,30 +139,40 @@ export interface components {
|
|
|
135
139
|
client: {
|
|
136
140
|
/** @description OAuth client ID. An identifier issued by the identity provider, not a UUID. */
|
|
137
141
|
clientId: string;
|
|
138
|
-
/** @description Display name the client registered. Empty when it registered none. Self-asserted by
|
|
142
|
+
/** @description Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust. */
|
|
139
143
|
clientName: string;
|
|
140
|
-
/** @description The network hosts the client can send the user to after the decision: the host of each https redirect URI
|
|
144
|
+
/** @description The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
|
|
141
145
|
redirectHosts: string[];
|
|
142
|
-
/** @description The
|
|
146
|
+
/** @description The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty. */
|
|
143
147
|
appSchemes: string[];
|
|
144
|
-
/** @description
|
|
148
|
+
/** @description Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it. */
|
|
145
149
|
verified: boolean;
|
|
150
|
+
/**
|
|
151
|
+
* Format: uri
|
|
152
|
+
* @description An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.
|
|
153
|
+
*/
|
|
154
|
+
logoUri?: string;
|
|
146
155
|
};
|
|
147
156
|
/** @description Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none. */
|
|
148
157
|
requestedScopes: string[];
|
|
149
158
|
};
|
|
150
|
-
/** @description The OAuth client that asks for consent, as the consent page names it: its ID and registered name, where it can send the user afterwards (`redirectHosts` for
|
|
159
|
+
/** @description The OAuth client that asks for consent, as the consent page names it: its ID and registered name, where it can send the user afterwards (`redirectHosts` for http and https redirects, `appSchemes` for any other scheme), an optional `logoUri`, and the `verified` mark. The client is one of two kinds. A dynamically registered client registered itself (RFC 7591), so its name is self-asserted. An operator-managed client was created by an operator through the identity provider's admin API, never through dynamic registration; it still gets the consent page, is not first-party and is not auto-accepted, and its name and logo are operator-set. `verified` marks trust and never blocks: for a dynamically registered client it is true only when every redirect URI matches one operator-listed known-client entry; for an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata (admin-only; a client can never set or clear it). It is never derived from a self-asserted name or from the client ID, and an unverified client may still be allowed. The server classifies each registered redirect URI by its scheme into exactly one of the two lists, and at least one of them is non-empty. For a dynamically registered client the registration policy limits what can appear: https and loopback http redirects, and allowlisted private-use schemes. For an operator-managed client there is no extra constraint (the identity provider's exact-match redirect check is the only gate): an http or https redirect is listed in `redirectHosts`, any other scheme in `appSchemes`. This is display only, so the page never shows an app as a host. */
|
|
151
160
|
OauthConsentClient: {
|
|
152
161
|
/** @description OAuth client ID. An identifier issued by the identity provider, not a UUID. */
|
|
153
162
|
clientId: string;
|
|
154
|
-
/** @description Display name the client registered. Empty when it registered none. Self-asserted by
|
|
163
|
+
/** @description Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust. */
|
|
155
164
|
clientName: string;
|
|
156
|
-
/** @description The network hosts the client can send the user to after the decision: the host of each https redirect URI
|
|
165
|
+
/** @description The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
|
|
157
166
|
redirectHosts: string[];
|
|
158
|
-
/** @description The
|
|
167
|
+
/** @description The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty. */
|
|
159
168
|
appSchemes: string[];
|
|
160
|
-
/** @description
|
|
169
|
+
/** @description Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it. */
|
|
161
170
|
verified: boolean;
|
|
171
|
+
/**
|
|
172
|
+
* Format: uri
|
|
173
|
+
* @description An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.
|
|
174
|
+
*/
|
|
175
|
+
logoUri?: string;
|
|
162
176
|
};
|
|
163
177
|
/** @description Names the pending consent request to allow (acceptOauthConsentRequest) or deny (rejectOauthConsentRequest). The grant is always what the client requested, so the body carries no scopes. */
|
|
164
178
|
OauthConsentDecisionPayload: {
|
|
@@ -340,14 +354,19 @@ export interface operations {
|
|
|
340
354
|
client: {
|
|
341
355
|
/** @description OAuth client ID. An identifier issued by the identity provider, not a UUID. */
|
|
342
356
|
clientId: string;
|
|
343
|
-
/** @description Display name the client registered. Empty when it registered none. Self-asserted by
|
|
357
|
+
/** @description Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust. */
|
|
344
358
|
clientName: string;
|
|
345
|
-
/** @description The network hosts the client can send the user to after the decision: the host of each https redirect URI
|
|
359
|
+
/** @description The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
|
|
346
360
|
redirectHosts: string[];
|
|
347
|
-
/** @description The
|
|
361
|
+
/** @description The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty. */
|
|
348
362
|
appSchemes: string[];
|
|
349
|
-
/** @description
|
|
363
|
+
/** @description Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it. */
|
|
350
364
|
verified: boolean;
|
|
365
|
+
/**
|
|
366
|
+
* Format: uri
|
|
367
|
+
* @description An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.
|
|
368
|
+
*/
|
|
369
|
+
logoUri?: string;
|
|
351
370
|
};
|
|
352
371
|
/** @description Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none. */
|
|
353
372
|
requestedScopes: string[];
|
|
@@ -18,11 +18,15 @@ The rules every operation enforces:
|
|
|
18
18
|
- An accept grants only what the client requested, never more: the
|
|
19
19
|
scopes in \`requestedScopes\`, and any audience the client asked the
|
|
20
20
|
identity provider for. The decision body cannot widen or narrow it.
|
|
21
|
-
- \`client.verified\` marks trust and never blocks.
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
21
|
+
- \`client.verified\` marks trust and never blocks. For a dynamically
|
|
22
|
+
registered client it is true only when every redirect URI of the client
|
|
23
|
+
matches one operator-listed known-client entry. For an operator-managed
|
|
24
|
+
client (pre-registered by an operator through the identity provider's
|
|
25
|
+
admin API) it is true when the operator set the verified mark in the
|
|
26
|
+
client's identity-provider metadata, which only the admin API can write:
|
|
27
|
+
a client can never set or clear it. It is never derived from a
|
|
28
|
+
self-asserted name or from the client ID. An unverified client is shown
|
|
29
|
+
as unverified and the user may still allow it.
|
|
26
30
|
|
|
27
31
|
The server stores nothing of its own for a pending request: it reads the
|
|
28
32
|
request from the identity provider on every call, so a 503 means the
|
|
@@ -54,11 +58,15 @@ stores no row of its own, so the schema has no \`id\` or timestamps.
|
|
|
54
58
|
|
|
55
59
|
The request belongs to the one signed-in user it was issued for. Only that
|
|
56
60
|
user may read it or decide it, and a challenge is single use: once accepted
|
|
57
|
-
or rejected it can no longer be read or decided. \`client.verified\`
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
the
|
|
61
|
-
`,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by the client; only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each https redirect URI (for example `app.example.com`) and of each loopback redirect URI (`127.0.0.1` or `[::1]`), without duplicates. Only redirect URIs whose scheme is `https`, or `http` on a loopback IP literal, are listed here; the `localhost` hostname is never registered (RFC 8252 section 8.3), and a private-use app redirect is listed in `appSchemes` instead. Lowercase ASCII, with no scheme, port or path; an internationalized hostname is sent in IDNA A-label (punycode) form. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host: a DNS hostname of at least two labels whose last label starts with a letter, in IDNA A-label (punycode) form when internationalized, a dotted-decimal IPv4 literal, or a bracketed hexadecimal IPv6 literal. A colon appears only inside IPv6 brackets, so no entry carries a port, and a bare single-label name such as `localhost` or an app scheme (`vscode`) is not a host.",minLength:1,maxLength:253,pattern:"^(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?|(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])|\\[[0-9a-f]{0,4}(?::[0-9a-f]{0,4}){2,7}\\])$"},"x-order":3},appSchemes:{type:"array",description:"The private-use URI schemes (RFC 8252 section 7.1) of the client's app redirect URIs, without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. Registration accepts a private-use scheme only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when the client registered only https and loopback redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One private-use scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Derived only from the client's redirect targets, never from `clientName` or `clientId`: true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). Marks trust and never blocks: a false value is shown as an unverified client, and the user may still allow it.","x-order":5}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}}}}},400:{description:"Invalid request body or request param",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},404:{description:"Result not found",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},503:{description:"Service unavailable - the identity provider could not be reached or did not answer. On getOauthConsentRequest nothing was read and the call may be retried. On acceptOauthConsentRequest and rejectOauthConsentRequest the outcome is unknown: the request may already have been decided. The caller may retry; a retry that answers 404 means the challenge was already decided, and the user should restart sign-in from the client.",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}}}},"/api/identity/oauth/consent-requests/accept":{post:{"x-internal":["cloud"],tags:["oauthConsentDecisions"],summary:"Allow a pending OAuth consent request",operationId:"acceptOauthConsentRequest",description:`Allows the pending consent request named by \`consentChallenge\` in
|
|
61
|
+
or rejected it can no longer be read or decided. \`client.verified\` marks
|
|
62
|
+
trust and never blocks. For a dynamically registered client it is true only
|
|
63
|
+
when every redirect URI matches one operator-listed known-client entry; for
|
|
64
|
+
an operator-managed client it is true when the operator set the verified
|
|
65
|
+
mark in the client's identity-provider metadata (admin-only; a client can
|
|
66
|
+
never set or clear it). It is never derived from a self-asserted name or
|
|
67
|
+
from the client ID. An unverified client is shown as such, and the user may
|
|
68
|
+
still allow it.
|
|
69
|
+
`,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}}}}},400:{description:"Invalid request body or request param",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},404:{description:"Result not found",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},503:{description:"Service unavailable - the identity provider could not be reached or did not answer. On getOauthConsentRequest nothing was read and the call may be retried. On acceptOauthConsentRequest and rejectOauthConsentRequest the outcome is unknown: the request may already have been decided. The caller may retry; a retry that answers 404 means the challenge was already decided, and the user should restart sign-in from the client.",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}}}},"/api/identity/oauth/consent-requests/accept":{post:{"x-internal":["cloud"],tags:["oauthConsentDecisions"],summary:"Allow a pending OAuth consent request",operationId:"acceptOauthConsentRequest",description:`Allows the pending consent request named by \`consentChallenge\` in
|
|
62
70
|
the body, on behalf of the signed-in user. The grant holds only what
|
|
63
71
|
the client requested, never more: the \`requestedScopes\` of
|
|
64
72
|
getOauthConsentRequest, and any audience the client asked the
|
|
@@ -102,9 +110,13 @@ stores no row of its own, so the schema has no \`id\` or timestamps.
|
|
|
102
110
|
|
|
103
111
|
The request belongs to the one signed-in user it was issued for. Only that
|
|
104
112
|
user may read it or decide it, and a challenge is single use: once accepted
|
|
105
|
-
or rejected it can no longer be read or decided. \`client.verified\`
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
the
|
|
109
|
-
|
|
113
|
+
or rejected it can no longer be read or decided. \`client.verified\` marks
|
|
114
|
+
trust and never blocks. For a dynamically registered client it is true only
|
|
115
|
+
when every redirect URI matches one operator-listed known-client entry; for
|
|
116
|
+
an operator-managed client it is true when the operator set the verified
|
|
117
|
+
mark in the client's identity-provider metadata (admin-only; a client can
|
|
118
|
+
never set or clear it). It is never derived from a self-asserted name or
|
|
119
|
+
from the client ID. An unverified client is shown as such, and the user may
|
|
120
|
+
still allow it.
|
|
121
|
+
`,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}},OauthConsentClient:{type:"object",additionalProperties:false,description:"The OAuth client that asks for consent, as the consent page names it: its ID and registered name, where it can send the user afterwards (`redirectHosts` for http and https redirects, `appSchemes` for any other scheme), an optional `logoUri`, and the `verified` mark. The client is one of two kinds. A dynamically registered client registered itself (RFC 7591), so its name is self-asserted. An operator-managed client was created by an operator through the identity provider's admin API, never through dynamic registration; it still gets the consent page, is not first-party and is not auto-accepted, and its name and logo are operator-set. `verified` marks trust and never blocks: for a dynamically registered client it is true only when every redirect URI matches one operator-listed known-client entry; for an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata (admin-only; a client can never set or clear it). It is never derived from a self-asserted name or from the client ID, and an unverified client may still be allowed. The server classifies each registered redirect URI by its scheme into exactly one of the two lists, and at least one of them is non-empty. For a dynamically registered client the registration policy limits what can appear: https and loopback http redirects, and allowlisted private-use schemes. For an operator-managed client there is no extra constraint (the identity provider's exact-match redirect check is the only gate): an http or https redirect is listed in `redirectHosts`, any other scheme in `appSchemes`. This is display only, so the page never shows an app as a host.",required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},OauthConsentDecisionPayload:{type:"object",additionalProperties:false,description:"Names the pending consent request to allow (acceptOauthConsentRequest) or deny (rejectOauthConsentRequest). The grant is always what the client requested, so the body carries no scopes.",required:["consentChallenge"],properties:{consentChallenge:{type:"string",description:"The challenge of the request being decided, as getOauthConsentRequest returned it. A blank value answers 400.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},remember:{type:"boolean",description:"On accept, true asks the identity provider to remember the grant, so a later request from the same client for the same scopes is not shown again while the grant is remembered. False or omitted grants this request only. Ignored on reject.",default:false,"x-order":2}}},OauthConsentRedirect:{type:"object",additionalProperties:false,description:"Where the browser goes after a consent decision. The consent page must navigate the browser to `redirectTo`; the authorization does not finish until it does.",required:["redirectTo"],properties:{redirectTo:{type:"string",format:"uri",description:"Absolute URL the browser must navigate to next, issued by the identity provider. It continues the authorization and returns the user to the client.",maxLength:16384,"x-order":1}}}}}},t=e;
|
|
110
122
|
module.exports=t;
|
|
@@ -18,11 +18,15 @@ The rules every operation enforces:
|
|
|
18
18
|
- An accept grants only what the client requested, never more: the
|
|
19
19
|
scopes in \`requestedScopes\`, and any audience the client asked the
|
|
20
20
|
identity provider for. The decision body cannot widen or narrow it.
|
|
21
|
-
- \`client.verified\` marks trust and never blocks.
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
21
|
+
- \`client.verified\` marks trust and never blocks. For a dynamically
|
|
22
|
+
registered client it is true only when every redirect URI of the client
|
|
23
|
+
matches one operator-listed known-client entry. For an operator-managed
|
|
24
|
+
client (pre-registered by an operator through the identity provider's
|
|
25
|
+
admin API) it is true when the operator set the verified mark in the
|
|
26
|
+
client's identity-provider metadata, which only the admin API can write:
|
|
27
|
+
a client can never set or clear it. It is never derived from a
|
|
28
|
+
self-asserted name or from the client ID. An unverified client is shown
|
|
29
|
+
as unverified and the user may still allow it.
|
|
26
30
|
|
|
27
31
|
The server stores nothing of its own for a pending request: it reads the
|
|
28
32
|
request from the identity provider on every call, so a 503 means the
|
|
@@ -54,11 +58,15 @@ stores no row of its own, so the schema has no \`id\` or timestamps.
|
|
|
54
58
|
|
|
55
59
|
The request belongs to the one signed-in user it was issued for. Only that
|
|
56
60
|
user may read it or decide it, and a challenge is single use: once accepted
|
|
57
|
-
or rejected it can no longer be read or decided. \`client.verified\`
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
the
|
|
61
|
-
`,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by the client; only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each https redirect URI (for example `app.example.com`) and of each loopback redirect URI (`127.0.0.1` or `[::1]`), without duplicates. Only redirect URIs whose scheme is `https`, or `http` on a loopback IP literal, are listed here; the `localhost` hostname is never registered (RFC 8252 section 8.3), and a private-use app redirect is listed in `appSchemes` instead. Lowercase ASCII, with no scheme, port or path; an internationalized hostname is sent in IDNA A-label (punycode) form. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host: a DNS hostname of at least two labels whose last label starts with a letter, in IDNA A-label (punycode) form when internationalized, a dotted-decimal IPv4 literal, or a bracketed hexadecimal IPv6 literal. A colon appears only inside IPv6 brackets, so no entry carries a port, and a bare single-label name such as `localhost` or an app scheme (`vscode`) is not a host.",minLength:1,maxLength:253,pattern:"^(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?|(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])|\\[[0-9a-f]{0,4}(?::[0-9a-f]{0,4}){2,7}\\])$"},"x-order":3},appSchemes:{type:"array",description:"The private-use URI schemes (RFC 8252 section 7.1) of the client's app redirect URIs, without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. Registration accepts a private-use scheme only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when the client registered only https and loopback redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One private-use scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Derived only from the client's redirect targets, never from `clientName` or `clientId`: true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). Marks trust and never blocks: a false value is shown as an unverified client, and the user may still allow it.","x-order":5}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}}}}},400:{description:"Invalid request body or request param",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},404:{description:"Result not found",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},503:{description:"Service unavailable - the identity provider could not be reached or did not answer. On getOauthConsentRequest nothing was read and the call may be retried. On acceptOauthConsentRequest and rejectOauthConsentRequest the outcome is unknown: the request may already have been decided. The caller may retry; a retry that answers 404 means the challenge was already decided, and the user should restart sign-in from the client.",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}}}},"/api/identity/oauth/consent-requests/accept":{post:{"x-internal":["cloud"],tags:["oauthConsentDecisions"],summary:"Allow a pending OAuth consent request",operationId:"acceptOauthConsentRequest",description:`Allows the pending consent request named by \`consentChallenge\` in
|
|
61
|
+
or rejected it can no longer be read or decided. \`client.verified\` marks
|
|
62
|
+
trust and never blocks. For a dynamically registered client it is true only
|
|
63
|
+
when every redirect URI matches one operator-listed known-client entry; for
|
|
64
|
+
an operator-managed client it is true when the operator set the verified
|
|
65
|
+
mark in the client's identity-provider metadata (admin-only; a client can
|
|
66
|
+
never set or clear it). It is never derived from a self-asserted name or
|
|
67
|
+
from the client ID. An unverified client is shown as such, and the user may
|
|
68
|
+
still allow it.
|
|
69
|
+
`,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}}}}},400:{description:"Invalid request body or request param",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},404:{description:"Result not found",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},503:{description:"Service unavailable - the identity provider could not be reached or did not answer. On getOauthConsentRequest nothing was read and the call may be retried. On acceptOauthConsentRequest and rejectOauthConsentRequest the outcome is unknown: the request may already have been decided. The caller may retry; a retry that answers 404 means the challenge was already decided, and the user should restart sign-in from the client.",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}}}},"/api/identity/oauth/consent-requests/accept":{post:{"x-internal":["cloud"],tags:["oauthConsentDecisions"],summary:"Allow a pending OAuth consent request",operationId:"acceptOauthConsentRequest",description:`Allows the pending consent request named by \`consentChallenge\` in
|
|
62
70
|
the body, on behalf of the signed-in user. The grant holds only what
|
|
63
71
|
the client requested, never more: the \`requestedScopes\` of
|
|
64
72
|
getOauthConsentRequest, and any audience the client asked the
|
|
@@ -102,9 +110,13 @@ stores no row of its own, so the schema has no \`id\` or timestamps.
|
|
|
102
110
|
|
|
103
111
|
The request belongs to the one signed-in user it was issued for. Only that
|
|
104
112
|
user may read it or decide it, and a challenge is single use: once accepted
|
|
105
|
-
or rejected it can no longer be read or decided. \`client.verified\`
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
the
|
|
109
|
-
|
|
113
|
+
or rejected it can no longer be read or decided. \`client.verified\` marks
|
|
114
|
+
trust and never blocks. For a dynamically registered client it is true only
|
|
115
|
+
when every redirect URI matches one operator-listed known-client entry; for
|
|
116
|
+
an operator-managed client it is true when the operator set the verified
|
|
117
|
+
mark in the client's identity-provider metadata (admin-only; a client can
|
|
118
|
+
never set or clear it). It is never derived from a self-asserted name or
|
|
119
|
+
from the client ID. An unverified client is shown as such, and the user may
|
|
120
|
+
still allow it.
|
|
121
|
+
`,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}},OauthConsentClient:{type:"object",additionalProperties:false,description:"The OAuth client that asks for consent, as the consent page names it: its ID and registered name, where it can send the user afterwards (`redirectHosts` for http and https redirects, `appSchemes` for any other scheme), an optional `logoUri`, and the `verified` mark. The client is one of two kinds. A dynamically registered client registered itself (RFC 7591), so its name is self-asserted. An operator-managed client was created by an operator through the identity provider's admin API, never through dynamic registration; it still gets the consent page, is not first-party and is not auto-accepted, and its name and logo are operator-set. `verified` marks trust and never blocks: for a dynamically registered client it is true only when every redirect URI matches one operator-listed known-client entry; for an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata (admin-only; a client can never set or clear it). It is never derived from a self-asserted name or from the client ID, and an unverified client may still be allowed. The server classifies each registered redirect URI by its scheme into exactly one of the two lists, and at least one of them is non-empty. For a dynamically registered client the registration policy limits what can appear: https and loopback http redirects, and allowlisted private-use schemes. For an operator-managed client there is no extra constraint (the identity provider's exact-match redirect check is the only gate): an http or https redirect is listed in `redirectHosts`, any other scheme in `appSchemes`. This is display only, so the page never shows an app as a host.",required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},OauthConsentDecisionPayload:{type:"object",additionalProperties:false,description:"Names the pending consent request to allow (acceptOauthConsentRequest) or deny (rejectOauthConsentRequest). The grant is always what the client requested, so the body carries no scopes.",required:["consentChallenge"],properties:{consentChallenge:{type:"string",description:"The challenge of the request being decided, as getOauthConsentRequest returned it. A blank value answers 400.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},remember:{type:"boolean",description:"On accept, true asks the identity provider to remember the grant, so a later request from the same client for the same scopes is not shown again while the grant is remembered. False or omitted grants this request only. Ignored on reject.",default:false,"x-order":2}}},OauthConsentRedirect:{type:"object",additionalProperties:false,description:"Where the browser goes after a consent decision. The consent page must navigate the browser to `redirectTo`; the authorization does not finish until it does.",required:["redirectTo"],properties:{redirectTo:{type:"string",format:"uri",description:"Absolute URL the browser must navigate to next, issued by the identity provider. It continues the authorization and returns the user to the client.",maxLength:16384,"x-order":1}}}}}},t=e;
|
|
110
122
|
export{t as default};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@meshery/schemas",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.124",
|
|
4
4
|
"description": "<p style=\"text-align:center;\" align=\"center\"><a href=\"https://meshery.io\"><picture> <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-light-text-side.svg\"> <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\"> <img src=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\" alt=\"Meshery Logo\" width=\"70%\" /></picture></a><br /><br /></p> <p align=\"center\"> <a href=\"https://hub.docker.com/r/meshery/meshery\" alt=\"Docker pulls\"> <img src=\"https://img.shields.io/docker/pulls/meshery/meshery.svg\" /></a> <a href=\"https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%meshery+org%3Ameshery+org%3Aservice-mesh-performance+org%3Aservice-mesh-patterns+org%3A+label%3A%22help+wanted%22+\" alt=\"GitHub issues by-label\"> <img src=\"https://img.shields.io/github/issues/meshery/meshery/help%20wanted.svg?color=informational\" /></a> <a href=\"https://github.com/meshery/meshery/blob/master/LICENSE\" alt=\"LICENSE\"> <img src=\"https://img.shields.io/github/license/meshery/meshery?color=brightgreen\" /></a> <a href=\"https://artifacthub.io/packages/helm/meshery/meshery\" alt=\"Artifact Hub Meshery\"> <img src=\"https://img.shields.io/endpoint?color=brightgreen&label=Helm%20Chart&style=plastic&url=https%3A%2F%2Fartifacthub.io%2Fbadge%2Frepository%2Fartifact-hub\" /></a> <a href=\"https://goreportcard.com/report/github.com/meshery/meshery\" alt=\"Go Report Card\"> <img src=\"https://goreportcard.com/badge/github.com/meshery/meshery\" /></a> <a href=\"https://github.com/meshery/meshery/actions\" alt=\"Build Status\"> <img src=\"https://img.shields.io/github/actions/workflow/status/meshery/meshery/release-drafter.yml\" /></a> <a href=\"https://bestpractices.coreinfrastructure.org/projects/3564\" alt=\"CLI Best Practices\"> <img src=\"https://bestpractices.coreinfrastructure.org/projects/3564/badge\" /></a> <a href=\"http://discuss.meshery.io\" alt=\"Discuss Users\"> <img src=\"https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.meshery.io\" /></a> <a href=\"https://slack.meshery.io\" alt=\"Join Slack\"> <img src=\"https://img.shields.io/badge/Slack-@meshery.svg?logo=slack\" /></a> <a href=\"https://twitter.com/intent/follow?screen_name=mesheryio\" alt=\"Twitter Follow\"> <img src=\"https://img.shields.io/twitter/follow/mesheryio.svg?label=Follow+Meshery&style=social\" /></a> <a href=\"https://github.com/meshery/meshery/releases\" alt=\"Meshery Downloads\"> <img src=\"https://img.shields.io/github/downloads/meshery/meshery/total\" /></a> <!-- <a href=\"https://app.fossa.com/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery?ref=badge_shield\" alt=\"License Scan Report\"> <img src=\"https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery.svg?type=shield\"/></a> --> </p>",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|