@lumoauth/api-client 1.3.0 → 1.5.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 +22 -0
- package/README.md +19 -5
- package/api/admin-agents-api.ts +166 -10
- package/api/admin-mcp-api.ts +5 -5
- package/api/admin-oauth-clients-api.ts +5 -5
- package/api/admin-sandbox-api.ts +5 -5
- package/api/admin-users-api.ts +27 -26
- package/api/admin-webhooks-api.ts +25 -25
- package/api/agents-api.ts +118 -0
- package/api/oauth-api.ts +111 -0
- package/dist/api/admin-agents-api.d.ts +94 -4
- package/dist/api/admin-agents-api.js +100 -10
- package/dist/api/admin-mcp-api.d.ts +5 -5
- package/dist/api/admin-mcp-api.js +4 -4
- package/dist/api/admin-oauth-clients-api.d.ts +5 -5
- package/dist/api/admin-oauth-clients-api.js +4 -4
- package/dist/api/admin-sandbox-api.d.ts +5 -5
- package/dist/api/admin-sandbox-api.js +4 -4
- package/dist/api/admin-users-api.d.ts +27 -26
- package/dist/api/admin-users-api.js +21 -20
- package/dist/api/admin-webhooks-api.d.ts +25 -25
- package/dist/api/admin-webhooks-api.js +20 -20
- package/dist/api/agents-api.d.ts +65 -0
- package/dist/api/agents-api.js +77 -0
- package/dist/api/oauth-api.d.ts +65 -0
- package/dist/api/oauth-api.js +72 -0
- package/dist/esm/api/admin-agents-api.d.ts +94 -4
- package/dist/esm/api/admin-agents-api.js +100 -10
- 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/admin-oauth-clients-api.d.ts +5 -5
- package/dist/esm/api/admin-oauth-clients-api.js +4 -4
- package/dist/esm/api/admin-sandbox-api.d.ts +5 -5
- package/dist/esm/api/admin-sandbox-api.js +4 -4
- package/dist/esm/api/admin-users-api.d.ts +27 -26
- package/dist/esm/api/admin-users-api.js +21 -20
- package/dist/esm/api/admin-webhooks-api.d.ts +25 -25
- package/dist/esm/api/admin-webhooks-api.js +20 -20
- package/dist/esm/api/agents-api.d.ts +65 -0
- package/dist/esm/api/agents-api.js +77 -0
- package/dist/esm/api/oauth-api.d.ts +65 -0
- package/dist/esm/api/oauth-api.js +73 -1
- package/dist/esm/models/abac-attribute-definition.d.ts +1 -1
- package/dist/esm/models/abac-resource-attribute.d.ts +1 -1
- package/dist/esm/models/admin-agents-agents-rotate-key-request.d.ts +30 -0
- package/dist/esm/models/admin-agents-agents-rotate-key-request.js +14 -0
- package/dist/esm/models/admin-agents-agents-rotate-key-response.d.ts +6 -0
- package/dist/esm/models/admin-agents-create-request.d.ts +8 -0
- package/dist/esm/models/admin-agents-report-usage-request.d.ts +30 -0
- package/dist/esm/models/admin-agents-report-usage-request.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response-data-recorded.d.ts +30 -0
- package/dist/esm/models/admin-agents-report-usage-response-data-recorded.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response-data.d.ts +33 -0
- package/dist/esm/models/admin-agents-report-usage-response-data.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response.d.ts +25 -0
- package/dist/esm/models/admin-agents-report-usage-response.js +14 -0
- package/dist/esm/models/admin-audit-logs-retention-response-data.d.ts +21 -3
- package/dist/esm/models/admin-identities-link-request.d.ts +8 -1
- package/dist/esm/models/admin-identities-link-request.js +1 -0
- package/dist/esm/models/admin-identities-list-response-data-bindings-item.d.ts +7 -0
- package/dist/esm/models/admin-identities-list-response-data-bindings-item.js +1 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data.d.ts +18 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data.js +14 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data1.d.ts +24 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data1.js +14 -0
- package/dist/esm/models/admin-sandbox-spawn-response.d.ts +3 -3
- package/dist/esm/models/admin-webhooks-delivery-replay-response-data.d.ts +48 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response-data.js +14 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response.d.ts +3 -3
- package/dist/esm/models/admin-webhooks-test-response.d.ts +6 -0
- package/dist/esm/models/attest-response-identity.d.ts +1 -1
- package/dist/esm/models/audit-log-entry.d.ts +1 -1
- package/dist/esm/models/authentication-settings-password-policy.d.ts +25 -1
- package/dist/esm/models/authentication-settings-password-rotation-policy.d.ts +1 -13
- package/dist/esm/models/authentication-settings.d.ts +13 -15
- package/dist/esm/models/authentication-settings.js +11 -0
- package/dist/esm/models/get-approval-status-response-approved-by.d.ts +2 -2
- package/dist/esm/models/index.d.ts +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/esm/models/list-permissions-response-permissions-item.d.ts +1 -1
- package/dist/esm/models/oauth-client-secret-issued.d.ts +1 -1
- package/dist/esm/models/oauth-client.d.ts +6 -0
- package/dist/esm/models/push-enrollment-started.d.ts +1 -1
- package/dist/esm/models/put-admin-agents-update-request.d.ts +8 -0
- package/dist/esm/models/report-agent-usage-response.d.ts +33 -0
- package/dist/esm/models/report-agent-usage-response.js +14 -0
- package/dist/esm/models/request-magic-link-request.d.ts +42 -0
- package/dist/esm/models/request-magic-link-request.js +14 -0
- package/dist/esm/models/request-magic-link-response.d.ts +31 -0
- package/dist/esm/models/request-magic-link-response.js +21 -0
- package/dist/esm/models/scim-settings-inbound-protected-attributes.d.ts +2 -9
- package/dist/esm/models/scim-settings-inbound.d.ts +0 -8
- package/dist/esm/models/scim-settings-outbound.d.ts +2 -10
- package/dist/esm/models/set-user-attribute-response-data.d.ts +1 -1
- package/dist/esm/models/userinfo-response.d.ts +8 -0
- package/dist/models/abac-attribute-definition.d.ts +1 -1
- package/dist/models/abac-resource-attribute.d.ts +1 -1
- package/dist/models/admin-agents-agents-rotate-key-request.d.ts +30 -0
- package/dist/models/admin-agents-agents-rotate-key-request.js +15 -0
- package/dist/models/admin-agents-agents-rotate-key-response.d.ts +6 -0
- package/dist/models/admin-agents-create-request.d.ts +8 -0
- package/dist/models/admin-agents-report-usage-request.d.ts +30 -0
- package/dist/models/admin-agents-report-usage-request.js +15 -0
- package/dist/models/admin-agents-report-usage-response-data-recorded.d.ts +30 -0
- package/dist/models/admin-agents-report-usage-response-data-recorded.js +15 -0
- package/dist/models/admin-agents-report-usage-response-data.d.ts +33 -0
- package/dist/models/admin-agents-report-usage-response-data.js +15 -0
- package/dist/models/admin-agents-report-usage-response.d.ts +25 -0
- package/dist/models/admin-agents-report-usage-response.js +15 -0
- package/dist/models/admin-audit-logs-retention-response-data.d.ts +21 -3
- package/dist/models/admin-identities-link-request.d.ts +8 -1
- package/dist/models/admin-identities-link-request.js +1 -0
- package/dist/models/admin-identities-list-response-data-bindings-item.d.ts +7 -0
- package/dist/models/admin-identities-list-response-data-bindings-item.js +1 -0
- package/dist/models/admin-sandbox-spawn-response-data.d.ts +18 -0
- package/dist/models/admin-sandbox-spawn-response-data.js +15 -0
- package/dist/models/admin-sandbox-spawn-response-data1.d.ts +24 -0
- package/dist/models/admin-sandbox-spawn-response-data1.js +15 -0
- package/dist/models/admin-sandbox-spawn-response.d.ts +3 -3
- package/dist/models/admin-webhooks-delivery-replay-response-data.d.ts +48 -0
- package/dist/models/admin-webhooks-delivery-replay-response-data.js +15 -0
- package/dist/models/admin-webhooks-delivery-replay-response.d.ts +3 -3
- package/dist/models/admin-webhooks-test-response.d.ts +6 -0
- package/dist/models/attest-response-identity.d.ts +1 -1
- package/dist/models/audit-log-entry.d.ts +1 -1
- package/dist/models/authentication-settings-password-policy.d.ts +25 -1
- package/dist/models/authentication-settings-password-rotation-policy.d.ts +1 -13
- package/dist/models/authentication-settings.d.ts +13 -15
- package/dist/models/authentication-settings.js +12 -1
- package/dist/models/get-approval-status-response-approved-by.d.ts +2 -2
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/models/list-permissions-response-permissions-item.d.ts +1 -1
- package/dist/models/oauth-client-secret-issued.d.ts +1 -1
- package/dist/models/oauth-client.d.ts +6 -0
- package/dist/models/push-enrollment-started.d.ts +1 -1
- package/dist/models/put-admin-agents-update-request.d.ts +8 -0
- package/dist/models/report-agent-usage-response.d.ts +33 -0
- package/dist/models/report-agent-usage-response.js +15 -0
- package/dist/models/request-magic-link-request.d.ts +42 -0
- package/dist/models/request-magic-link-request.js +15 -0
- package/dist/models/request-magic-link-response.d.ts +31 -0
- package/dist/models/request-magic-link-response.js +24 -0
- package/dist/models/scim-settings-inbound-protected-attributes.d.ts +2 -9
- package/dist/models/scim-settings-inbound.d.ts +0 -8
- package/dist/models/scim-settings-outbound.d.ts +2 -10
- package/dist/models/set-user-attribute-response-data.d.ts +1 -1
- package/dist/models/userinfo-response.d.ts +8 -0
- package/docs/AAuthApi.md +1 -1
- package/docs/AdminAbacApi.md +1 -1
- package/docs/AdminAgentsAgentsRotateKeyRequest.md +22 -0
- package/docs/AdminAgentsAgentsRotateKeyResponse.md +2 -0
- package/docs/AdminAgentsApi.md +83 -8
- package/docs/AdminAgentsCreateRequest.md +2 -0
- package/docs/AdminAgentsReportUsageRequest.md +22 -0
- package/docs/AdminAgentsReportUsageResponse.md +20 -0
- package/docs/AdminAgentsReportUsageResponseData.md +22 -0
- package/docs/AdminAgentsReportUsageResponseDataRecorded.md +22 -0
- package/docs/AdminAuditLogsRetentionResponseData.md +9 -3
- package/docs/AdminIdentitiesLinkRequest.md +3 -1
- package/docs/AdminIdentitiesListResponseDataBindingsItem.md +2 -0
- package/docs/AdminMcpApi.md +2 -1
- package/docs/AdminOAuthClientsApi.md +2 -2
- package/docs/AdminSandboxApi.md +3 -1
- package/docs/AdminSandboxSpawnResponse.md +1 -1
- package/docs/AdminSandboxSpawnResponseData.md +32 -0
- package/docs/AdminSandboxSpawnResponseData1.md +20 -0
- package/docs/AdminUsersApi.md +8 -8
- package/docs/AdminWebhooksApi.md +7 -5
- package/docs/AdminWebhooksDeliveryReplayResponse.md +1 -1
- package/docs/AdminWebhooksDeliveryReplayResponseData.md +28 -0
- package/docs/AdminWebhooksTestResponse.md +2 -0
- package/docs/AgentsApi.md +64 -2
- package/docs/AttestResponseIdentity.md +1 -1
- package/docs/AuditLogEntry.md +1 -1
- package/docs/AuthenticationSettings.md +2 -6
- package/docs/AuthenticationSettingsPasswordPolicy.md +9 -0
- package/docs/AuthenticationSettingsPasswordRotationPolicy.md +1 -4
- package/docs/AuthorizationApi.md +1 -1
- package/docs/CreateClientResponseData.md +3 -1
- package/docs/EnrollAuthenticator201Response.md +1 -1
- package/docs/GetApprovalStatusResponseApprovedBy.md +1 -1
- package/docs/JitApi.md +3 -3
- package/docs/ListPermissionsResponsePermissionsItem.md +1 -1
- package/docs/OAuthApi.md +63 -2
- package/docs/OAuthClient.md +2 -0
- package/docs/OAuthClientSecretIssued.md +1 -1
- package/docs/OIDCApi.md +2 -2
- package/docs/PushEnrollmentStarted.md +1 -1
- package/docs/PutAdminAgentsUpdateRequest.md +2 -0
- package/docs/ReportAgentUsageResponse.md +22 -0
- package/docs/RequestMagicLinkRequest.md +26 -0
- package/docs/RequestMagicLinkResponse.md +20 -0
- package/docs/ScimSettingsInbound.md +0 -2
- package/docs/ScimSettingsInboundProtectedAttributes.md +3 -5
- package/docs/ScimSettingsOutbound.md +2 -4
- package/docs/TokenVaultApi.md +2 -2
- package/docs/UserinfoResponse.md +2 -0
- package/models/abac-attribute-definition.ts +1 -1
- package/models/abac-resource-attribute.ts +1 -1
- package/models/admin-agents-agents-rotate-key-request.ts +36 -0
- package/models/admin-agents-agents-rotate-key-response.ts +6 -0
- package/models/admin-agents-create-request.ts +6 -0
- package/models/admin-agents-report-usage-request.ts +36 -0
- package/models/admin-agents-report-usage-response-data-recorded.ts +36 -0
- package/models/admin-agents-report-usage-response-data.ts +39 -0
- package/models/admin-agents-report-usage-response.ts +33 -0
- package/models/admin-audit-logs-retention-response-data.ts +21 -3
- package/models/admin-identities-link-request.ts +8 -1
- package/models/admin-identities-list-response-data-bindings-item.ts +7 -0
- package/models/admin-sandbox-spawn-response-data.ts +29 -0
- package/models/admin-sandbox-spawn-response-data1.ts +30 -0
- package/models/admin-sandbox-spawn-response.ts +3 -3
- package/models/admin-webhooks-delivery-replay-response-data.ts +54 -0
- package/models/admin-webhooks-delivery-replay-response.ts +3 -3
- package/models/admin-webhooks-test-response.ts +6 -0
- package/models/attest-response-identity.ts +1 -1
- package/models/audit-log-entry.ts +1 -1
- package/models/authentication-settings-password-policy.ts +25 -1
- package/models/authentication-settings-password-rotation-policy.ts +1 -13
- package/models/authentication-settings.ts +13 -15
- package/models/get-approval-status-response-approved-by.ts +2 -2
- package/models/index.ts +11 -0
- package/models/list-permissions-response-permissions-item.ts +1 -1
- package/models/oauth-client-secret-issued.ts +1 -1
- package/models/oauth-client.ts +6 -0
- package/models/push-enrollment-started.ts +1 -1
- package/models/put-admin-agents-update-request.ts +6 -0
- package/models/report-agent-usage-response.ts +39 -0
- package/models/request-magic-link-request.ts +48 -0
- package/models/request-magic-link-response.ts +39 -0
- package/models/scim-settings-inbound-protected-attributes.ts +2 -10
- package/models/scim-settings-inbound.ts +0 -6
- package/models/scim-settings-outbound.ts +2 -8
- package/models/set-user-attribute-response-data.ts +1 -1
- package/models/userinfo-response.ts +6 -0
- package/package.json +1 -1
|
@@ -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
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface RequestMagicLinkResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface RequestMagicLinkResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof RequestMagicLinkResponse
|
|
22
|
+
*/
|
|
23
|
+
'status': RequestMagicLinkResponseStatus;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* @export
|
|
27
|
+
* @enum {string}
|
|
28
|
+
*/
|
|
29
|
+
export declare enum RequestMagicLinkResponseStatus {
|
|
30
|
+
SENT = "sent"
|
|
31
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
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.RequestMagicLinkResponseStatus = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* @export
|
|
19
|
+
* @enum {string}
|
|
20
|
+
*/
|
|
21
|
+
var RequestMagicLinkResponseStatus;
|
|
22
|
+
(function (RequestMagicLinkResponseStatus) {
|
|
23
|
+
RequestMagicLinkResponseStatus["SENT"] = "sent";
|
|
24
|
+
})(RequestMagicLinkResponseStatus || (exports.RequestMagicLinkResponseStatus = RequestMagicLinkResponseStatus = {}));
|
|
@@ -10,12 +10,11 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Attribute name => true when SCIM may not change it.
|
|
13
|
+
* Attribute name => true when SCIM may not change it. role_membership stops every /Groups request that would add or remove a member of a role.
|
|
14
14
|
* @export
|
|
15
15
|
* @interface ScimSettingsInboundProtectedAttributes
|
|
16
16
|
*/
|
|
17
17
|
export interface ScimSettingsInboundProtectedAttributes {
|
|
18
|
-
[key: string]: boolean | any;
|
|
19
18
|
/**
|
|
20
19
|
*
|
|
21
20
|
* @type {boolean}
|
|
@@ -39,11 +38,5 @@ export interface ScimSettingsInboundProtectedAttributes {
|
|
|
39
38
|
* @type {boolean}
|
|
40
39
|
* @memberof ScimSettingsInboundProtectedAttributes
|
|
41
40
|
*/
|
|
42
|
-
'
|
|
43
|
-
/**
|
|
44
|
-
*
|
|
45
|
-
* @type {boolean}
|
|
46
|
-
* @memberof ScimSettingsInboundProtectedAttributes
|
|
47
|
-
*/
|
|
48
|
-
'permissions'?: boolean;
|
|
41
|
+
'role_membership'?: boolean;
|
|
49
42
|
}
|
|
@@ -77,14 +77,6 @@ export interface ScimSettingsInbound {
|
|
|
77
77
|
* @memberof ScimSettingsInbound
|
|
78
78
|
*/
|
|
79
79
|
'protected_attributes'?: ScimSettingsInboundProtectedAttributes;
|
|
80
|
-
/**
|
|
81
|
-
* SCIM attribute => user field.
|
|
82
|
-
* @type {{ [key: string]: string; }}
|
|
83
|
-
* @memberof ScimSettingsInbound
|
|
84
|
-
*/
|
|
85
|
-
'attribute_mapping'?: {
|
|
86
|
-
[key: string]: string;
|
|
87
|
-
};
|
|
88
80
|
/**
|
|
89
81
|
*
|
|
90
82
|
* @type {boolean}
|
|
@@ -77,13 +77,13 @@ export interface ScimSettingsOutbound {
|
|
|
77
77
|
*/
|
|
78
78
|
'oauth2_scope'?: string | null;
|
|
79
79
|
/**
|
|
80
|
-
* Optional PEM CA certificate used for TLS verification.
|
|
80
|
+
* Optional PEM CA certificate used for TLS verification. Send null or an empty string to remove it. Changing it requires re-entering the stored secrets.
|
|
81
81
|
* @type {string}
|
|
82
82
|
* @memberof ScimSettingsOutbound
|
|
83
83
|
*/
|
|
84
84
|
'tls_certificate'?: string | null;
|
|
85
85
|
/**
|
|
86
|
-
*
|
|
86
|
+
* Always true. The endpoint certificate is always verified; false is rejected with 400.
|
|
87
87
|
* @type {boolean}
|
|
88
88
|
* @memberof ScimSettingsOutbound
|
|
89
89
|
*/
|
|
@@ -130,14 +130,6 @@ export interface ScimSettingsOutbound {
|
|
|
130
130
|
* @memberof ScimSettingsOutbound
|
|
131
131
|
*/
|
|
132
132
|
'batch_sync_interval'?: ScimSettingsOutboundBatchSyncInterval;
|
|
133
|
-
/**
|
|
134
|
-
* User field => SCIM attribute.
|
|
135
|
-
* @type {{ [key: string]: string; }}
|
|
136
|
-
* @memberof ScimSettingsOutbound
|
|
137
|
-
*/
|
|
138
|
-
'attribute_mapping'?: {
|
|
139
|
-
[key: string]: string;
|
|
140
|
-
};
|
|
141
133
|
/**
|
|
142
134
|
*
|
|
143
135
|
* @type {string}
|
|
@@ -173,6 +173,14 @@ export interface UserinfoResponse {
|
|
|
173
173
|
* @memberof UserinfoResponse
|
|
174
174
|
*/
|
|
175
175
|
'capabilities'?: Array<string> | null;
|
|
176
|
+
/**
|
|
177
|
+
* Agents only. The budget limits that are set (max_api_calls_per_hour, max_api_calls_per_day, max_tokens_per_hour, max_tokens_per_day, max_cost_per_day_usd, max_cost_per_month_usd, hard_limit; unlimited ones are left out) and any other policy keys, the usage in the current UTC windows (api_calls_this_hour, api_calls_today, tokens_used_this_hour, tokens_used_today, cost_today_usd, cost_this_month_usd), and exhausted: true when a limit is reached and the next metered call would get 429.
|
|
178
|
+
* @type {{ [key: string]: any; }}
|
|
179
|
+
* @memberof UserinfoResponse
|
|
180
|
+
*/
|
|
181
|
+
'budget_policy'?: {
|
|
182
|
+
[key: string]: any;
|
|
183
|
+
};
|
|
176
184
|
/**
|
|
177
185
|
* Clients only.
|
|
178
186
|
* @type {string}
|
package/docs/AAuthApi.md
CHANGED
|
@@ -659,7 +659,7 @@ const { status, data } = await apiInstance.issuePlatformToken(
|
|
|
659
659
|
|**400** | Invalid exchange request (grant_type / subject_token). | - |
|
|
660
660
|
|**401** | The AAuth token is invalid, expired, or revoked, or the RFC 9421 request signature is missing/invalid/replayed. | - |
|
|
661
661
|
|**403** | Denied by a conditional access policy. | - |
|
|
662
|
-
|**429** | Rate limit exceeded (per IP or per agent). | - |
|
|
662
|
+
|**429** | Rate limit exceeded (per IP or per agent), or the agent budget is spent (access_denied). | - |
|
|
663
663
|
|
|
664
664
|
[[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)
|
|
665
665
|
|
package/docs/AdminAbacApi.md
CHANGED
|
@@ -275,7 +275,7 @@ const { status, data } = await apiInstance.abacPoliciesCreate(
|
|
|
275
275
|
| Status code | Description | Response headers |
|
|
276
276
|
|-------------|-------------|------------------|
|
|
277
277
|
|**201** | Created | - |
|
|
278
|
-
|**400** | Invalid effect or policy conditions | - |
|
|
278
|
+
|**400** | Invalid effect, priority (a whole number from 0 to 1000) or policy conditions | - |
|
|
279
279
|
|**409** | A policy with this slug already exists | - |
|
|
280
280
|
|
|
281
281
|
[[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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AdminAgentsAgentsRotateKeyRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**apiKeyExpiresInDays** | **number** | Days until the new key expires; null for a key that never expires. | [optional] [default to undefined]
|
|
9
|
+
**apiKeyExpiresAt** | **string** | Exact expiry of the new key (ISO 8601, in the future); null for never. Ignored when apiKeyExpiresInDays is sent. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminAgentsAgentsRotateKeyRequest } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminAgentsAgentsRotateKeyRequest = {
|
|
17
|
+
apiKeyExpiresInDays,
|
|
18
|
+
apiKeyExpiresAt,
|
|
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)
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**message** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**api_key** | **string** | The new plaintext API key — shown only in this response. | [optional] [default to undefined]
|
|
10
|
+
**api_key_expires_at** | **string** | When the new key expires; null = never. | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { AdminAgentsAgentsRotateKeyResponse } from '@lumoauth/api-client';
|
|
|
16
17
|
const instance: AdminAgentsAgentsRotateKeyResponse = {
|
|
17
18
|
message,
|
|
18
19
|
api_key,
|
|
20
|
+
api_key_expires_at,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
package/docs/AdminAgentsApi.md
CHANGED
|
@@ -15,6 +15,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
15
15
|
|[**adminAgentsGet**](#adminagentsget) | **GET** /orgs/{orgId}/api/v1/admin/agents/{agentId} | Get a single agent by ID or agentId|
|
|
16
16
|
|[**adminAgentsGetScopes**](#adminagentsgetscopes) | **GET** /orgs/{orgId}/api/v1/admin/agents/{agentId}/scopes | Get agent scopes/capabilities|
|
|
17
17
|
|[**adminAgentsList**](#adminagentslist) | **GET** /orgs/{orgId}/api/v1/admin/agents | List all agents in the tenant|
|
|
18
|
+
|[**adminAgentsReportUsage**](#adminagentsreportusage) | **POST** /orgs/{orgId}/api/v1/admin/agents/{agentId}/usage | Report model tokens and cost for an agent|
|
|
18
19
|
|[**adminAgentsRevokeKey**](#adminagentsrevokekey) | **POST** /orgs/{orgId}/api/v1/admin/agents/{agentId}/revoke-key | Revoke agent API key (nullify it so it can no longer authenticate)|
|
|
19
20
|
|[**adminAgentsRotateCredentials**](#adminagentsrotatecredentials) | **POST** /orgs/{orgId}/api/v1/admin/agents/{agentId}/rotate-credentials | Rotate agent credentials|
|
|
20
21
|
|[**adminAgentsSetScopes**](#adminagentssetscopes) | **PUT** /orgs/{orgId}/api/v1/admin/agents/{agentId}/scopes | Update agent scopes/capabilities|
|
|
@@ -198,7 +199,8 @@ const { status, data } = await apiInstance.adminAgentsAgentsEnable(
|
|
|
198
199
|
```typescript
|
|
199
200
|
import {
|
|
200
201
|
AdminAgentsApi,
|
|
201
|
-
Configuration
|
|
202
|
+
Configuration,
|
|
203
|
+
AdminAgentsAgentsRotateKeyRequest
|
|
202
204
|
} from '@lumoauth/api-client';
|
|
203
205
|
|
|
204
206
|
const configuration = new Configuration();
|
|
@@ -206,10 +208,12 @@ const apiInstance = new AdminAgentsApi(configuration);
|
|
|
206
208
|
|
|
207
209
|
let orgId: string; // (default to undefined)
|
|
208
210
|
let agentId: string; // (default to undefined)
|
|
211
|
+
let adminAgentsAgentsRotateKeyRequest: AdminAgentsAgentsRotateKeyRequest; //Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). (optional)
|
|
209
212
|
|
|
210
213
|
const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
211
214
|
orgId,
|
|
212
|
-
agentId
|
|
215
|
+
agentId,
|
|
216
|
+
adminAgentsAgentsRotateKeyRequest
|
|
213
217
|
);
|
|
214
218
|
```
|
|
215
219
|
|
|
@@ -217,6 +221,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
217
221
|
|
|
218
222
|
|Name | Type | Description | Notes|
|
|
219
223
|
|------------- | ------------- | ------------- | -------------|
|
|
224
|
+
| **adminAgentsAgentsRotateKeyRequest** | **AdminAgentsAgentsRotateKeyRequest**| Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). | |
|
|
220
225
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
221
226
|
| **agentId** | [**string**] | | defaults to undefined|
|
|
222
227
|
|
|
@@ -231,7 +236,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
231
236
|
|
|
232
237
|
### HTTP request headers
|
|
233
238
|
|
|
234
|
-
- **Content-Type**:
|
|
239
|
+
- **Content-Type**: application/json
|
|
235
240
|
- **Accept**: application/json
|
|
236
241
|
|
|
237
242
|
|
|
@@ -239,6 +244,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
239
244
|
| Status code | Description | Response headers |
|
|
240
245
|
|-------------|-------------|------------------|
|
|
241
246
|
|**200** | API key rotated. The new key is returned ONCE and cannot be retrieved again. | - |
|
|
247
|
+
|**400** | The agent does not authenticate with an API key (identity type other than api_key), or the lifetime is invalid. | - |
|
|
242
248
|
|**401** | Authentication required. | - |
|
|
243
249
|
|**403** | Admin privileges required. | - |
|
|
244
250
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -296,7 +302,7 @@ const { status, data } = await apiInstance.adminAgentsCreate(
|
|
|
296
302
|
| Status code | Description | Response headers |
|
|
297
303
|
|-------------|-------------|------------------|
|
|
298
304
|
|**201** | Agent created. The generated credential/secret is returned ONCE and cannot be retrieved again. | - |
|
|
299
|
-
|**400** | Missing required field: name. | - |
|
|
305
|
+
|**400** | Missing required field: name, or an invalid budgetPolicy (unknown key, or a value that is not a number greater than zero). | - |
|
|
300
306
|
|**401** | Authentication required. | - |
|
|
301
307
|
|**403** | Admin privileges required. | - |
|
|
302
308
|
|**404** | Tenant not found. | - |
|
|
@@ -469,10 +475,11 @@ const { status, data } = await apiInstance.adminAgentsGenerateToken(
|
|
|
469
475
|
| Status code | Description | Response headers |
|
|
470
476
|
|-------------|-------------|------------------|
|
|
471
477
|
|**200** | A generated agent token. The token value is returned ONCE. | - |
|
|
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. | - |
|
|
478
|
+
|**400** | Inactive agent, an agent that only takes DPoP-bound tokens (a minted token cannot be bound to its key), 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
479
|
|**401** | Authentication required. | - |
|
|
474
480
|
|**403** | Admin privileges required. | - |
|
|
475
481
|
|**404** | Tenant or agent not found. | - |
|
|
482
|
+
|**429** | budget_exceeded: the agent budget is spent. A token mint counts as one call. Retry-After holds the seconds until the spent window starts again. | - |
|
|
476
483
|
|
|
477
484
|
[[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)
|
|
478
485
|
|
|
@@ -641,6 +648,68 @@ const { status, data } = await apiInstance.adminAgentsList(
|
|
|
641
648
|
|
|
642
649
|
[[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)
|
|
643
650
|
|
|
651
|
+
# **adminAgentsReportUsage**
|
|
652
|
+
> AdminAgentsReportUsageResponse adminAgentsReportUsage(adminAgentsReportUsageRequest)
|
|
653
|
+
|
|
654
|
+
For a trusted component of your organization, such as an AI gateway\'s spend callback or an orchestrator, that sees the agent\'s model calls. Adds the tokens and cost to the agent\'s budget windows (current UTC hour, day and month), exactly like POST /agents/me/usage from the agent itself. The report adds no API call and is accepted even when the budget is spent.
|
|
655
|
+
|
|
656
|
+
### Example
|
|
657
|
+
|
|
658
|
+
```typescript
|
|
659
|
+
import {
|
|
660
|
+
AdminAgentsApi,
|
|
661
|
+
Configuration,
|
|
662
|
+
AdminAgentsReportUsageRequest
|
|
663
|
+
} from '@lumoauth/api-client';
|
|
664
|
+
|
|
665
|
+
const configuration = new Configuration();
|
|
666
|
+
const apiInstance = new AdminAgentsApi(configuration);
|
|
667
|
+
|
|
668
|
+
let orgId: string; // (default to undefined)
|
|
669
|
+
let agentId: string; // (default to undefined)
|
|
670
|
+
let adminAgentsReportUsageRequest: AdminAgentsReportUsageRequest; //
|
|
671
|
+
|
|
672
|
+
const { status, data } = await apiInstance.adminAgentsReportUsage(
|
|
673
|
+
orgId,
|
|
674
|
+
agentId,
|
|
675
|
+
adminAgentsReportUsageRequest
|
|
676
|
+
);
|
|
677
|
+
```
|
|
678
|
+
|
|
679
|
+
### Parameters
|
|
680
|
+
|
|
681
|
+
|Name | Type | Description | Notes|
|
|
682
|
+
|------------- | ------------- | ------------- | -------------|
|
|
683
|
+
| **adminAgentsReportUsageRequest** | **AdminAgentsReportUsageRequest**| | |
|
|
684
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
685
|
+
| **agentId** | [**string**] | | defaults to undefined|
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
### Return type
|
|
689
|
+
|
|
690
|
+
**AdminAgentsReportUsageResponse**
|
|
691
|
+
|
|
692
|
+
### Authorization
|
|
693
|
+
|
|
694
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
695
|
+
|
|
696
|
+
### HTTP request headers
|
|
697
|
+
|
|
698
|
+
- **Content-Type**: application/json
|
|
699
|
+
- **Accept**: application/json
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
### HTTP response details
|
|
703
|
+
| Status code | Description | Response headers |
|
|
704
|
+
|-------------|-------------|------------------|
|
|
705
|
+
|**200** | Recorded. | - |
|
|
706
|
+
|**400** | tokens or cost_usd is missing, negative, too large or not a number. | - |
|
|
707
|
+
|**401** | Authentication required. | - |
|
|
708
|
+
|**403** | Admin privileges required. | - |
|
|
709
|
+
|**404** | Tenant or agent not found. | - |
|
|
710
|
+
|
|
711
|
+
[[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)
|
|
712
|
+
|
|
644
713
|
# **adminAgentsRevokeKey**
|
|
645
714
|
> AdminAgentsRevokeKeyResponse adminAgentsRevokeKey()
|
|
646
715
|
|
|
@@ -706,7 +775,8 @@ const { status, data } = await apiInstance.adminAgentsRevokeKey(
|
|
|
706
775
|
```typescript
|
|
707
776
|
import {
|
|
708
777
|
AdminAgentsApi,
|
|
709
|
-
Configuration
|
|
778
|
+
Configuration,
|
|
779
|
+
AdminAgentsAgentsRotateKeyRequest
|
|
710
780
|
} from '@lumoauth/api-client';
|
|
711
781
|
|
|
712
782
|
const configuration = new Configuration();
|
|
@@ -714,10 +784,12 @@ const apiInstance = new AdminAgentsApi(configuration);
|
|
|
714
784
|
|
|
715
785
|
let orgId: string; // (default to undefined)
|
|
716
786
|
let agentId: string; // (default to undefined)
|
|
787
|
+
let adminAgentsAgentsRotateKeyRequest: AdminAgentsAgentsRotateKeyRequest; //For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). (optional)
|
|
717
788
|
|
|
718
789
|
const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
719
790
|
orgId,
|
|
720
|
-
agentId
|
|
791
|
+
agentId,
|
|
792
|
+
adminAgentsAgentsRotateKeyRequest
|
|
721
793
|
);
|
|
722
794
|
```
|
|
723
795
|
|
|
@@ -725,6 +797,7 @@ const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
|
725
797
|
|
|
726
798
|
|Name | Type | Description | Notes|
|
|
727
799
|
|------------- | ------------- | ------------- | -------------|
|
|
800
|
+
| **adminAgentsAgentsRotateKeyRequest** | **AdminAgentsAgentsRotateKeyRequest**| For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). | |
|
|
728
801
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
729
802
|
| **agentId** | [**string**] | | defaults to undefined|
|
|
730
803
|
|
|
@@ -739,7 +812,7 @@ const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
|
739
812
|
|
|
740
813
|
### HTTP request headers
|
|
741
814
|
|
|
742
|
-
- **Content-Type**:
|
|
815
|
+
- **Content-Type**: application/json
|
|
743
816
|
- **Accept**: application/json
|
|
744
817
|
|
|
745
818
|
|
|
@@ -869,6 +942,7 @@ const { status, data } = await apiInstance.patchAdminAgentsUpdate(
|
|
|
869
942
|
| Status code | Description | Response headers |
|
|
870
943
|
|-------------|-------------|------------------|
|
|
871
944
|
|**200** | Agent updated. | - |
|
|
945
|
+
|**400** | Invalid budgetPolicy: an unknown key, or a value that is not a number greater than zero. | - |
|
|
872
946
|
|**401** | Authentication required. | - |
|
|
873
947
|
|**403** | Admin privileges required. | - |
|
|
874
948
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -929,6 +1003,7 @@ const { status, data } = await apiInstance.putAdminAgentsUpdate(
|
|
|
929
1003
|
| Status code | Description | Response headers |
|
|
930
1004
|
|-------------|-------------|------------------|
|
|
931
1005
|
|**200** | Agent updated. | - |
|
|
1006
|
+
|**400** | Invalid budgetPolicy: an unknown key, or a value that is not a number greater than zero. | - |
|
|
932
1007
|
|**401** | Authentication required. | - |
|
|
933
1008
|
|**403** | Admin privileges required. | - |
|
|
934
1009
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **string** | Required. Human-readable agent name. | [optional] [default to undefined]
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**capabilities** | **Array<string>** | | [optional] [default to undefined]
|
|
11
|
+
**budgetPolicy** | **{ [key: string]: any; }** | The agent budget. Keys: max_api_calls_per_hour, max_api_calls_per_day, max_tokens_per_hour, max_tokens_per_day (whole numbers), max_cost_per_day_usd, max_cost_per_month_usd, hard_limit (USD), max_steps, timeout_seconds (whole numbers, read by the agent from UserInfo), and the gateway-only max_cost_usd, monthly_usd, max_budget (USD). Each value must be greater than zero; an unknown key or an invalid value is refused with 400. Leave it out for an agent without a budget. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: AdminAgentsCreateRequest = {
|
|
|
18
19
|
name,
|
|
19
20
|
description,
|
|
20
21
|
capabilities,
|
|
22
|
+
budgetPolicy,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AdminAgentsReportUsageRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**tokens** | **number** | Model tokens used since the last report (input and output together). | [optional] [default to undefined]
|
|
9
|
+
**cost_usd** | **number** | Cost in USD since the last report. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminAgentsReportUsageRequest } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminAgentsReportUsageRequest = {
|
|
17
|
+
tokens,
|
|
18
|
+
cost_usd,
|
|
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,20 @@
|
|
|
1
|
+
# AdminAgentsReportUsageResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**AdminAgentsReportUsageResponseData**](AdminAgentsReportUsageResponseData.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AdminAgentsReportUsageResponse } from '@lumoauth/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: AdminAgentsReportUsageResponse = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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
|
+
# AdminAgentsReportUsageResponseData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**recorded** | [**AdminAgentsReportUsageResponseDataRecorded**](AdminAgentsReportUsageResponseDataRecorded.md) | | [optional] [default to undefined]
|
|
9
|
+
**budget** | **{ [key: string]: any; }** | Same shape as budget_policy in UserInfo: limits, usage in the current windows, exhausted. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminAgentsReportUsageResponseData } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminAgentsReportUsageResponseData = {
|
|
17
|
+
recorded,
|
|
18
|
+
budget,
|
|
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
|
+
# AdminAgentsReportUsageResponseDataRecorded
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**tokens** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**cost_usd** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminAgentsReportUsageResponseDataRecorded } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminAgentsReportUsageResponseDataRecorded = {
|
|
17
|
+
tokens,
|
|
18
|
+
cost_usd,
|
|
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)
|
|
@@ -5,9 +5,12 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**retentionDays** | **number** |
|
|
9
|
-
**autoDelete** | **boolean** |
|
|
10
|
-
**planLimitDays** | **number** |
|
|
8
|
+
**retentionDays** | **number** | The organization\'s own period, between minRetentionDays and maxRetentionDays. It applies while data retention is on and autoDelete is not false. | [optional] [default to undefined]
|
|
9
|
+
**autoDelete** | **boolean** | false switches the organization\'s own period off; the plan\'s period still applies | [optional] [default to undefined]
|
|
10
|
+
**planLimitDays** | **number** | The plan\'s period: older entries are not returned and are deleted. null when the plan has no limit. | [optional] [default to undefined]
|
|
11
|
+
**effectiveRetentionDays** | **number** | How long entries are kept now; null when nothing is deleted | [optional] [default to undefined]
|
|
12
|
+
**minRetentionDays** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**maxRetentionDays** | **number** | | [optional] [default to undefined]
|
|
11
14
|
|
|
12
15
|
## Example
|
|
13
16
|
|
|
@@ -18,6 +21,9 @@ const instance: AdminAuditLogsRetentionResponseData = {
|
|
|
18
21
|
retentionDays,
|
|
19
22
|
autoDelete,
|
|
20
23
|
planLimitDays,
|
|
24
|
+
effectiveRetentionDays,
|
|
25
|
+
minRetentionDays,
|
|
26
|
+
maxRetentionDays,
|
|
21
27
|
};
|
|
22
28
|
```
|
|
23
29
|
|
|
@@ -6,7 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | **string** | | [default to undefined]
|
|
9
|
-
**idp_id** | **number** | SAML IdP config id (type=saml) | [optional] [default to undefined]
|
|
9
|
+
**idp_id** | **number** | SAML IdP config id (type=saml) or OpenID Connect connection id (type=oidc) | [optional] [default to undefined]
|
|
10
|
+
**subject** | **string** | Subject the OpenID Connect provider issues for this user (type=oidc) | [optional] [default to undefined]
|
|
10
11
|
**name_id** | **string** | NameID the IdP asserts for this user (type=saml) | [optional] [default to undefined]
|
|
11
12
|
**ldap_config_id** | **number** | LDAP directory id (type=ldap) | [optional] [default to undefined]
|
|
12
13
|
**dn** | **string** | Distinguished name (type=ldap); omitted = look up | [optional] [default to undefined]
|
|
@@ -20,6 +21,7 @@ import { AdminIdentitiesLinkRequest } from '@lumoauth/api-client';
|
|
|
20
21
|
const instance: AdminIdentitiesLinkRequest = {
|
|
21
22
|
type,
|
|
22
23
|
idp_id,
|
|
24
|
+
subject,
|
|
23
25
|
name_id,
|
|
24
26
|
ldap_config_id,
|
|
25
27
|
dn,
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**type** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**idp_id** | **number** | | [optional] [default to undefined]
|
|
10
10
|
**name_id** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**subject** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**legacy** | **boolean** | | [optional] [default to undefined]
|
|
12
13
|
**ldap_config_id** | **number** | | [optional] [default to undefined]
|
|
13
14
|
**dn** | **string** | | [optional] [default to undefined]
|
|
@@ -22,6 +23,7 @@ const instance: AdminIdentitiesListResponseDataBindingsItem = {
|
|
|
22
23
|
type,
|
|
23
24
|
idp_id,
|
|
24
25
|
name_id,
|
|
26
|
+
subject,
|
|
25
27
|
legacy,
|
|
26
28
|
ldap_config_id,
|
|
27
29
|
dn,
|
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:
|
|
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 scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -57,6 +57,7 @@ const { status, data } = await apiInstance.adminMcpServersCreate(
|
|
|
57
57
|
| Status code | Description | Response headers |
|
|
58
58
|
|-------------|-------------|------------------|
|
|
59
59
|
|**201** | MCP server created | - |
|
|
60
|
+
|**400** | Invalid resource_uri, or a field that cannot be set (include_scope_in_challenge, bearer_methods_supported) | - |
|
|
60
61
|
|**409** | An MCP server with this resource_uri already exists | - |
|
|
61
62
|
|**422** | validation_error | - |
|
|
62
63
|
|
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
18
18
|
|[**putAdminClientsUpdateBranding**](#putadminclientsupdatebranding) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Replace an OAuth client\'s login and/or consent page branding|
|
|
19
19
|
|[**rotateClientSecret**](#rotateclientsecret) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/rotate-secret | Rotate an OAuth client secret|
|
|
20
20
|
|[**setClientScopes**](#setclientscopes) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client|
|
|
21
|
-
|[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} |
|
|
21
|
+
|[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Update an OAuth client (same as PATCH: only the fields that are sent change)|
|
|
22
22
|
|
|
23
23
|
# **adminClientsCimdCheck**
|
|
24
24
|
> AdminClientsCimdCheckResponse adminClientsCimdCheck(adminClientsCimdCheckRequest)
|
|
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.createClient(
|
|
|
177
177
|
### HTTP response details
|
|
178
178
|
| Status code | Description | Response headers |
|
|
179
179
|
|-------------|-------------|------------------|
|
|
180
|
-
|**201** | Created
|
|
180
|
+
|**201** | Created. For a confidential client the plaintext secret is included once and never shown again; a public client (isConfidential false) has no secret and the field is absent | - |
|
|
181
181
|
|
|
182
182
|
[[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)
|
|
183
183
|
|
package/docs/AdminSandboxApi.md
CHANGED
|
@@ -115,6 +115,7 @@ const { status, data } = await apiInstance.adminSandboxList(
|
|
|
115
115
|
# **adminSandboxSpawn**
|
|
116
116
|
> AdminSandboxSpawnResponse adminSandboxSpawn()
|
|
117
117
|
|
|
118
|
+
Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
118
119
|
|
|
119
120
|
### Example
|
|
120
121
|
|
|
@@ -162,7 +163,8 @@ const { status, data } = await apiInstance.adminSandboxSpawn(
|
|
|
162
163
|
### HTTP response details
|
|
163
164
|
| Status code | Description | Response headers |
|
|
164
165
|
|-------------|-------------|------------------|
|
|
165
|
-
|**201** | Sandbox created | - |
|
|
166
|
+
|**201** | Sandbox created. `data.api_key` is shown only once. | - |
|
|
167
|
+
|**403** | The organization lacks the Developer sandboxes add-on (`feature_not_in_plan`), or it is itself a sandbox | - |
|
|
166
168
|
|**429** | Per-owner active-sandbox cap reached | - |
|
|
167
169
|
|
|
168
170
|
[[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)
|