@lumoauth/api-client 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -0
- package/README.md +6 -2
- package/api/aauth-api.ts +5 -5
- package/api/admin-mcp-api.ts +5 -5
- package/api/agents-api.ts +5 -5
- package/api/mcp-api.ts +130 -0
- package/api/well-known-api.ts +10 -10
- package/dist/api/aauth-api.d.ts +5 -5
- package/dist/api/aauth-api.js +4 -4
- package/dist/api/admin-mcp-api.d.ts +5 -5
- package/dist/api/admin-mcp-api.js +4 -4
- package/dist/api/agents-api.d.ts +5 -5
- package/dist/api/agents-api.js +4 -4
- package/dist/api/mcp-api.d.ts +73 -0
- package/dist/api/mcp-api.js +82 -0
- package/dist/api/well-known-api.d.ts +10 -10
- package/dist/api/well-known-api.js +8 -8
- package/dist/esm/api/aauth-api.d.ts +5 -5
- package/dist/esm/api/aauth-api.js +4 -4
- package/dist/esm/api/admin-mcp-api.d.ts +5 -5
- package/dist/esm/api/admin-mcp-api.js +4 -4
- package/dist/esm/api/agents-api.d.ts +5 -5
- package/dist/esm/api/agents-api.js +4 -4
- package/dist/esm/api/mcp-api.d.ts +73 -0
- package/dist/esm/api/mcp-api.js +83 -1
- package/dist/esm/api/well-known-api.d.ts +10 -10
- package/dist/esm/api/well-known-api.js +8 -8
- package/dist/esm/models/admin-agents-generate-token-request.d.ts +7 -1
- package/dist/esm/models/admin-agents-generate-token-response-data.d.ts +12 -0
- package/dist/esm/models/attest-response.d.ts +2 -1
- package/dist/esm/models/attest-response.js +1 -0
- package/dist/esm/models/authorize-mcp-request.d.ts +1 -1
- package/dist/esm/models/get-protected-resource-metadata-root-response1-resources-item.d.ts +1 -1
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/esm/models/mcp-server-tool-authorize-request-subject.d.ts +38 -0
- package/dist/esm/models/mcp-server-tool-authorize-request-subject.js +22 -0
- package/dist/esm/models/mcp-server-tool-authorize-request.d.ts +31 -0
- package/dist/esm/models/mcp-server-tool-authorize-request.js +14 -0
- package/dist/esm/models/mcp-server-tool-authorize-response.d.ts +36 -0
- package/dist/esm/models/mcp-server-tool-authorize-response.js +14 -0
- package/dist/esm/models/mcp-server.d.ts +18 -0
- package/dist/esm/models/open-id-configuration.d.ts +1 -1
- package/dist/esm/models/protected-resource-metadata.d.ts +1 -1
- package/dist/esm/models/single-server-metadata.d.ts +1 -1
- package/dist/models/admin-agents-generate-token-request.d.ts +7 -1
- package/dist/models/admin-agents-generate-token-response-data.d.ts +12 -0
- package/dist/models/attest-response.d.ts +2 -1
- package/dist/models/attest-response.js +1 -0
- package/dist/models/authorize-mcp-request.d.ts +1 -1
- package/dist/models/get-protected-resource-metadata-root-response1-resources-item.d.ts +1 -1
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/mcp-server-tool-authorize-request-subject.d.ts +38 -0
- package/dist/models/mcp-server-tool-authorize-request-subject.js +25 -0
- package/dist/models/mcp-server-tool-authorize-request.d.ts +31 -0
- package/dist/models/mcp-server-tool-authorize-request.js +15 -0
- package/dist/models/mcp-server-tool-authorize-response.d.ts +36 -0
- package/dist/models/mcp-server-tool-authorize-response.js +15 -0
- package/dist/models/mcp-server.d.ts +18 -0
- package/dist/models/open-id-configuration.d.ts +1 -1
- package/dist/models/protected-resource-metadata.d.ts +1 -1
- package/dist/models/single-server-metadata.d.ts +1 -1
- package/docs/AAuthApi.md +1 -1
- package/docs/AdminAgentsApi.md +1 -1
- package/docs/AdminAgentsGenerateTokenRequest.md +3 -1
- package/docs/AdminAgentsGenerateTokenResponseData.md +4 -0
- package/docs/AdminMcpApi.md +1 -1
- package/docs/AgentsApi.md +4 -3
- package/docs/AuthorizeMcpRequest.md +1 -1
- package/docs/GetProtectedResourceMetadataRoot200Response.md +1 -1
- package/docs/GetProtectedResourceMetadataRootResponse1ResourcesItem.md +1 -1
- package/docs/McpApi.md +64 -0
- package/docs/McpServer.md +6 -0
- package/docs/McpServerToolAuthorizeRequest.md +22 -0
- package/docs/McpServerToolAuthorizeRequestSubject.md +22 -0
- package/docs/McpServerToolAuthorizeResponse.md +24 -0
- package/docs/OpenIdConfiguration.md +1 -1
- package/docs/ProtectedResourceMetadata.md +1 -1
- package/docs/SingleServerMetadata.md +1 -1
- package/docs/WellKnownApi.md +2 -2
- package/models/admin-agents-generate-token-request.ts +7 -1
- package/models/admin-agents-generate-token-response-data.ts +12 -0
- package/models/attest-response.ts +2 -1
- package/models/authorize-mcp-request.ts +1 -1
- package/models/get-protected-resource-metadata-root-response1-resources-item.ts +1 -1
- package/models/index.ts +3 -0
- package/models/mcp-server-tool-authorize-request-subject.ts +46 -0
- package/models/mcp-server-tool-authorize-request.ts +39 -0
- package/models/mcp-server-tool-authorize-response.ts +42 -0
- package/models/mcp-server.ts +18 -0
- package/models/open-id-configuration.ts +1 -1
- package/models/protected-resource-metadata.ts +1 -1
- package/models/single-server-metadata.ts +1 -1
- package/package.json +1 -1
|
@@ -33,10 +33,22 @@ export interface AdminAgentsGenerateTokenResponseData {
|
|
|
33
33
|
* @memberof AdminAgentsGenerateTokenResponseData
|
|
34
34
|
*/
|
|
35
35
|
'expiresIn'?: number;
|
|
36
|
+
/**
|
|
37
|
+
* The token id. Written to the agent.token_issued audit event; the kill switch and a capability reduction deny-list it.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof AdminAgentsGenerateTokenResponseData
|
|
40
|
+
*/
|
|
41
|
+
'jti'?: string;
|
|
36
42
|
/**
|
|
37
43
|
*
|
|
38
44
|
* @type {Array<string>}
|
|
39
45
|
* @memberof AdminAgentsGenerateTokenResponseData
|
|
40
46
|
*/
|
|
41
47
|
'scopes'?: Array<string>;
|
|
48
|
+
/**
|
|
49
|
+
* The MCP server the token is bound to, when `resource` was sent.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof AdminAgentsGenerateTokenResponseData
|
|
52
|
+
*/
|
|
53
|
+
'resource'?: string | null;
|
|
42
54
|
}
|
|
@@ -21,4 +21,5 @@ exports.AttestResponseTokenType = void 0;
|
|
|
21
21
|
var AttestResponseTokenType;
|
|
22
22
|
(function (AttestResponseTokenType) {
|
|
23
23
|
AttestResponseTokenType["BEARER"] = "Bearer";
|
|
24
|
+
AttestResponseTokenType["DPO_P"] = "DPoP";
|
|
24
25
|
})(AttestResponseTokenType || (exports.AttestResponseTokenType = AttestResponseTokenType = {}));
|
|
@@ -28,7 +28,7 @@ export interface GetProtectedResourceMetadataRootResponse1ResourcesItem {
|
|
|
28
28
|
*/
|
|
29
29
|
'resource_metadata_url': string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* The organization\'s issuer identifier (RFC 8414).
|
|
32
32
|
* @type {Array<string>}
|
|
33
33
|
* @memberof GetProtectedResourceMetadataRootResponse1ResourcesItem
|
|
34
34
|
*/
|
package/dist/models/index.d.ts
CHANGED
|
@@ -288,6 +288,9 @@ export * from './mark-user-verified-response';
|
|
|
288
288
|
export * from './mcp-server';
|
|
289
289
|
export * from './mcp-server-posture';
|
|
290
290
|
export * from './mcp-server-posture-checks-inner';
|
|
291
|
+
export * from './mcp-server-tool-authorize-request';
|
|
292
|
+
export * from './mcp-server-tool-authorize-request-subject';
|
|
293
|
+
export * from './mcp-server-tool-authorize-response';
|
|
291
294
|
export * from './message-response';
|
|
292
295
|
export * from './mfa-authenticator';
|
|
293
296
|
export * from './mfa-authenticator-last-used-context';
|
package/dist/models/index.js
CHANGED
|
@@ -304,6 +304,9 @@ __exportStar(require("./mark-user-verified-response"), exports);
|
|
|
304
304
|
__exportStar(require("./mcp-server"), exports);
|
|
305
305
|
__exportStar(require("./mcp-server-posture"), exports);
|
|
306
306
|
__exportStar(require("./mcp-server-posture-checks-inner"), exports);
|
|
307
|
+
__exportStar(require("./mcp-server-tool-authorize-request"), exports);
|
|
308
|
+
__exportStar(require("./mcp-server-tool-authorize-request-subject"), exports);
|
|
309
|
+
__exportStar(require("./mcp-server-tool-authorize-response"), exports);
|
|
307
310
|
__exportStar(require("./message-response"), exports);
|
|
308
311
|
__exportStar(require("./mfa-authenticator"), exports);
|
|
309
312
|
__exportStar(require("./mfa-authenticator-last-used-context"), exports);
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LumoAuth API
|
|
3
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: sdk@lumoauth.dev
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface McpServerToolAuthorizeRequestSubject
|
|
16
|
+
*/
|
|
17
|
+
export interface McpServerToolAuthorizeRequestSubject {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof McpServerToolAuthorizeRequestSubject
|
|
22
|
+
*/
|
|
23
|
+
'type': McpServerToolAuthorizeRequestSubjectType;
|
|
24
|
+
/**
|
|
25
|
+
* User UUID, or agent id (agt_…). For an MCP token, the user id is `sub`; for an agent token `sub` is `agent_<id>`.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof McpServerToolAuthorizeRequestSubject
|
|
28
|
+
*/
|
|
29
|
+
'id': string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @export
|
|
33
|
+
* @enum {string}
|
|
34
|
+
*/
|
|
35
|
+
export declare enum McpServerToolAuthorizeRequestSubjectType {
|
|
36
|
+
USER = "user",
|
|
37
|
+
AGENT = "agent"
|
|
38
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LumoAuth API
|
|
6
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: sdk@lumoauth.dev
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.McpServerToolAuthorizeRequestSubjectType = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* @export
|
|
19
|
+
* @enum {string}
|
|
20
|
+
*/
|
|
21
|
+
var McpServerToolAuthorizeRequestSubjectType;
|
|
22
|
+
(function (McpServerToolAuthorizeRequestSubjectType) {
|
|
23
|
+
McpServerToolAuthorizeRequestSubjectType["USER"] = "user";
|
|
24
|
+
McpServerToolAuthorizeRequestSubjectType["AGENT"] = "agent";
|
|
25
|
+
})(McpServerToolAuthorizeRequestSubjectType || (exports.McpServerToolAuthorizeRequestSubjectType = McpServerToolAuthorizeRequestSubjectType = {}));
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LumoAuth API
|
|
3
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: sdk@lumoauth.dev
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { McpServerToolAuthorizeRequestSubject } from './mcp-server-tool-authorize-request-subject';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface McpServerToolAuthorizeRequest
|
|
17
|
+
*/
|
|
18
|
+
export interface McpServerToolAuthorizeRequest {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {McpServerToolAuthorizeRequestSubject}
|
|
22
|
+
* @memberof McpServerToolAuthorizeRequest
|
|
23
|
+
*/
|
|
24
|
+
'subject': McpServerToolAuthorizeRequestSubject;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof McpServerToolAuthorizeRequest
|
|
29
|
+
*/
|
|
30
|
+
'tool': string;
|
|
31
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LumoAuth API
|
|
6
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: sdk@lumoauth.dev
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LumoAuth API
|
|
3
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: sdk@lumoauth.dev
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface McpServerToolAuthorizeResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface McpServerToolAuthorizeResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof McpServerToolAuthorizeResponse
|
|
22
|
+
*/
|
|
23
|
+
'allowed'?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {object}
|
|
27
|
+
* @memberof McpServerToolAuthorizeResponse
|
|
28
|
+
*/
|
|
29
|
+
'subject'?: object;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {object}
|
|
33
|
+
* @memberof McpServerToolAuthorizeResponse
|
|
34
|
+
*/
|
|
35
|
+
'resource'?: object;
|
|
36
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LumoAuth API
|
|
6
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: sdk@lumoauth.dev
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -58,6 +58,12 @@ export interface McpServer {
|
|
|
58
58
|
* @memberof McpServer
|
|
59
59
|
*/
|
|
60
60
|
'transport'?: string;
|
|
61
|
+
/**
|
|
62
|
+
* True for http_sse, deprecated in MCP 2026-07-28; migrate to http_streamable.
|
|
63
|
+
* @type {boolean}
|
|
64
|
+
* @memberof McpServer
|
|
65
|
+
*/
|
|
66
|
+
'transport_deprecated'?: boolean;
|
|
61
67
|
/**
|
|
62
68
|
*
|
|
63
69
|
* @type {string}
|
|
@@ -84,12 +90,24 @@ export interface McpServer {
|
|
|
84
90
|
'scope_descriptions'?: {
|
|
85
91
|
[key: string]: string;
|
|
86
92
|
};
|
|
93
|
+
/**
|
|
94
|
+
* Subset of scopes_supported advertised in the 401 challenge and in protected resource metadata. Empty = the whole vocabulary.
|
|
95
|
+
* @type {Array<string>}
|
|
96
|
+
* @memberof McpServer
|
|
97
|
+
*/
|
|
98
|
+
'basic_scopes'?: Array<string>;
|
|
87
99
|
/**
|
|
88
100
|
*
|
|
89
101
|
* @type {Array<string>}
|
|
90
102
|
* @memberof McpServer
|
|
91
103
|
*/
|
|
92
104
|
'allowed_client_ids'?: Array<string>;
|
|
105
|
+
/**
|
|
106
|
+
* The MCP server\'s own OAuth clients allowed to call the per-tool authorization endpoint.
|
|
107
|
+
* @type {Array<string>}
|
|
108
|
+
* @memberof McpServer
|
|
109
|
+
*/
|
|
110
|
+
'tool_authorizer_client_ids'?: Array<string>;
|
|
93
111
|
/**
|
|
94
112
|
*
|
|
95
113
|
* @type {boolean}
|
|
@@ -166,7 +166,7 @@ export interface OpenIdConfiguration {
|
|
|
166
166
|
*/
|
|
167
167
|
'ui_locales_supported'?: Array<string>;
|
|
168
168
|
/**
|
|
169
|
-
* The four MFA tier ACR values, unless overridden in organization settings.
|
|
169
|
+
* The four MFA tier ACR values plus the single-factor urn:lumoauth:acr:pwd (any signed-in session), unless overridden in organization settings.
|
|
170
170
|
* @type {Array<string>}
|
|
171
171
|
* @memberof OpenIdConfiguration
|
|
172
172
|
*/
|
|
@@ -23,7 +23,7 @@ export interface ProtectedResourceMetadata {
|
|
|
23
23
|
*/
|
|
24
24
|
'resource': string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* The organization\'s issuer identifier (RFC 8414), the same value as `issuer` in its discovery documents. Clients read the authorization server metadata from {issuer}/.well-known/openid-configuration.
|
|
27
27
|
* @type {Array<string>}
|
|
28
28
|
* @memberof ProtectedResourceMetadata
|
|
29
29
|
*/
|
package/docs/AAuthApi.md
CHANGED
|
@@ -492,7 +492,7 @@ No authorization required
|
|
|
492
492
|
# **issueAgentToken**
|
|
493
493
|
> IssueAgentTokenResponse issueAgentToken(issueAgentTokenRequest)
|
|
494
494
|
|
|
495
|
-
Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @
|
|
495
|
+
Per Section 9: The agent token endpoint is the auth server\'s endpoint agents use to request auth tokens. Required HTTP signature covering: @method, @authority, @path, signature-key (plus @query when the URL has one), content-digest, content-type, authorization
|
|
496
496
|
|
|
497
497
|
### Example
|
|
498
498
|
|
package/docs/AdminAgentsApi.md
CHANGED
|
@@ -469,7 +469,7 @@ const { status, data } = await apiInstance.adminAgentsGenerateToken(
|
|
|
469
469
|
| Status code | Description | Response headers |
|
|
470
470
|
|-------------|-------------|------------------|
|
|
471
471
|
|**200** | A generated agent token. The token value is returned ONCE. | - |
|
|
472
|
-
|**400** | Inactive agent,
|
|
472
|
+
|**400** | Inactive agent, requested scopes outside the agent\'s capabilities, a resource that is not an active MCP server of this organization, or expiresIn above 3600 without a resource. | - |
|
|
473
473
|
|**401** | Authentication required. | - |
|
|
474
474
|
|**403** | Admin privileges required. | - |
|
|
475
475
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**expiresIn** | **number** | Token lifetime in seconds. Default 3600, at most
|
|
8
|
+
**expiresIn** | **number** | Token lifetime in seconds. Default 3600, minimum 60, at most 86400 (24 hours). Above 3600 only together with `resource`: a long-lived token is always bound to one MCP server, never to the organization API. | [optional] [default to undefined]
|
|
9
9
|
**scopes** | **Array<string>** | Optional subset of the agent\'s capabilities to carry in the token. Omit for all of them; a scope the agent does not have is rejected with 400. | [optional] [default to undefined]
|
|
10
|
+
**resource** | **string** | Optional resource URI of an active MCP server of this organization. The token is then audience-bound to that server (and no longer works on the LumoAuth API) and lives at most the server\'s token lifetime. Servers that require DPoP are refused with 400. | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { AdminAgentsGenerateTokenRequest } from '@lumoauth/api-client';
|
|
|
16
17
|
const instance: AdminAgentsGenerateTokenRequest = {
|
|
17
18
|
expiresIn,
|
|
18
19
|
scopes,
|
|
20
|
+
resource,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
|
@@ -8,7 +8,9 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**accessToken** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**tokenType** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**expiresIn** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**jti** | **string** | The token id. Written to the agent.token_issued audit event; the kill switch and a capability reduction deny-list it. | [optional] [default to undefined]
|
|
11
12
|
**scopes** | **Array<string>** | | [optional] [default to undefined]
|
|
13
|
+
**resource** | **string** | The MCP server the token is bound to, when `resource` was sent. | [optional] [default to undefined]
|
|
12
14
|
|
|
13
15
|
## Example
|
|
14
16
|
|
|
@@ -19,7 +21,9 @@ const instance: AdminAgentsGenerateTokenResponseData = {
|
|
|
19
21
|
accessToken,
|
|
20
22
|
tokenType,
|
|
21
23
|
expiresIn,
|
|
24
|
+
jti,
|
|
22
25
|
scopes,
|
|
26
|
+
resource,
|
|
23
27
|
};
|
|
24
28
|
```
|
|
25
29
|
|
package/docs/AdminMcpApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
12
|
# **adminMcpServersCreate**
|
|
13
13
|
> AdminMcpServersCreateResponse adminMcpServersCreate()
|
|
14
14
|
|
|
15
|
-
Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI
|
|
15
|
+
Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
package/docs/AgentsApi.md
CHANGED
|
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.attest(
|
|
|
125
125
|
### HTTP response details
|
|
126
126
|
| Status code | Description | Response headers |
|
|
127
127
|
|-------------|-------------|------------------|
|
|
128
|
-
|**200** | Attestation accepted: a short-lived (15 minute) LumoAuth access token scoped to the agent\'s capabilities. | - |
|
|
128
|
+
|**200** | Attestation accepted: a short-lived (15 minute) LumoAuth access token scoped to the agent\'s capabilities, or to the subset named by the optional `scope` field of the request body. Sent with a `DPoP` header, the token is DPoP-bound (token_type DPoP, cnf.jkt). | - |
|
|
129
129
|
|**400** | invalid_json or missing_attestation_token. | - |
|
|
130
130
|
|**401** | attestation_rejected — generic for unknown agent, inactive agent / organization, or a token that failed verification. | - |
|
|
131
131
|
|**403** | access_policy_denied — a conditional access policy refused the agent (reason code included). | - |
|
|
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.attest(
|
|
|
137
137
|
# **authorizeMcp**
|
|
138
138
|
> AuthorizeMcpResponse authorizeMcp(authorizeMcpRequest)
|
|
139
139
|
|
|
140
|
-
|
|
140
|
+
An AGENT asks about itself: \"may I invoke <server>/<tool>?\" — with its own credential, before it calls the tool. Zanzibar-backed allow/deny (tool-level or server-wide grant), audited either way. An MCP SERVER must not use this endpoint: it would have to forward the agent\'s token (MCP 2026-07-28 forbids token passthrough). Servers call POST /orgs/{orgId}/api/v1/mcp/servers/{serverId}/tools/authorize with their own client-credentials token instead ({@see \\McpAuthorizationController::authorizeTool()}). POST /orgs/{orgId}/api/v1/agents/me/mcp/authorize Body: { \"server_id\": \"mcp_0123…\", \"tool\": \"send_payment_reminder\" }
|
|
141
141
|
|
|
142
142
|
### Example
|
|
143
143
|
|
|
@@ -187,7 +187,8 @@ const { status, data } = await apiInstance.authorizeMcp(
|
|
|
187
187
|
|-------------|-------------|------------------|
|
|
188
188
|
|**200** | Allowed — the agent may invoke the tool. | - |
|
|
189
189
|
|**403** | Denied — no matching per-tool or server-wide grant. | - |
|
|
190
|
-
|**400** | server_id and tool are required, or contain forbidden characters. | - |
|
|
190
|
+
|**400** | server_id and tool are required, or contain forbidden characters, or are too long together. | - |
|
|
191
|
+
|**404** | unknown_server — server_id is not an active MCP server of this organization. | - |
|
|
191
192
|
|
|
192
193
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
193
194
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**server_id** | **string** |
|
|
8
|
+
**server_id** | **string** | Id of an active MCP server registered in this organization. | [optional] [default to undefined]
|
|
9
9
|
**tool** | **string** | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**resource** | **string** | | [default to undefined]
|
|
9
|
-
**authorization_servers** | **Array<string>** |
|
|
9
|
+
**authorization_servers** | **Array<string>** | The organization\'s issuer identifier (RFC 8414). | [default to undefined]
|
|
10
10
|
**bearer_methods_supported** | **Array<string>** | | [default to undefined]
|
|
11
11
|
**scopes_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
12
12
|
**dpop_bound_access_tokens_required** | **boolean** | | [optional] [default to undefined]
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**resource** | **string** | | [default to undefined]
|
|
9
9
|
**resource_metadata_url** | **string** | Per-server protected resource metadata URL. | [default to undefined]
|
|
10
|
-
**authorization_servers** | **Array<string>** |
|
|
10
|
+
**authorization_servers** | **Array<string>** | The organization\'s issuer identifier (RFC 8414). | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/McpApi.md
CHANGED
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
9
9
|
|[**getServer**](#getserver) | **GET** /orgs/{orgId}/api/v1/mcp/servers/{serverId} | REST API: Get a specific MCP server.|
|
|
10
10
|
|[**getServerChallenge**](#getserverchallenge) | **GET** /orgs/{orgId}/api/v1/mcp/{serverId}/challenge | Simulated MCP server authorization challenge|
|
|
11
11
|
|[**listServers**](#listservers) | **GET** /orgs/{orgId}/api/v1/mcp/servers | REST API: List MCP servers for a tenant.|
|
|
12
|
+
|[**mcpServerToolAuthorize**](#mcpservertoolauthorize) | **POST** /orgs/{orgId}/api/v1/mcp/servers/{serverId}/tools/authorize | Per-tool authorization for an MCP server (server credential)|
|
|
12
13
|
|[**postServerChallenge**](#postserverchallenge) | **POST** /orgs/{orgId}/api/v1/mcp/{serverId}/challenge | Simulated MCP server authorization challenge (POST)|
|
|
13
14
|
|
|
14
15
|
# **getProtectedResourceMetadata**
|
|
@@ -286,6 +287,69 @@ const { status, data } = await apiInstance.listServers(
|
|
|
286
287
|
|
|
287
288
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
288
289
|
|
|
290
|
+
# **mcpServerToolAuthorize**
|
|
291
|
+
> McpServerToolAuthorizeResponse mcpServerToolAuthorize(mcpServerToolAuthorizeRequest)
|
|
292
|
+
|
|
293
|
+
Called by the MCP server with its own client-credentials access token (scope mcp:authorize; the client must be listed in the server\'s tool_authorizer_client_ids). The body names the caller the server already verified. The server never forwards the caller\'s token.
|
|
294
|
+
|
|
295
|
+
### Example
|
|
296
|
+
|
|
297
|
+
```typescript
|
|
298
|
+
import {
|
|
299
|
+
McpApi,
|
|
300
|
+
Configuration,
|
|
301
|
+
McpServerToolAuthorizeRequest
|
|
302
|
+
} from '@lumoauth/api-client';
|
|
303
|
+
|
|
304
|
+
const configuration = new Configuration();
|
|
305
|
+
const apiInstance = new McpApi(configuration);
|
|
306
|
+
|
|
307
|
+
let orgId: string; // (default to undefined)
|
|
308
|
+
let serverId: string; // (default to undefined)
|
|
309
|
+
let mcpServerToolAuthorizeRequest: McpServerToolAuthorizeRequest; //
|
|
310
|
+
|
|
311
|
+
const { status, data } = await apiInstance.mcpServerToolAuthorize(
|
|
312
|
+
orgId,
|
|
313
|
+
serverId,
|
|
314
|
+
mcpServerToolAuthorizeRequest
|
|
315
|
+
);
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### Parameters
|
|
319
|
+
|
|
320
|
+
|Name | Type | Description | Notes|
|
|
321
|
+
|------------- | ------------- | ------------- | -------------|
|
|
322
|
+
| **mcpServerToolAuthorizeRequest** | **McpServerToolAuthorizeRequest**| | |
|
|
323
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
324
|
+
| **serverId** | [**string**] | | defaults to undefined|
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
### Return type
|
|
328
|
+
|
|
329
|
+
**McpServerToolAuthorizeResponse**
|
|
330
|
+
|
|
331
|
+
### Authorization
|
|
332
|
+
|
|
333
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
334
|
+
|
|
335
|
+
### HTTP request headers
|
|
336
|
+
|
|
337
|
+
- **Content-Type**: application/json
|
|
338
|
+
- **Accept**: application/json
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
### HTTP response details
|
|
342
|
+
| Status code | Description | Response headers |
|
|
343
|
+
|-------------|-------------|------------------|
|
|
344
|
+
|**200** | Allowed. | - |
|
|
345
|
+
|**400** | invalid_request — malformed subject or tool. | - |
|
|
346
|
+
|**401** | invalid_token — no valid client-credentials token of this organization. | - |
|
|
347
|
+
|**403** | Denied (allowed=false), or insufficient_scope / not an authorizer client of this server. | - |
|
|
348
|
+
|**404** | not_found — unknown organization, or unknown / inactive MCP server. | - |
|
|
349
|
+
|**429** | too_many_requests (Retry-After header). | - |
|
|
350
|
+
|
|
351
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
352
|
+
|
|
289
353
|
# **postServerChallenge**
|
|
290
354
|
> GetServerChallengeResponse postServerChallenge()
|
|
291
355
|
|
package/docs/McpServer.md
CHANGED
|
@@ -12,11 +12,14 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**resource_uri** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**endpoint_url** | **string** | | [optional] [default to undefined]
|
|
14
14
|
**transport** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**transport_deprecated** | **boolean** | True for http_sse, deprecated in MCP 2026-07-28; migrate to http_streamable. | [optional] [default to undefined]
|
|
15
16
|
**auth_mode** | **string** | | [optional] [default to undefined]
|
|
16
17
|
**status** | **string** | | [optional] [default to undefined]
|
|
17
18
|
**scopes_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
18
19
|
**scope_descriptions** | **{ [key: string]: string; }** | | [optional] [default to undefined]
|
|
20
|
+
**basic_scopes** | **Array<string>** | Subset of scopes_supported advertised in the 401 challenge and in protected resource metadata. Empty = the whole vocabulary. | [optional] [default to undefined]
|
|
19
21
|
**allowed_client_ids** | **Array<string>** | | [optional] [default to undefined]
|
|
22
|
+
**tool_authorizer_client_ids** | **Array<string>** | The MCP server\'s own OAuth clients allowed to call the per-tool authorization endpoint. | [optional] [default to undefined]
|
|
20
23
|
**require_pkce** | **boolean** | | [optional] [default to undefined]
|
|
21
24
|
**require_resource_param** | **boolean** | | [optional] [default to undefined]
|
|
22
25
|
**require_dpop** | **boolean** | | [optional] [default to undefined]
|
|
@@ -38,11 +41,14 @@ const instance: McpServer = {
|
|
|
38
41
|
resource_uri,
|
|
39
42
|
endpoint_url,
|
|
40
43
|
transport,
|
|
44
|
+
transport_deprecated,
|
|
41
45
|
auth_mode,
|
|
42
46
|
status,
|
|
43
47
|
scopes_supported,
|
|
44
48
|
scope_descriptions,
|
|
49
|
+
basic_scopes,
|
|
45
50
|
allowed_client_ids,
|
|
51
|
+
tool_authorizer_client_ids,
|
|
46
52
|
require_pkce,
|
|
47
53
|
require_resource_param,
|
|
48
54
|
require_dpop,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# McpServerToolAuthorizeRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**subject** | [**McpServerToolAuthorizeRequestSubject**](McpServerToolAuthorizeRequestSubject.md) | | [default to undefined]
|
|
9
|
+
**tool** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { McpServerToolAuthorizeRequest } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: McpServerToolAuthorizeRequest = {
|
|
17
|
+
subject,
|
|
18
|
+
tool,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# McpServerToolAuthorizeRequestSubject
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | | [default to undefined]
|
|
9
|
+
**id** | **string** | User UUID, or agent id (agt_…). For an MCP token, the user id is `sub`; for an agent token `sub` is `agent_<id>`. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { McpServerToolAuthorizeRequestSubject } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: McpServerToolAuthorizeRequestSubject = {
|
|
17
|
+
type,
|
|
18
|
+
id,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# McpServerToolAuthorizeResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**allowed** | **boolean** | | [optional] [default to undefined]
|
|
9
|
+
**subject** | **object** | | [optional] [default to undefined]
|
|
10
|
+
**resource** | **object** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { McpServerToolAuthorizeResponse } from '@lumoauth/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: McpServerToolAuthorizeResponse = {
|
|
18
|
+
allowed,
|
|
19
|
+
subject,
|
|
20
|
+
resource,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
|
|
|
30
30
|
**require_signed_request_object** | **boolean** | | [optional] [default to undefined]
|
|
31
31
|
**request_object_signing_alg_values_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
32
32
|
**ui_locales_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
33
|
-
**acr_values_supported** | **Array<string>** | The four MFA tier ACR values, unless overridden in organization settings. | [optional] [default to undefined]
|
|
33
|
+
**acr_values_supported** | **Array<string>** | The four MFA tier ACR values plus the single-factor urn:lumoauth:acr:pwd (any signed-in session), unless overridden in organization settings. | [optional] [default to undefined]
|
|
34
34
|
**code_challenge_methods_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
35
35
|
**authorization_response_iss_parameter_supported** | **boolean** | | [optional] [default to undefined]
|
|
36
36
|
**pushed_authorization_request_endpoint** | **string** | | [optional] [default to undefined]
|