@lumoauth/api-client 1.2.0 → 1.4.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 +20 -0
- package/README.md +17 -4
- package/api/admin-agents-api.ts +130 -0
- package/api/admin-email-api.ts +67 -15
- package/api/admin-oauth-clients-api.ts +370 -0
- package/api/agents-api.ts +118 -0
- package/api/oauth-api.ts +0 -186
- package/dist/api/admin-agents-api.d.ts +73 -0
- package/dist/api/admin-agents-api.js +82 -0
- package/dist/api/admin-email-api.d.ts +41 -9
- package/dist/api/admin-email-api.js +34 -14
- package/dist/api/admin-oauth-clients-api.d.ts +210 -0
- package/dist/api/admin-oauth-clients-api.js +236 -0
- package/dist/api/agents-api.d.ts +65 -0
- package/dist/api/agents-api.js +77 -0
- package/dist/api/oauth-api.d.ts +0 -110
- package/dist/api/oauth-api.js +0 -132
- package/dist/esm/api/admin-agents-api.d.ts +73 -0
- package/dist/esm/api/admin-agents-api.js +82 -0
- package/dist/esm/api/admin-email-api.d.ts +41 -9
- package/dist/esm/api/admin-email-api.js +34 -14
- package/dist/esm/api/admin-oauth-clients-api.d.ts +210 -0
- package/dist/esm/api/admin-oauth-clients-api.js +236 -0
- 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 +0 -110
- package/dist/esm/api/oauth-api.js +0 -132
- 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-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-clients-get-branding-response-data.d.ts +34 -0
- package/dist/esm/models/admin-clients-get-branding-response-data.js +14 -0
- package/dist/esm/models/admin-clients-get-branding-response.d.ts +25 -0
- package/dist/esm/models/admin-clients-get-branding-response.js +14 -0
- package/dist/esm/models/authorization-server-metadata.d.ts +0 -6
- package/dist/esm/models/index.d.ts +10 -0
- package/dist/esm/models/index.js +10 -0
- package/dist/esm/models/open-id-configuration.d.ts +6 -6
- package/dist/esm/models/patch-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/esm/models/patch-admin-clients-update-branding-response.js +14 -0
- package/dist/esm/models/put-admin-clients-update-branding-request.d.ts +34 -0
- package/dist/esm/models/put-admin-clients-update-branding-request.js +14 -0
- package/dist/esm/models/put-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/esm/models/put-admin-clients-update-branding-response.js +14 -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/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-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-clients-get-branding-response-data.d.ts +34 -0
- package/dist/models/admin-clients-get-branding-response-data.js +15 -0
- package/dist/models/admin-clients-get-branding-response.d.ts +25 -0
- package/dist/models/admin-clients-get-branding-response.js +15 -0
- package/dist/models/authorization-server-metadata.d.ts +0 -6
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/open-id-configuration.d.ts +6 -6
- package/dist/models/patch-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/models/patch-admin-clients-update-branding-response.js +15 -0
- package/dist/models/put-admin-clients-update-branding-request.d.ts +34 -0
- package/dist/models/put-admin-clients-update-branding-request.js +15 -0
- package/dist/models/put-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/models/put-admin-clients-update-branding-response.js +15 -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/set-user-attribute-response-data.d.ts +1 -1
- package/dist/models/userinfo-response.d.ts +8 -0
- package/docs/AdminAgentsApi.md +63 -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/AdminClientsGetBrandingResponse.md +20 -0
- package/docs/AdminClientsGetBrandingResponseData.md +22 -0
- package/docs/AdminEmailApi.md +15 -2
- package/docs/AdminOAuthClientsApi.md +174 -0
- package/docs/AgentsApi.md +59 -0
- package/docs/AuthorizationServerMetadata.md +0 -2
- package/docs/OAuthApi.md +0 -105
- package/docs/OIDCApi.md +2 -2
- package/docs/OpenIdConfiguration.md +2 -2
- package/docs/PatchAdminClientsUpdateBrandingResponse.md +22 -0
- package/docs/PutAdminClientsUpdateBrandingRequest.md +22 -0
- package/docs/PutAdminClientsUpdateBrandingResponse.md +22 -0
- package/docs/ReportAgentUsageResponse.md +22 -0
- 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-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-clients-get-branding-response-data.ts +36 -0
- package/models/admin-clients-get-branding-response.ts +33 -0
- package/models/authorization-server-metadata.ts +0 -6
- package/models/index.ts +10 -0
- package/models/open-id-configuration.ts +6 -6
- package/models/patch-admin-clients-update-branding-response.ts +36 -0
- package/models/put-admin-clients-update-branding-request.ts +36 -0
- package/models/put-admin-clients-update-branding-response.ts +36 -0
- package/models/report-agent-usage-response.ts +39 -0
- 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
|
@@ -12,7 +12,6 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
12
|
|[**getOrgSelection**](#getorgselection) | **GET** /orgs/{orgId}/api/v1/oauth/org-select | Organization selector page|
|
|
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
|
-
|[**passkeyLogin**](#passkeylogin) | **GET** /orgs/{orgId}/api/v1/oauth/passkey-login | Passkey login entry point|
|
|
16
15
|
|[**registerClient**](#registerclient) | **POST** /orgs/{orgId}/api/v1/connect/register | Dynamic client registration (RFC 7591 / OIDC DCR)|
|
|
17
16
|
|[**revoke**](#revoke) | **POST** /orgs/{orgId}/api/v1/oauth/revoke | Token revocation (RFC 7009)|
|
|
18
17
|
|[**socialCallback**](#socialcallback) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback|
|
|
@@ -20,7 +19,6 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
20
19
|
|[**socialLogin**](#sociallogin) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider} | Start social / enterprise identity-provider login|
|
|
21
20
|
|[**submitAuthorization**](#submitauthorization) | **POST** /orgs/{orgId}/api/v1/oauth/authorize | OAuth 2.1 / OIDC authorization endpoint (form submission)|
|
|
22
21
|
|[**submitDeviceVerification**](#submitdeviceverification) | **POST** /orgs/{orgId}/api/v1/oauth/device | Submit device verification|
|
|
23
|
-
|[**submitLogin**](#submitlogin) | **POST** /orgs/{orgId}/api/v1/oauth/login/submit | Hosted login form submission|
|
|
24
22
|
|[**submitLoginJson**](#submitloginjson) | **POST** /orgs/{orgId}/api/v1/oauth/login/json | Programmatic (JSON) login for the authorization flow|
|
|
25
23
|
|[**submitOrgSelection**](#submitorgselection) | **POST** /orgs/{orgId}/api/v1/oauth/org-select | Submit organization selection|
|
|
26
24
|
|[**token**](#token) | **POST** /orgs/{orgId}/api/v1/oauth/token | OAuth 2.1 token endpoint|
|
|
@@ -458,57 +456,6 @@ const { status, data } = await apiInstance.par(
|
|
|
458
456
|
|
|
459
457
|
[[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)
|
|
460
458
|
|
|
461
|
-
# **passkeyLogin**
|
|
462
|
-
> passkeyLogin()
|
|
463
|
-
|
|
464
|
-
Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
465
|
-
|
|
466
|
-
### Example
|
|
467
|
-
|
|
468
|
-
```typescript
|
|
469
|
-
import {
|
|
470
|
-
OAuthApi,
|
|
471
|
-
Configuration
|
|
472
|
-
} from '@lumoauth/api-client';
|
|
473
|
-
|
|
474
|
-
const configuration = new Configuration();
|
|
475
|
-
const apiInstance = new OAuthApi(configuration);
|
|
476
|
-
|
|
477
|
-
let orgId: string; // (default to undefined)
|
|
478
|
-
|
|
479
|
-
const { status, data } = await apiInstance.passkeyLogin(
|
|
480
|
-
orgId
|
|
481
|
-
);
|
|
482
|
-
```
|
|
483
|
-
|
|
484
|
-
### Parameters
|
|
485
|
-
|
|
486
|
-
|Name | Type | Description | Notes|
|
|
487
|
-
|------------- | ------------- | ------------- | -------------|
|
|
488
|
-
| **orgId** | [**string**] | | defaults to undefined|
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
### Return type
|
|
492
|
-
|
|
493
|
-
void (empty response body)
|
|
494
|
-
|
|
495
|
-
### Authorization
|
|
496
|
-
|
|
497
|
-
No authorization required
|
|
498
|
-
|
|
499
|
-
### HTTP request headers
|
|
500
|
-
|
|
501
|
-
- **Content-Type**: Not defined
|
|
502
|
-
- **Accept**: Not defined
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
### HTTP response details
|
|
506
|
-
| Status code | Description | Response headers |
|
|
507
|
-
|-------------|-------------|------------------|
|
|
508
|
-
|**302** | Redirect to the hosted login page. | * Location - <br> |
|
|
509
|
-
|
|
510
|
-
[[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)
|
|
511
|
-
|
|
512
459
|
# **registerClient**
|
|
513
460
|
> RegisterClientResponse registerClient()
|
|
514
461
|
|
|
@@ -888,58 +835,6 @@ No authorization required
|
|
|
888
835
|
|
|
889
836
|
[[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)
|
|
890
837
|
|
|
891
|
-
# **submitLogin**
|
|
892
|
-
> submitLogin()
|
|
893
|
-
|
|
894
|
-
Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
895
|
-
|
|
896
|
-
### Example
|
|
897
|
-
|
|
898
|
-
```typescript
|
|
899
|
-
import {
|
|
900
|
-
OAuthApi,
|
|
901
|
-
Configuration
|
|
902
|
-
} from '@lumoauth/api-client';
|
|
903
|
-
|
|
904
|
-
const configuration = new Configuration();
|
|
905
|
-
const apiInstance = new OAuthApi(configuration);
|
|
906
|
-
|
|
907
|
-
let orgId: string; // (default to undefined)
|
|
908
|
-
|
|
909
|
-
const { status, data } = await apiInstance.submitLogin(
|
|
910
|
-
orgId
|
|
911
|
-
);
|
|
912
|
-
```
|
|
913
|
-
|
|
914
|
-
### Parameters
|
|
915
|
-
|
|
916
|
-
|Name | Type | Description | Notes|
|
|
917
|
-
|------------- | ------------- | ------------- | -------------|
|
|
918
|
-
| **orgId** | [**string**] | | defaults to undefined|
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
### Return type
|
|
922
|
-
|
|
923
|
-
void (empty response body)
|
|
924
|
-
|
|
925
|
-
### Authorization
|
|
926
|
-
|
|
927
|
-
No authorization required
|
|
928
|
-
|
|
929
|
-
### HTTP request headers
|
|
930
|
-
|
|
931
|
-
- **Content-Type**: Not defined
|
|
932
|
-
- **Accept**: Not defined
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
### HTTP response details
|
|
936
|
-
| Status code | Description | Response headers |
|
|
937
|
-
|-------------|-------------|------------------|
|
|
938
|
-
|**302** | Redirect to /oauth/authorize with the original client_id, redirect_uri, state, scope, PKCE and nonce parameters. | * Location - <br> |
|
|
939
|
-
|**404** | Unknown or inactive organization. | - |
|
|
940
|
-
|
|
941
|
-
[[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)
|
|
942
|
-
|
|
943
838
|
# **submitLoginJson**
|
|
944
839
|
> SubmitLoginJsonResponse submitLoginJson()
|
|
945
840
|
|
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. | - |
|
|
@@ -30,13 +30,13 @@ Name | Type | Description | Notes
|
|
|
30
30
|
**require_signed_request_object** | **boolean** | | [optional] [default to undefined]
|
|
31
31
|
**request_object_signing_alg_values_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
32
32
|
**ui_locales_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
33
|
+
**prompt_values_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
33
34
|
**acr_values_supported** | **Array<string>** | The four MFA tier ACR values plus the single-factor urn:lumoauth:acr:pwd (any signed-in session), unless overridden in organization settings. | [optional] [default to undefined]
|
|
34
35
|
**code_challenge_methods_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
35
36
|
**authorization_response_iss_parameter_supported** | **boolean** | | [optional] [default to undefined]
|
|
36
37
|
**pushed_authorization_request_endpoint** | **string** | | [optional] [default to undefined]
|
|
37
38
|
**require_pushed_authorization_requests** | **boolean** | | [optional] [default to undefined]
|
|
38
39
|
**dpop_signing_alg_values_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
39
|
-
**tls_client_certificate_bound_access_tokens** | **boolean** | | [optional] [default to undefined]
|
|
40
40
|
**introspection_endpoint** | **string** | | [optional] [default to undefined]
|
|
41
41
|
**introspection_endpoint_auth_methods_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
42
42
|
**revocation_endpoint** | **string** | | [optional] [default to undefined]
|
|
@@ -89,13 +89,13 @@ const instance: OpenIdConfiguration = {
|
|
|
89
89
|
require_signed_request_object,
|
|
90
90
|
request_object_signing_alg_values_supported,
|
|
91
91
|
ui_locales_supported,
|
|
92
|
+
prompt_values_supported,
|
|
92
93
|
acr_values_supported,
|
|
93
94
|
code_challenge_methods_supported,
|
|
94
95
|
authorization_response_iss_parameter_supported,
|
|
95
96
|
pushed_authorization_request_endpoint,
|
|
96
97
|
require_pushed_authorization_requests,
|
|
97
98
|
dpop_signing_alg_values_supported,
|
|
98
|
-
tls_client_certificate_bound_access_tokens,
|
|
99
99
|
introspection_endpoint,
|
|
100
100
|
introspection_endpoint_auth_methods_supported,
|
|
101
101
|
revocation_endpoint,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PatchAdminClientsUpdateBrandingResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
9
|
+
**rejected** | **Array<string>** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PatchAdminClientsUpdateBrandingResponse } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: PatchAdminClientsUpdateBrandingResponse = {
|
|
17
|
+
data,
|
|
18
|
+
rejected,
|
|
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
|
+
# PutAdminClientsUpdateBrandingRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**login** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
9
|
+
**consent** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PutAdminClientsUpdateBrandingRequest } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: PutAdminClientsUpdateBrandingRequest = {
|
|
17
|
+
login,
|
|
18
|
+
consent,
|
|
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
|
+
# PutAdminClientsUpdateBrandingResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
9
|
+
**rejected** | **Array<string>** | Keys whose value was refused by validation and not saved | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PutAdminClientsUpdateBrandingResponse } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: PutAdminClientsUpdateBrandingResponse = {
|
|
17
|
+
data,
|
|
18
|
+
rejected,
|
|
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
|
+
# 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)
|
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 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
|
+
|
|
@@ -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 AdminClientsGetBrandingResponseData
|
|
21
|
+
*/
|
|
22
|
+
export interface AdminClientsGetBrandingResponseData {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {{ [key: string]: any; }}
|
|
26
|
+
* @memberof AdminClientsGetBrandingResponseData
|
|
27
|
+
*/
|
|
28
|
+
'login'?: { [key: string]: any; };
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {{ [key: string]: any; }}
|
|
32
|
+
* @memberof AdminClientsGetBrandingResponseData
|
|
33
|
+
*/
|
|
34
|
+
'consent'?: { [key: string]: any; };
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -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 { AdminClientsGetBrandingResponseData } from './admin-clients-get-branding-response-data';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface AdminClientsGetBrandingResponse
|
|
24
|
+
*/
|
|
25
|
+
export interface AdminClientsGetBrandingResponse {
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {AdminClientsGetBrandingResponseData}
|
|
29
|
+
* @memberof AdminClientsGetBrandingResponse
|
|
30
|
+
*/
|
|
31
|
+
'data'?: AdminClientsGetBrandingResponseData;
|
|
32
|
+
}
|
|
33
|
+
|
|
@@ -194,12 +194,6 @@ export interface AuthorizationServerMetadata {
|
|
|
194
194
|
* @memberof AuthorizationServerMetadata
|
|
195
195
|
*/
|
|
196
196
|
'dpop_signing_alg_values_supported'?: Array<string>;
|
|
197
|
-
/**
|
|
198
|
-
*
|
|
199
|
-
* @type {boolean}
|
|
200
|
-
* @memberof AuthorizationServerMetadata
|
|
201
|
-
*/
|
|
202
|
-
'tls_client_certificate_bound_access_tokens'?: boolean;
|
|
203
197
|
/**
|
|
204
198
|
*
|
|
205
199
|
* @type {string}
|
package/models/index.ts
CHANGED
|
@@ -25,6 +25,10 @@ export * from './admin-agents-generate-token-response-data';
|
|
|
25
25
|
export * from './admin-agents-get-response';
|
|
26
26
|
export * from './admin-agents-get-scopes-response';
|
|
27
27
|
export * from './admin-agents-list-response';
|
|
28
|
+
export * from './admin-agents-report-usage-request';
|
|
29
|
+
export * from './admin-agents-report-usage-response';
|
|
30
|
+
export * from './admin-agents-report-usage-response-data';
|
|
31
|
+
export * from './admin-agents-report-usage-response-data-recorded';
|
|
28
32
|
export * from './admin-agents-revoke-key-response';
|
|
29
33
|
export * from './admin-agents-rotate-credentials-response';
|
|
30
34
|
export * from './admin-agents-set-scopes-request';
|
|
@@ -56,6 +60,8 @@ export * from './admin-audit-logs-stats-response-data-period';
|
|
|
56
60
|
export * from './admin-client-tokens-revoke-all-response';
|
|
57
61
|
export * from './admin-clients-cimd-check-request';
|
|
58
62
|
export * from './admin-clients-cimd-check-response';
|
|
63
|
+
export * from './admin-clients-get-branding-response';
|
|
64
|
+
export * from './admin-clients-get-branding-response-data';
|
|
59
65
|
export * from './admin-email-templates-list-response';
|
|
60
66
|
export * from './admin-email-templates-preview-response';
|
|
61
67
|
export * from './admin-email-templates-variables-response';
|
|
@@ -313,6 +319,7 @@ export * from './organization-role';
|
|
|
313
319
|
export * from './pagination-meta';
|
|
314
320
|
export * from './par-response';
|
|
315
321
|
export * from './passkey-enrollment-started';
|
|
322
|
+
export * from './patch-admin-clients-update-branding-response';
|
|
316
323
|
export * from './permission';
|
|
317
324
|
export * from './protected-resource-list';
|
|
318
325
|
export * from './protected-resource-metadata';
|
|
@@ -321,6 +328,8 @@ export * from './put-abac-attributes-update-response';
|
|
|
321
328
|
export * from './put-abac-policies-update-response';
|
|
322
329
|
export * from './put-admin-agents-update-request';
|
|
323
330
|
export * from './put-admin-agents-update-response';
|
|
331
|
+
export * from './put-admin-clients-update-branding-request';
|
|
332
|
+
export * from './put-admin-clients-update-branding-response';
|
|
324
333
|
export * from './put-admin-org-members-update-response';
|
|
325
334
|
export * from './put-admin-settings-authentication-update-response';
|
|
326
335
|
export * from './put-admin-settings-branding-update-response';
|
|
@@ -338,6 +347,7 @@ export * from './registered-client-metadata';
|
|
|
338
347
|
export * from './remove-user-group-response';
|
|
339
348
|
export * from './remove-user-permission-response';
|
|
340
349
|
export * from './remove-user-role-response';
|
|
350
|
+
export * from './report-agent-usage-response';
|
|
341
351
|
export * from './request-permission-request';
|
|
342
352
|
export * from './request-permission-response';
|
|
343
353
|
export * from './revoke-agent-token-request';
|
|
@@ -170,6 +170,12 @@ export interface OpenIdConfiguration {
|
|
|
170
170
|
* @memberof OpenIdConfiguration
|
|
171
171
|
*/
|
|
172
172
|
'ui_locales_supported'?: Array<string>;
|
|
173
|
+
/**
|
|
174
|
+
*
|
|
175
|
+
* @type {Array<string>}
|
|
176
|
+
* @memberof OpenIdConfiguration
|
|
177
|
+
*/
|
|
178
|
+
'prompt_values_supported'?: Array<string>;
|
|
173
179
|
/**
|
|
174
180
|
* The four MFA tier ACR values plus the single-factor urn:lumoauth:acr:pwd (any signed-in session), unless overridden in organization settings.
|
|
175
181
|
* @type {Array<string>}
|
|
@@ -206,12 +212,6 @@ export interface OpenIdConfiguration {
|
|
|
206
212
|
* @memberof OpenIdConfiguration
|
|
207
213
|
*/
|
|
208
214
|
'dpop_signing_alg_values_supported'?: Array<string>;
|
|
209
|
-
/**
|
|
210
|
-
*
|
|
211
|
-
* @type {boolean}
|
|
212
|
-
* @memberof OpenIdConfiguration
|
|
213
|
-
*/
|
|
214
|
-
'tls_client_certificate_bound_access_tokens'?: boolean;
|
|
215
215
|
/**
|
|
216
216
|
*
|
|
217
217
|
* @type {string}
|
|
@@ -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 PatchAdminClientsUpdateBrandingResponse
|
|
21
|
+
*/
|
|
22
|
+
export interface PatchAdminClientsUpdateBrandingResponse {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {{ [key: string]: any; }}
|
|
26
|
+
* @memberof PatchAdminClientsUpdateBrandingResponse
|
|
27
|
+
*/
|
|
28
|
+
'data'?: { [key: string]: any; };
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {Array<string>}
|
|
32
|
+
* @memberof PatchAdminClientsUpdateBrandingResponse
|
|
33
|
+
*/
|
|
34
|
+
'rejected'?: Array<string>;
|
|
35
|
+
}
|
|
36
|
+
|