@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
package/docs/OAuthApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
13
13
|
|[**introspect**](#introspect) | **POST** /orgs/{orgId}/api/v1/oauth/introspect | Token introspection (RFC 7662)|
|
|
14
14
|
|[**par**](#par) | **POST** /orgs/{orgId}/api/v1/oauth/par | Pushed authorization request (RFC 9126)|
|
|
15
15
|
|[**registerClient**](#registerclient) | **POST** /orgs/{orgId}/api/v1/connect/register | Dynamic client registration (RFC 7591 / OIDC DCR)|
|
|
16
|
+
|[**requestMagicLink**](#requestmagiclink) | **POST** /orgs/{orgId}/api/v1/oauth/magic-link | Request a sign-in link by email|
|
|
16
17
|
|[**revoke**](#revoke) | **POST** /orgs/{orgId}/api/v1/oauth/revoke | Token revocation (RFC 7009)|
|
|
17
18
|
|[**socialCallback**](#socialcallback) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback|
|
|
18
19
|
|[**socialCallbackPost**](#socialcallbackpost) | **POST** /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback (form_post)|
|
|
@@ -450,7 +451,7 @@ const { status, data } = await apiInstance.par(
|
|
|
450
451
|
| Status code | Description | Response headers |
|
|
451
452
|
|-------------|-------------|------------------|
|
|
452
453
|
|**201** | Pushed authorization request created (RFC 9126 §2.2). | - |
|
|
453
|
-
|**400** | invalid_request / invalid_target / invalid_request_object, or the
|
|
454
|
+
|**400** | invalid_request / invalid_target / invalid_request_object, or the organization is unknown. | - |
|
|
454
455
|
|**401** | invalid_client — client authentication failed. | - |
|
|
455
456
|
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
456
457
|
|
|
@@ -511,6 +512,65 @@ const { status, data } = await apiInstance.registerClient(
|
|
|
511
512
|
|
|
512
513
|
[[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)
|
|
513
514
|
|
|
515
|
+
# **requestMagicLink**
|
|
516
|
+
> RequestMagicLinkResponse requestMagicLink(requestMagicLinkRequest)
|
|
517
|
+
|
|
518
|
+
For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
519
|
+
|
|
520
|
+
### Example
|
|
521
|
+
|
|
522
|
+
```typescript
|
|
523
|
+
import {
|
|
524
|
+
OAuthApi,
|
|
525
|
+
Configuration,
|
|
526
|
+
RequestMagicLinkRequest
|
|
527
|
+
} from '@lumoauth/api-client';
|
|
528
|
+
|
|
529
|
+
const configuration = new Configuration();
|
|
530
|
+
const apiInstance = new OAuthApi(configuration);
|
|
531
|
+
|
|
532
|
+
let orgId: string; // (default to undefined)
|
|
533
|
+
let requestMagicLinkRequest: RequestMagicLinkRequest; //
|
|
534
|
+
|
|
535
|
+
const { status, data } = await apiInstance.requestMagicLink(
|
|
536
|
+
orgId,
|
|
537
|
+
requestMagicLinkRequest
|
|
538
|
+
);
|
|
539
|
+
```
|
|
540
|
+
|
|
541
|
+
### Parameters
|
|
542
|
+
|
|
543
|
+
|Name | Type | Description | Notes|
|
|
544
|
+
|------------- | ------------- | ------------- | -------------|
|
|
545
|
+
| **requestMagicLinkRequest** | **RequestMagicLinkRequest**| | |
|
|
546
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
### Return type
|
|
550
|
+
|
|
551
|
+
**RequestMagicLinkResponse**
|
|
552
|
+
|
|
553
|
+
### Authorization
|
|
554
|
+
|
|
555
|
+
No authorization required
|
|
556
|
+
|
|
557
|
+
### HTTP request headers
|
|
558
|
+
|
|
559
|
+
- **Content-Type**: application/json
|
|
560
|
+
- **Accept**: application/json
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
### HTTP response details
|
|
564
|
+
| Status code | Description | Response headers |
|
|
565
|
+
|-------------|-------------|------------------|
|
|
566
|
+
|**200** | The request was accepted. The answer is the same whether or not the address belongs to an account. | - |
|
|
567
|
+
|**400** | `{\"error\": …, \"message\": …}` with error `invalid_request`, `invalid_client`, `invalid_return_to`, `captcha_required` or `captcha_failed`. | - |
|
|
568
|
+
|**403** | `{\"error\":\"origin_not_allowed\"}`: the page that made the request is not one of the application\'s allowed origins. | - |
|
|
569
|
+
|**404** | `{\"error\":\"not_found\"}` for an unknown organization, `{\"error\":\"magic_link_disabled\"}` when the organization does not offer sign-in links. | - |
|
|
570
|
+
|**429** | `{\"error\":\"rate_limited\"}`. | - |
|
|
571
|
+
|
|
572
|
+
[[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)
|
|
573
|
+
|
|
514
574
|
# **revoke**
|
|
515
575
|
> object revoke()
|
|
516
576
|
|
|
@@ -885,7 +945,7 @@ No authorization required
|
|
|
885
945
|
|**200** | Signed in (status=complete — continue to /oauth/authorize) or a second factor is required (status=mfa_required with the challenge page URL). | - |
|
|
886
946
|
|**400** | {\"status\":\"invalid_request\"} or {\"status\":\"captcha_required\",\"message\":…}. | - |
|
|
887
947
|
|**401** | {\"status\":\"invalid_credentials\"}. | - |
|
|
888
|
-
|**403** | {\"status\":\"blocked\"} or {\"status\":\"inactive\"}. | - |
|
|
948
|
+
|**403** | {\"status\":\"blocked\"} or {\"status\":\"inactive\"}; {\"status\":\"sso_required\",\"redirect_url\":…} for an administrator of an organization that requires single sign-on for administrators. | - |
|
|
889
949
|
|**404** | {\"status\":\"not_found\"} — unknown or inactive organization. | - |
|
|
890
950
|
|**429** | {\"status\":\"rate_limited\"}. | - |
|
|
891
951
|
|
|
@@ -994,6 +1054,7 @@ const { status, data } = await apiInstance.token(
|
|
|
994
1054
|
|**200** | Token response (RFC 6749 §5.1). Which optional members are present depends on the grant: refresh_token only when the client may use the refresh_token grant; id_token for authorization_code / CIBA / device grants with the openid scope; issued_token_type for token exchange (including ID-JAG and Txn-Token, whose token_type is N_A and which carry no scope unless scopes were granted); authorization_details, jit_request_id and task_id only for agent-initiated CIBA. Always sent with Cache-Control: no-store. | * DPoP-Nonce - Fresh server nonce when the request carried a DPoP proof (RFC 9449 §8). <br> |
|
|
995
1055
|
|**400** | invalid_request / invalid_grant / unsupported_grant_type / invalid_scope (RFC 6749 §5.2). | - |
|
|
996
1056
|
|**401** | invalid_client — client authentication failed. | - |
|
|
1057
|
+
|**403** | plan_limit_reached — the month\'s included machine-to-machine tokens or active agents are used on a plan without overage; error_description says which. | - |
|
|
997
1058
|
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
998
1059
|
|
|
999
1060
|
[[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)
|
package/docs/OAuthClient.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**redirectUris** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
17
17
|
**scopes** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
18
18
|
**grantTypes** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
19
|
+
**cibaEnabled** | **boolean** | Detailed responses only. Whether the client may use CIBA (backchannel authentication). | [optional] [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -34,6 +35,7 @@ const instance: OAuthClient = {
|
|
|
34
35
|
redirectUris,
|
|
35
36
|
scopes,
|
|
36
37
|
grantTypes,
|
|
38
|
+
cibaEnabled,
|
|
37
39
|
};
|
|
38
40
|
```
|
|
39
41
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**secret** | **string** | Plaintext client secret — returned only once, never retrievable again | [optional] [default to undefined]
|
|
8
|
+
**secret** | **string** | Plaintext client secret — returned only once, never retrievable again. Absent for a public client | [optional] [default to undefined]
|
|
9
9
|
**_note** | **string** | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
package/docs/OIDCApi.md
CHANGED
|
@@ -214,7 +214,7 @@ const { status, data } = await apiInstance.userinfo(
|
|
|
214
214
|
### HTTP response details
|
|
215
215
|
| Status code | Description | Response headers |
|
|
216
216
|
|-------------|-------------|------------------|
|
|
217
|
-
|**200** | Claims for the token\'s principal. The shape depends on the identity type: a user token yields standard OIDC claims gated by scope (profile, email, phone, address), roles only when the client enabled the roles claim, plus tenant — null-valued claims are omitted; an agent token yields sub=agent_<id>, name, agent_id, workload_identity, capabilities, tenant, identity_type=agent; a client token yields sub=client_<id>, client_id, name, tenant, identity_type=client. Sent with Cache-Control: no-store. | - |
|
|
217
|
+
|**200** | Claims for the token\'s principal. The shape depends on the identity type: a user token yields standard OIDC claims gated by scope (profile, email, phone, address), roles only when the client enabled the roles claim, plus tenant — null-valued claims are omitted; an agent token (no openid scope needed: an agent is not an End-User and reads only its own record) yields sub=agent_<id>, name, agent_id, workload_identity, capabilities, budget_policy, tenant, identity_type=agent; a client token yields sub=client_<id>, client_id, name, tenant, identity_type=client. Sent with Cache-Control: no-store. | - |
|
|
218
218
|
|**400** | invalid_request — Authorization header missing or malformed. | - |
|
|
219
219
|
|**401** | invalid_token (invalid, expired, or wrong DPoP binding) or invalid_dpop_proof. | - |
|
|
220
220
|
|**403** | insufficient_scope — the openid scope is required. | - |
|
|
@@ -268,7 +268,7 @@ const { status, data } = await apiInstance.userinfoPost(
|
|
|
268
268
|
### HTTP response details
|
|
269
269
|
| Status code | Description | Response headers |
|
|
270
270
|
|-------------|-------------|------------------|
|
|
271
|
-
|**200** | Claims for the token\'s principal. The shape depends on the identity type: a user token yields standard OIDC claims gated by scope (profile, email, phone, address), roles only when the client enabled the roles claim, plus tenant — null-valued claims are omitted; an agent token yields sub=agent_<id>, name, agent_id, workload_identity, capabilities, tenant, identity_type=agent; a client token yields sub=client_<id>, client_id, name, tenant, identity_type=client. Sent with Cache-Control: no-store. | - |
|
|
271
|
+
|**200** | Claims for the token\'s principal. The shape depends on the identity type: a user token yields standard OIDC claims gated by scope (profile, email, phone, address), roles only when the client enabled the roles claim, plus tenant — null-valued claims are omitted; an agent token (no openid scope needed: an agent is not an End-User and reads only its own record) yields sub=agent_<id>, name, agent_id, workload_identity, capabilities, budget_policy, tenant, identity_type=agent; a client token yields sub=client_<id>, client_id, name, tenant, identity_type=client. Sent with Cache-Control: no-store. | - |
|
|
272
272
|
|**400** | invalid_request — Authorization header missing or malformed. | - |
|
|
273
273
|
|**401** | invalid_token (invalid, expired, or wrong DPoP binding) or invalid_dpop_proof. | - |
|
|
274
274
|
|**403** | insufficient_scope — the openid scope is required. | - |
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**state** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**qr_data_uri** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**deep_link** | **string** | https://<server>/push-auth/enroll?d=… — an Android App Link / iOS Universal Link that opens the authenticator app on a phone (falls back to a help page without it). | [optional] [default to undefined]
|
|
12
|
-
**deep_link_android** | **string** | Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when
|
|
12
|
+
**deep_link_android** | **string** | Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when it is not available. | [optional] [default to undefined]
|
|
13
13
|
**activation_code** | **string** | | [optional] [default to undefined]
|
|
14
14
|
**expires_at** | **string** | | [optional] [default to undefined]
|
|
15
15
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **string** | | [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. An update replaces the whole policy; {} or null removes the budget, and a request without the field leaves it as it is. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: PutAdminAgentsUpdateRequest = {
|
|
|
18
19
|
name,
|
|
19
20
|
description,
|
|
20
21
|
capabilities,
|
|
22
|
+
budgetPolicy,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ReportAgentUsageResponse
|
|
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; }** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ReportAgentUsageResponse } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: ReportAgentUsageResponse = {
|
|
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,26 @@
|
|
|
1
|
+
# RequestMagicLinkRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | The address to mail the sign-in link to. | [default to undefined]
|
|
9
|
+
**client_id** | **string** | Client ID of an active application of the organization. | [default to undefined]
|
|
10
|
+
**return_to** | **string** | Page of the application that the person goes to after signing in. An absolute https URL (http only on localhost) whose origin is one of the application\'s allowed origins or the origin of one of its redirect URIs. Without it the person goes to the organization\'s default page. | [optional] [default to undefined]
|
|
11
|
+
**captcha_token** | **string** | Token from the CAPTCHA widget. Required when the organization protects sign-in link requests with a CAPTCHA. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { RequestMagicLinkRequest } from '@lumoauth/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: RequestMagicLinkRequest = {
|
|
19
|
+
email,
|
|
20
|
+
client_id,
|
|
21
|
+
return_to,
|
|
22
|
+
captcha_token,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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
|
+
# RequestMagicLinkResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { RequestMagicLinkResponse } from '@lumoauth/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: RequestMagicLinkResponse = {
|
|
16
|
+
status,
|
|
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)
|
|
@@ -16,7 +16,6 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**allow_user_deletion** | **boolean** | | [optional] [default to undefined]
|
|
17
17
|
**allow_group_operations** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**protected_attributes** | [**ScimSettingsInboundProtectedAttributes**](ScimSettingsInboundProtectedAttributes.md) | | [optional] [default to undefined]
|
|
19
|
-
**attribute_mapping** | **{ [key: string]: string; }** | SCIM attribute => user field. | [optional] [default to undefined]
|
|
20
19
|
**auto_activate_users** | **boolean** | | [optional] [default to undefined]
|
|
21
20
|
**deprovisioning_action** | **string** | | [optional] [default to undefined]
|
|
22
21
|
|
|
@@ -36,7 +35,6 @@ const instance: ScimSettingsInbound = {
|
|
|
36
35
|
allow_user_deletion,
|
|
37
36
|
allow_group_operations,
|
|
38
37
|
protected_attributes,
|
|
39
|
-
attribute_mapping,
|
|
40
38
|
auto_activate_users,
|
|
41
39
|
deprovisioning_action,
|
|
42
40
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ScimSettingsInboundProtectedAttributes
|
|
2
2
|
|
|
3
|
-
Attribute name => true when SCIM may not change it.
|
|
3
|
+
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.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
@@ -9,8 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**email** | **boolean** | | [optional] [default to undefined]
|
|
10
10
|
**name** | **boolean** | | [optional] [default to undefined]
|
|
11
11
|
**active** | **boolean** | | [optional] [default to undefined]
|
|
12
|
-
**
|
|
13
|
-
**permissions** | **boolean** | | [optional] [default to undefined]
|
|
12
|
+
**role_membership** | **boolean** | | [optional] [default to undefined]
|
|
14
13
|
|
|
15
14
|
## Example
|
|
16
15
|
|
|
@@ -21,8 +20,7 @@ const instance: ScimSettingsInboundProtectedAttributes = {
|
|
|
21
20
|
email,
|
|
22
21
|
name,
|
|
23
22
|
active,
|
|
24
|
-
|
|
25
|
-
permissions,
|
|
23
|
+
role_membership,
|
|
26
24
|
};
|
|
27
25
|
```
|
|
28
26
|
|
|
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**oauth2_client_secret** | [**RedactedSecret**](RedactedSecret.md) | | [optional] [default to undefined]
|
|
17
17
|
**oauth2_token_url** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**oauth2_scope** | **string** | | [optional] [default to undefined]
|
|
19
|
-
**tls_certificate** | **string** | Optional PEM CA certificate used for TLS verification. | [optional] [default to undefined]
|
|
20
|
-
**verify_tls** | **boolean** |
|
|
19
|
+
**tls_certificate** | **string** | 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. | [optional] [default to undefined]
|
|
20
|
+
**verify_tls** | **boolean** | Always true. The endpoint certificate is always verified; false is rejected with 400. | [optional] [default to undefined]
|
|
21
21
|
**push_user_creates** | **boolean** | | [optional] [default to undefined]
|
|
22
22
|
**push_user_updates** | **boolean** | | [optional] [default to undefined]
|
|
23
23
|
**push_user_deletes** | **boolean** | | [optional] [default to undefined]
|
|
@@ -25,7 +25,6 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**sync_on_login** | **boolean** | | [optional] [default to undefined]
|
|
26
26
|
**batch_sync_enabled** | **boolean** | | [optional] [default to undefined]
|
|
27
27
|
**batch_sync_interval** | **string** | | [optional] [default to undefined]
|
|
28
|
-
**attribute_mapping** | **{ [key: string]: string; }** | User field => SCIM attribute. | [optional] [default to undefined]
|
|
29
28
|
**last_sync_at** | **string** | | [optional] [default to undefined]
|
|
30
29
|
**last_sync_status** | **string** | | [optional] [default to undefined]
|
|
31
30
|
**last_sync_error** | **string** | | [optional] [default to undefined]
|
|
@@ -59,7 +58,6 @@ const instance: ScimSettingsOutbound = {
|
|
|
59
58
|
sync_on_login,
|
|
60
59
|
batch_sync_enabled,
|
|
61
60
|
batch_sync_interval,
|
|
62
|
-
attribute_mapping,
|
|
63
61
|
last_sync_at,
|
|
64
62
|
last_sync_status,
|
|
65
63
|
last_sync_error,
|
package/docs/TokenVaultApi.md
CHANGED
|
@@ -63,10 +63,10 @@ const { status, data } = await apiInstance.getConnectionToken(
|
|
|
63
63
|
|-------------|-------------|------------------|
|
|
64
64
|
|**200** | The provider access token. | - |
|
|
65
65
|
|**400** | invalid_user_id. | - |
|
|
66
|
-
|**403** | agent_token_required, cross_tenant, delegation_not_permitted, agent_not_allowed, delegation_not_allowed or connection_disabled. | - |
|
|
66
|
+
|**403** | agent_token_required, cross_tenant, insufficient_scope (the token was narrowed with a scope), delegation_not_permitted, agent_not_allowed, delegation_not_allowed or connection_disabled. | - |
|
|
67
67
|
|**404** | tenant_not_found, connection_not_found or grant_not_found. | - |
|
|
68
68
|
|**409** | grant_revoked, grant_expired or refresh_failed. | - |
|
|
69
|
-
|**429** | rate_limited. | - |
|
|
69
|
+
|**429** | rate_limited, or budget_exceeded when the agent budget is spent. | - |
|
|
70
70
|
|**503** | refresh_in_progress (Retry-After: 2) or provider_unavailable. | - |
|
|
71
71
|
|
|
72
72
|
[[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)
|
package/docs/UserinfoResponse.md
CHANGED
|
@@ -31,6 +31,7 @@ Name | Type | Description | Notes
|
|
|
31
31
|
**agent_id** | **string** | Agents only. | [optional] [default to undefined]
|
|
32
32
|
**workload_identity** | **string** | Agents only. | [optional] [default to undefined]
|
|
33
33
|
**capabilities** | **Array<string>** | Agents only. | [optional] [default to undefined]
|
|
34
|
+
**budget_policy** | **{ [key: string]: any; }** | 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. | [optional] [default to undefined]
|
|
34
35
|
**client_id** | **string** | Clients only. | [optional] [default to undefined]
|
|
35
36
|
|
|
36
37
|
## Example
|
|
@@ -65,6 +66,7 @@ const instance: UserinfoResponse = {
|
|
|
65
66
|
agent_id,
|
|
66
67
|
workload_identity,
|
|
67
68
|
capabilities,
|
|
69
|
+
budget_policy,
|
|
68
70
|
client_id,
|
|
69
71
|
};
|
|
70
72
|
```
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LumoAuth API
|
|
5
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: sdk@lumoauth.dev
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface AdminAgentsAgentsRotateKeyRequest
|
|
21
|
+
*/
|
|
22
|
+
export interface AdminAgentsAgentsRotateKeyRequest {
|
|
23
|
+
/**
|
|
24
|
+
* Days until the new key expires; null for a key that never expires.
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof AdminAgentsAgentsRotateKeyRequest
|
|
27
|
+
*/
|
|
28
|
+
'apiKeyExpiresInDays'?: number | null;
|
|
29
|
+
/**
|
|
30
|
+
* Exact expiry of the new key (ISO 8601, in the future); null for never. Ignored when apiKeyExpiresInDays is sent.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof AdminAgentsAgentsRotateKeyRequest
|
|
33
|
+
*/
|
|
34
|
+
'apiKeyExpiresAt'?: string | null;
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -32,5 +32,11 @@ export interface AdminAgentsAgentsRotateKeyResponse {
|
|
|
32
32
|
* @memberof AdminAgentsAgentsRotateKeyResponse
|
|
33
33
|
*/
|
|
34
34
|
'api_key'?: string;
|
|
35
|
+
/**
|
|
36
|
+
* When the new key expires; null = never.
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof AdminAgentsAgentsRotateKeyResponse
|
|
39
|
+
*/
|
|
40
|
+
'api_key_expires_at'?: string | null;
|
|
35
41
|
}
|
|
36
42
|
|
|
@@ -38,5 +38,11 @@ export interface AdminAgentsCreateRequest {
|
|
|
38
38
|
* @memberof AdminAgentsCreateRequest
|
|
39
39
|
*/
|
|
40
40
|
'capabilities'?: Array<string>;
|
|
41
|
+
/**
|
|
42
|
+
* 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.
|
|
43
|
+
* @type {{ [key: string]: any; }}
|
|
44
|
+
* @memberof AdminAgentsCreateRequest
|
|
45
|
+
*/
|
|
46
|
+
'budgetPolicy'?: { [key: string]: any; } | null;
|
|
41
47
|
}
|
|
42
48
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LumoAuth API
|
|
5
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: sdk@lumoauth.dev
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface AdminAgentsReportUsageRequest
|
|
21
|
+
*/
|
|
22
|
+
export interface AdminAgentsReportUsageRequest {
|
|
23
|
+
/**
|
|
24
|
+
* Model tokens used since the last report (input and output together).
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof AdminAgentsReportUsageRequest
|
|
27
|
+
*/
|
|
28
|
+
'tokens'?: number;
|
|
29
|
+
/**
|
|
30
|
+
* Cost in USD since the last report.
|
|
31
|
+
* @type {number}
|
|
32
|
+
* @memberof AdminAgentsReportUsageRequest
|
|
33
|
+
*/
|
|
34
|
+
'cost_usd'?: number;
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LumoAuth API
|
|
5
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: sdk@lumoauth.dev
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface AdminAgentsReportUsageResponseDataRecorded
|
|
21
|
+
*/
|
|
22
|
+
export interface AdminAgentsReportUsageResponseDataRecorded {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof AdminAgentsReportUsageResponseDataRecorded
|
|
27
|
+
*/
|
|
28
|
+
'tokens'?: number;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {number}
|
|
32
|
+
* @memberof AdminAgentsReportUsageResponseDataRecorded
|
|
33
|
+
*/
|
|
34
|
+
'cost_usd'?: number;
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LumoAuth API
|
|
5
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: sdk@lumoauth.dev
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { AdminAgentsReportUsageResponseDataRecorded } from './admin-agents-report-usage-response-data-recorded';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface AdminAgentsReportUsageResponseData
|
|
24
|
+
*/
|
|
25
|
+
export interface AdminAgentsReportUsageResponseData {
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {AdminAgentsReportUsageResponseDataRecorded}
|
|
29
|
+
* @memberof AdminAgentsReportUsageResponseData
|
|
30
|
+
*/
|
|
31
|
+
'recorded'?: AdminAgentsReportUsageResponseDataRecorded;
|
|
32
|
+
/**
|
|
33
|
+
* Same shape as budget_policy in UserInfo: limits, usage in the current windows, exhausted.
|
|
34
|
+
* @type {{ [key: string]: any; }}
|
|
35
|
+
* @memberof AdminAgentsReportUsageResponseData
|
|
36
|
+
*/
|
|
37
|
+
'budget'?: { [key: string]: any; };
|
|
38
|
+
}
|
|
39
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LumoAuth API
|
|
5
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: sdk@lumoauth.dev
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { AdminAgentsReportUsageResponseData } from './admin-agents-report-usage-response-data';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface AdminAgentsReportUsageResponse
|
|
24
|
+
*/
|
|
25
|
+
export interface AdminAgentsReportUsageResponse {
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {AdminAgentsReportUsageResponseData}
|
|
29
|
+
* @memberof AdminAgentsReportUsageResponse
|
|
30
|
+
*/
|
|
31
|
+
'data'?: AdminAgentsReportUsageResponseData;
|
|
32
|
+
}
|
|
33
|
+
|
|
@@ -21,22 +21,40 @@
|
|
|
21
21
|
*/
|
|
22
22
|
export interface AdminAuditLogsRetentionResponseData {
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* The organization\'s own period, between minRetentionDays and maxRetentionDays. It applies while data retention is on and autoDelete is not false.
|
|
25
25
|
* @type {number}
|
|
26
26
|
* @memberof AdminAuditLogsRetentionResponseData
|
|
27
27
|
*/
|
|
28
28
|
'retentionDays'?: number;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* false switches the organization\'s own period off; the plan\'s period still applies
|
|
31
31
|
* @type {boolean}
|
|
32
32
|
* @memberof AdminAuditLogsRetentionResponseData
|
|
33
33
|
*/
|
|
34
34
|
'autoDelete'?: boolean;
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* The plan\'s period: older entries are not returned and are deleted. null when the plan has no limit.
|
|
37
37
|
* @type {number}
|
|
38
38
|
* @memberof AdminAuditLogsRetentionResponseData
|
|
39
39
|
*/
|
|
40
40
|
'planLimitDays'?: number | null;
|
|
41
|
+
/**
|
|
42
|
+
* How long entries are kept now; null when nothing is deleted
|
|
43
|
+
* @type {number}
|
|
44
|
+
* @memberof AdminAuditLogsRetentionResponseData
|
|
45
|
+
*/
|
|
46
|
+
'effectiveRetentionDays'?: number | null;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {number}
|
|
50
|
+
* @memberof AdminAuditLogsRetentionResponseData
|
|
51
|
+
*/
|
|
52
|
+
'minRetentionDays'?: number;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {number}
|
|
56
|
+
* @memberof AdminAuditLogsRetentionResponseData
|
|
57
|
+
*/
|
|
58
|
+
'maxRetentionDays'?: number;
|
|
41
59
|
}
|
|
42
60
|
|