@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/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|
|
|
@@ -641,6 +642,68 @@ const { status, data } = await apiInstance.adminAgentsList(
|
|
|
641
642
|
|
|
642
643
|
[[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
644
|
|
|
645
|
+
# **adminAgentsReportUsage**
|
|
646
|
+
> AdminAgentsReportUsageResponse adminAgentsReportUsage(adminAgentsReportUsageRequest)
|
|
647
|
+
|
|
648
|
+
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.
|
|
649
|
+
|
|
650
|
+
### Example
|
|
651
|
+
|
|
652
|
+
```typescript
|
|
653
|
+
import {
|
|
654
|
+
AdminAgentsApi,
|
|
655
|
+
Configuration,
|
|
656
|
+
AdminAgentsReportUsageRequest
|
|
657
|
+
} from '@lumoauth/api-client';
|
|
658
|
+
|
|
659
|
+
const configuration = new Configuration();
|
|
660
|
+
const apiInstance = new AdminAgentsApi(configuration);
|
|
661
|
+
|
|
662
|
+
let orgId: string; // (default to undefined)
|
|
663
|
+
let agentId: string; // (default to undefined)
|
|
664
|
+
let adminAgentsReportUsageRequest: AdminAgentsReportUsageRequest; //
|
|
665
|
+
|
|
666
|
+
const { status, data } = await apiInstance.adminAgentsReportUsage(
|
|
667
|
+
orgId,
|
|
668
|
+
agentId,
|
|
669
|
+
adminAgentsReportUsageRequest
|
|
670
|
+
);
|
|
671
|
+
```
|
|
672
|
+
|
|
673
|
+
### Parameters
|
|
674
|
+
|
|
675
|
+
|Name | Type | Description | Notes|
|
|
676
|
+
|------------- | ------------- | ------------- | -------------|
|
|
677
|
+
| **adminAgentsReportUsageRequest** | **AdminAgentsReportUsageRequest**| | |
|
|
678
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
679
|
+
| **agentId** | [**string**] | | defaults to undefined|
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
### Return type
|
|
683
|
+
|
|
684
|
+
**AdminAgentsReportUsageResponse**
|
|
685
|
+
|
|
686
|
+
### Authorization
|
|
687
|
+
|
|
688
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
689
|
+
|
|
690
|
+
### HTTP request headers
|
|
691
|
+
|
|
692
|
+
- **Content-Type**: application/json
|
|
693
|
+
- **Accept**: application/json
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
### HTTP response details
|
|
697
|
+
| Status code | Description | Response headers |
|
|
698
|
+
|-------------|-------------|------------------|
|
|
699
|
+
|**200** | Recorded. | - |
|
|
700
|
+
|**400** | tokens or cost_usd is missing, negative, too large or not a number. | - |
|
|
701
|
+
|**401** | Authentication required. | - |
|
|
702
|
+
|**403** | Admin privileges required. | - |
|
|
703
|
+
|**404** | Tenant or agent not found. | - |
|
|
704
|
+
|
|
705
|
+
[[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)
|
|
706
|
+
|
|
644
707
|
# **adminAgentsRevokeKey**
|
|
645
708
|
> AdminAgentsRevokeKeyResponse adminAgentsRevokeKey()
|
|
646
709
|
|
|
@@ -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)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AdminClientsGetBrandingResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**AdminClientsGetBrandingResponseData**](AdminClientsGetBrandingResponseData.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AdminClientsGetBrandingResponse } from '@lumoauth/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: AdminClientsGetBrandingResponse = {
|
|
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
|
+
# AdminClientsGetBrandingResponseData
|
|
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 { AdminClientsGetBrandingResponseData } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminClientsGetBrandingResponseData = {
|
|
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)
|
package/docs/AdminEmailApi.md
CHANGED
|
@@ -28,10 +28,14 @@ const apiInstance = new AdminEmailApi(configuration);
|
|
|
28
28
|
|
|
29
29
|
let orgId: string; // (default to undefined)
|
|
30
30
|
let type: string; // (default to undefined)
|
|
31
|
+
let locale: string; // (optional) (default to undefined)
|
|
32
|
+
let clientId: string; // (optional) (default to undefined)
|
|
31
33
|
|
|
32
34
|
const { status, data } = await apiInstance.adminEmailTemplatesDelete(
|
|
33
35
|
orgId,
|
|
34
|
-
type
|
|
36
|
+
type,
|
|
37
|
+
locale,
|
|
38
|
+
clientId
|
|
35
39
|
);
|
|
36
40
|
```
|
|
37
41
|
|
|
@@ -41,6 +45,8 @@ const { status, data } = await apiInstance.adminEmailTemplatesDelete(
|
|
|
41
45
|
|------------- | ------------- | ------------- | -------------|
|
|
42
46
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
43
47
|
| **type** | [**string**] | | defaults to undefined|
|
|
48
|
+
| **locale** | [**string**] | | (optional) defaults to undefined|
|
|
49
|
+
| **clientId** | [**string**] | | (optional) defaults to undefined|
|
|
44
50
|
|
|
45
51
|
|
|
46
52
|
### Return type
|
|
@@ -82,10 +88,14 @@ const apiInstance = new AdminEmailApi(configuration);
|
|
|
82
88
|
|
|
83
89
|
let orgId: string; // (default to undefined)
|
|
84
90
|
let type: string; // (default to undefined)
|
|
91
|
+
let locale: string; //Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language (optional) (default to undefined)
|
|
92
|
+
let clientId: string; //Application variant (OAuth client_id); omit for the variant used by every application (optional) (default to undefined)
|
|
85
93
|
|
|
86
94
|
const { status, data } = await apiInstance.adminEmailTemplatesGet(
|
|
87
95
|
orgId,
|
|
88
|
-
type
|
|
96
|
+
type,
|
|
97
|
+
locale,
|
|
98
|
+
clientId
|
|
89
99
|
);
|
|
90
100
|
```
|
|
91
101
|
|
|
@@ -95,6 +105,8 @@ const { status, data } = await apiInstance.adminEmailTemplatesGet(
|
|
|
95
105
|
|------------- | ------------- | ------------- | -------------|
|
|
96
106
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
97
107
|
| **type** | [**string**] | | defaults to undefined|
|
|
108
|
+
| **locale** | [**string**] | Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language | (optional) defaults to undefined|
|
|
109
|
+
| **clientId** | [**string**] | Application variant (OAuth client_id); omit for the variant used by every application | (optional) defaults to undefined|
|
|
98
110
|
|
|
99
111
|
|
|
100
112
|
### Return type
|
|
@@ -226,6 +238,7 @@ const { status, data } = await apiInstance.adminEmailTemplatesPreview(
|
|
|
226
238
|
# **adminEmailTemplatesUpsert**
|
|
227
239
|
> EmailTemplate adminEmailTemplatesUpsert()
|
|
228
240
|
|
|
241
|
+
Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
229
242
|
|
|
230
243
|
### Example
|
|
231
244
|
|
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**adminClientsCimdCheck**](#adminclientscimdcheck) | **POST** /orgs/{orgId}/api/v1/admin/clients/cimd/check | Check a Client ID Metadata Document|
|
|
8
|
+
|[**adminClientsGetBranding**](#adminclientsgetbranding) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Get an OAuth client\'s login and consent page branding|
|
|
8
9
|
|[**createClient**](#createclient) | **POST** /orgs/{orgId}/api/v1/admin/clients | Create an OAuth client|
|
|
9
10
|
|[**deleteClient**](#deleteclient) | **DELETE** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Delete an OAuth client|
|
|
10
11
|
|[**disableClient**](#disableclient) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/disable | Disable an OAuth client|
|
|
@@ -12,7 +13,9 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
13
|
|[**getClient**](#getclient) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Get an OAuth client|
|
|
13
14
|
|[**listClientScopes**](#listclientscopes) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | List the scopes granted to an OAuth client|
|
|
14
15
|
|[**listClients**](#listclients) | **GET** /orgs/{orgId}/api/v1/admin/clients | List OAuth clients|
|
|
16
|
+
|[**patchAdminClientsUpdateBranding**](#patchadminclientsupdatebranding) | **PATCH** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Change keys of an OAuth client\'s login and/or consent page branding|
|
|
15
17
|
|[**patchClient**](#patchclient) | **PATCH** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Update an OAuth client|
|
|
18
|
+
|[**putAdminClientsUpdateBranding**](#putadminclientsupdatebranding) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Replace an OAuth client\'s login and/or consent page branding|
|
|
16
19
|
|[**rotateClientSecret**](#rotateclientsecret) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/rotate-secret | Rotate an OAuth client secret|
|
|
17
20
|
|[**setClientScopes**](#setclientscopes) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client|
|
|
18
21
|
|[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Replace an OAuth client|
|
|
@@ -73,6 +76,61 @@ const { status, data } = await apiInstance.adminClientsCimdCheck(
|
|
|
73
76
|
|
|
74
77
|
[[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)
|
|
75
78
|
|
|
79
|
+
# **adminClientsGetBranding**
|
|
80
|
+
> AdminClientsGetBrandingResponse adminClientsGetBranding()
|
|
81
|
+
|
|
82
|
+
Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
import {
|
|
88
|
+
AdminOAuthClientsApi,
|
|
89
|
+
Configuration
|
|
90
|
+
} from '@lumoauth/api-client';
|
|
91
|
+
|
|
92
|
+
const configuration = new Configuration();
|
|
93
|
+
const apiInstance = new AdminOAuthClientsApi(configuration);
|
|
94
|
+
|
|
95
|
+
let orgId: string; // (default to undefined)
|
|
96
|
+
let clientId: string; // (default to undefined)
|
|
97
|
+
|
|
98
|
+
const { status, data } = await apiInstance.adminClientsGetBranding(
|
|
99
|
+
orgId,
|
|
100
|
+
clientId
|
|
101
|
+
);
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Parameters
|
|
105
|
+
|
|
106
|
+
|Name | Type | Description | Notes|
|
|
107
|
+
|------------- | ------------- | ------------- | -------------|
|
|
108
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
109
|
+
| **clientId** | [**string**] | | defaults to undefined|
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### Return type
|
|
113
|
+
|
|
114
|
+
**AdminClientsGetBrandingResponse**
|
|
115
|
+
|
|
116
|
+
### Authorization
|
|
117
|
+
|
|
118
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
119
|
+
|
|
120
|
+
### HTTP request headers
|
|
121
|
+
|
|
122
|
+
- **Content-Type**: Not defined
|
|
123
|
+
- **Accept**: application/json
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### HTTP response details
|
|
127
|
+
| Status code | Description | Response headers |
|
|
128
|
+
|-------------|-------------|------------------|
|
|
129
|
+
|**200** | Branding of the application | - |
|
|
130
|
+
|**404** | OAuth client not found | - |
|
|
131
|
+
|
|
132
|
+
[[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)
|
|
133
|
+
|
|
76
134
|
# **createClient**
|
|
77
135
|
> CreateClientResponse createClient()
|
|
78
136
|
|
|
@@ -443,6 +501,64 @@ const { status, data } = await apiInstance.listClients(
|
|
|
443
501
|
|
|
444
502
|
[[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)
|
|
445
503
|
|
|
504
|
+
# **patchAdminClientsUpdateBranding**
|
|
505
|
+
> PatchAdminClientsUpdateBrandingResponse patchAdminClientsUpdateBranding()
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
### Example
|
|
509
|
+
|
|
510
|
+
```typescript
|
|
511
|
+
import {
|
|
512
|
+
AdminOAuthClientsApi,
|
|
513
|
+
Configuration,
|
|
514
|
+
AdminClientsGetBrandingResponseData
|
|
515
|
+
} from '@lumoauth/api-client';
|
|
516
|
+
|
|
517
|
+
const configuration = new Configuration();
|
|
518
|
+
const apiInstance = new AdminOAuthClientsApi(configuration);
|
|
519
|
+
|
|
520
|
+
let orgId: string; // (default to undefined)
|
|
521
|
+
let clientId: string; // (default to undefined)
|
|
522
|
+
let adminClientsGetBrandingResponseData: AdminClientsGetBrandingResponseData; // (optional)
|
|
523
|
+
|
|
524
|
+
const { status, data } = await apiInstance.patchAdminClientsUpdateBranding(
|
|
525
|
+
orgId,
|
|
526
|
+
clientId,
|
|
527
|
+
adminClientsGetBrandingResponseData
|
|
528
|
+
);
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
### Parameters
|
|
532
|
+
|
|
533
|
+
|Name | Type | Description | Notes|
|
|
534
|
+
|------------- | ------------- | ------------- | -------------|
|
|
535
|
+
| **adminClientsGetBrandingResponseData** | **AdminClientsGetBrandingResponseData**| | |
|
|
536
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
537
|
+
| **clientId** | [**string**] | | defaults to undefined|
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
### Return type
|
|
541
|
+
|
|
542
|
+
**PatchAdminClientsUpdateBrandingResponse**
|
|
543
|
+
|
|
544
|
+
### Authorization
|
|
545
|
+
|
|
546
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
547
|
+
|
|
548
|
+
### HTTP request headers
|
|
549
|
+
|
|
550
|
+
- **Content-Type**: application/json
|
|
551
|
+
- **Accept**: application/json
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
### HTTP response details
|
|
555
|
+
| Status code | Description | Response headers |
|
|
556
|
+
|-------------|-------------|------------------|
|
|
557
|
+
|**200** | Updated branding | - |
|
|
558
|
+
|**404** | OAuth client not found | - |
|
|
559
|
+
|
|
560
|
+
[[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)
|
|
561
|
+
|
|
446
562
|
# **patchClient**
|
|
447
563
|
> UpdateClientResponse patchClient()
|
|
448
564
|
|
|
@@ -497,6 +613,64 @@ const { status, data } = await apiInstance.patchClient(
|
|
|
497
613
|
|
|
498
614
|
[[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)
|
|
499
615
|
|
|
616
|
+
# **putAdminClientsUpdateBranding**
|
|
617
|
+
> PutAdminClientsUpdateBrandingResponse putAdminClientsUpdateBranding()
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
### Example
|
|
621
|
+
|
|
622
|
+
```typescript
|
|
623
|
+
import {
|
|
624
|
+
AdminOAuthClientsApi,
|
|
625
|
+
Configuration,
|
|
626
|
+
PutAdminClientsUpdateBrandingRequest
|
|
627
|
+
} from '@lumoauth/api-client';
|
|
628
|
+
|
|
629
|
+
const configuration = new Configuration();
|
|
630
|
+
const apiInstance = new AdminOAuthClientsApi(configuration);
|
|
631
|
+
|
|
632
|
+
let orgId: string; // (default to undefined)
|
|
633
|
+
let clientId: string; // (default to undefined)
|
|
634
|
+
let putAdminClientsUpdateBrandingRequest: PutAdminClientsUpdateBrandingRequest; // (optional)
|
|
635
|
+
|
|
636
|
+
const { status, data } = await apiInstance.putAdminClientsUpdateBranding(
|
|
637
|
+
orgId,
|
|
638
|
+
clientId,
|
|
639
|
+
putAdminClientsUpdateBrandingRequest
|
|
640
|
+
);
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
### Parameters
|
|
644
|
+
|
|
645
|
+
|Name | Type | Description | Notes|
|
|
646
|
+
|------------- | ------------- | ------------- | -------------|
|
|
647
|
+
| **putAdminClientsUpdateBrandingRequest** | **PutAdminClientsUpdateBrandingRequest**| | |
|
|
648
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
649
|
+
| **clientId** | [**string**] | | defaults to undefined|
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
### Return type
|
|
653
|
+
|
|
654
|
+
**PutAdminClientsUpdateBrandingResponse**
|
|
655
|
+
|
|
656
|
+
### Authorization
|
|
657
|
+
|
|
658
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
659
|
+
|
|
660
|
+
### HTTP request headers
|
|
661
|
+
|
|
662
|
+
- **Content-Type**: application/json
|
|
663
|
+
- **Accept**: application/json
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
### HTTP response details
|
|
667
|
+
| Status code | Description | Response headers |
|
|
668
|
+
|-------------|-------------|------------------|
|
|
669
|
+
|**200** | Updated branding | - |
|
|
670
|
+
|**404** | OAuth client not found | - |
|
|
671
|
+
|
|
672
|
+
[[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)
|
|
673
|
+
|
|
500
674
|
# **rotateClientSecret**
|
|
501
675
|
> RotateClientSecretResponse rotateClientSecret()
|
|
502
676
|
|
package/docs/AgentsApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
12
|
|[**getApprovalStatus**](#getapprovalstatus) | **GET** /orgs/{orgId}/api/v1/agents/me/approvals/{token}/status | |
|
|
13
13
|
|[**getCurrentAgent**](#getcurrentagent) | **GET** /orgs/{orgId}/api/v1/agents/me | Get details about the currently authenticated agent|
|
|
14
14
|
|[**registerAgent**](#registeragent) | **POST** /orgs/{orgId}/api/v1/agents/register | Register (or re-register) an agent|
|
|
15
|
+
|[**reportAgentUsage**](#reportagentusage) | **POST** /orgs/{orgId}/api/v1/agents/me/usage | Report the model tokens and cost that the agent used|
|
|
15
16
|
|[**verifyAgentCard**](#verifyagentcard) | **POST** /orgs/{orgId}/api/v1/agents/agent-card/verify | Verify a signed A2A agent card|
|
|
16
17
|
|
|
17
18
|
# **ask**
|
|
@@ -464,6 +465,64 @@ const { status, data } = await apiInstance.registerAgent(
|
|
|
464
465
|
|
|
465
466
|
[[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)
|
|
466
467
|
|
|
468
|
+
# **reportAgentUsage**
|
|
469
|
+
> ReportAgentUsageResponse reportAgentUsage(adminAgentsReportUsageRequest)
|
|
470
|
+
|
|
471
|
+
Adds the reported tokens and cost to the agent\'s budget windows (current UTC hour, day and month). LumoAuth does not see model calls, so token and cost limits apply only to usage that is reported here or through the Admin API. The report adds no API call and is accepted even when the budget is spent. Agent credentials only; portal test tokens are refused. Rate limited per agent.
|
|
472
|
+
|
|
473
|
+
### Example
|
|
474
|
+
|
|
475
|
+
```typescript
|
|
476
|
+
import {
|
|
477
|
+
AgentsApi,
|
|
478
|
+
Configuration,
|
|
479
|
+
AdminAgentsReportUsageRequest
|
|
480
|
+
} from '@lumoauth/api-client';
|
|
481
|
+
|
|
482
|
+
const configuration = new Configuration();
|
|
483
|
+
const apiInstance = new AgentsApi(configuration);
|
|
484
|
+
|
|
485
|
+
let orgId: string; // (default to undefined)
|
|
486
|
+
let adminAgentsReportUsageRequest: AdminAgentsReportUsageRequest; //
|
|
487
|
+
|
|
488
|
+
const { status, data } = await apiInstance.reportAgentUsage(
|
|
489
|
+
orgId,
|
|
490
|
+
adminAgentsReportUsageRequest
|
|
491
|
+
);
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
### Parameters
|
|
495
|
+
|
|
496
|
+
|Name | Type | Description | Notes|
|
|
497
|
+
|------------- | ------------- | ------------- | -------------|
|
|
498
|
+
| **adminAgentsReportUsageRequest** | **AdminAgentsReportUsageRequest**| | |
|
|
499
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
### Return type
|
|
503
|
+
|
|
504
|
+
**ReportAgentUsageResponse**
|
|
505
|
+
|
|
506
|
+
### Authorization
|
|
507
|
+
|
|
508
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
509
|
+
|
|
510
|
+
### HTTP request headers
|
|
511
|
+
|
|
512
|
+
- **Content-Type**: application/json
|
|
513
|
+
- **Accept**: application/json
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
### HTTP response details
|
|
517
|
+
| Status code | Description | Response headers |
|
|
518
|
+
|-------------|-------------|------------------|
|
|
519
|
+
|**200** | Recorded. `budget` has the same shape as `budget_policy` in UserInfo; `exhausted: true` means that the next metered call gets 429. | - |
|
|
520
|
+
|**400** | invalid_request: tokens or cost_usd is missing, negative, too large or not a number. | - |
|
|
521
|
+
|**403** | test_token_not_accepted or cross_tenant. | - |
|
|
522
|
+
|**429** | rate_limited: too many reports from this agent. | - |
|
|
523
|
+
|
|
524
|
+
[[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)
|
|
525
|
+
|
|
467
526
|
# **verifyAgentCard**
|
|
468
527
|
> VerifyAgentCardResponse verifyAgentCard(requestBody)
|
|
469
528
|
|
|
@@ -34,7 +34,6 @@ Name | Type | Description | Notes
|
|
|
34
34
|
**pushed_authorization_request_endpoint** | **string** | | [optional] [default to undefined]
|
|
35
35
|
**require_pushed_authorization_requests** | **boolean** | | [optional] [default to undefined]
|
|
36
36
|
**dpop_signing_alg_values_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
37
|
-
**tls_client_certificate_bound_access_tokens** | **boolean** | | [optional] [default to undefined]
|
|
38
37
|
**backchannel_authentication_endpoint** | **string** | | [optional] [default to undefined]
|
|
39
38
|
**backchannel_token_delivery_modes_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
40
39
|
**backchannel_user_code_parameter_supported** | **boolean** | | [optional] [default to undefined]
|
|
@@ -79,7 +78,6 @@ const instance: AuthorizationServerMetadata = {
|
|
|
79
78
|
pushed_authorization_request_endpoint,
|
|
80
79
|
require_pushed_authorization_requests,
|
|
81
80
|
dpop_signing_alg_values_supported,
|
|
82
|
-
tls_client_certificate_bound_access_tokens,
|
|
83
81
|
backchannel_authentication_endpoint,
|
|
84
82
|
backchannel_token_delivery_modes_supported,
|
|
85
83
|
backchannel_user_code_parameter_supported,
|