@lumoauth/api-client 1.4.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 +12 -0
- package/README.md +12 -5
- package/api/admin-agents-api.ts +36 -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/oauth-api.ts +111 -0
- package/dist/api/admin-agents-api.d.ts +21 -4
- package/dist/api/admin-agents-api.js +18 -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/oauth-api.d.ts +65 -0
- package/dist/api/oauth-api.js +72 -0
- package/dist/esm/api/admin-agents-api.d.ts +21 -4
- package/dist/esm/api/admin-agents-api.js +18 -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/oauth-api.d.ts +65 -0
- package/dist/esm/api/oauth-api.js +73 -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-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 +6 -0
- package/dist/esm/models/index.js +6 -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/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/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-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 +6 -0
- package/dist/models/index.js +6 -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/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/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 +20 -8
- package/docs/AdminAgentsCreateRequest.md +2 -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 +6 -3
- 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/PushEnrollmentStarted.md +1 -1
- package/docs/PutAdminAgentsUpdateRequest.md +2 -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/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-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 +6 -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/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/package.json +1 -1
|
@@ -77,14 +77,6 @@ export interface ScimSettingsInbound {
|
|
|
77
77
|
* @memberof ScimSettingsInbound
|
|
78
78
|
*/
|
|
79
79
|
'protected_attributes'?: ScimSettingsInboundProtectedAttributes;
|
|
80
|
-
/**
|
|
81
|
-
* SCIM attribute => user field.
|
|
82
|
-
* @type {{ [key: string]: string; }}
|
|
83
|
-
* @memberof ScimSettingsInbound
|
|
84
|
-
*/
|
|
85
|
-
'attribute_mapping'?: {
|
|
86
|
-
[key: string]: string;
|
|
87
|
-
};
|
|
88
80
|
/**
|
|
89
81
|
*
|
|
90
82
|
* @type {boolean}
|
|
@@ -77,13 +77,13 @@ export interface ScimSettingsOutbound {
|
|
|
77
77
|
*/
|
|
78
78
|
'oauth2_scope'?: string | null;
|
|
79
79
|
/**
|
|
80
|
-
* Optional PEM CA certificate used for TLS verification.
|
|
80
|
+
* Optional PEM CA certificate used for TLS verification. Send null or an empty string to remove it. Changing it requires re-entering the stored secrets.
|
|
81
81
|
* @type {string}
|
|
82
82
|
* @memberof ScimSettingsOutbound
|
|
83
83
|
*/
|
|
84
84
|
'tls_certificate'?: string | null;
|
|
85
85
|
/**
|
|
86
|
-
*
|
|
86
|
+
* Always true. The endpoint certificate is always verified; false is rejected with 400.
|
|
87
87
|
* @type {boolean}
|
|
88
88
|
* @memberof ScimSettingsOutbound
|
|
89
89
|
*/
|
|
@@ -130,14 +130,6 @@ export interface ScimSettingsOutbound {
|
|
|
130
130
|
* @memberof ScimSettingsOutbound
|
|
131
131
|
*/
|
|
132
132
|
'batch_sync_interval'?: ScimSettingsOutboundBatchSyncInterval;
|
|
133
|
-
/**
|
|
134
|
-
* User field => SCIM attribute.
|
|
135
|
-
* @type {{ [key: string]: string; }}
|
|
136
|
-
* @memberof ScimSettingsOutbound
|
|
137
|
-
*/
|
|
138
|
-
'attribute_mapping'?: {
|
|
139
|
-
[key: string]: string;
|
|
140
|
-
};
|
|
141
133
|
/**
|
|
142
134
|
*
|
|
143
135
|
* @type {string}
|
package/docs/AAuthApi.md
CHANGED
|
@@ -659,7 +659,7 @@ const { status, data } = await apiInstance.issuePlatformToken(
|
|
|
659
659
|
|**400** | Invalid exchange request (grant_type / subject_token). | - |
|
|
660
660
|
|**401** | The AAuth token is invalid, expired, or revoked, or the RFC 9421 request signature is missing/invalid/replayed. | - |
|
|
661
661
|
|**403** | Denied by a conditional access policy. | - |
|
|
662
|
-
|**429** | Rate limit exceeded (per IP or per agent). | - |
|
|
662
|
+
|**429** | Rate limit exceeded (per IP or per agent), or the agent budget is spent (access_denied). | - |
|
|
663
663
|
|
|
664
664
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
665
665
|
|
package/docs/AdminAbacApi.md
CHANGED
|
@@ -275,7 +275,7 @@ const { status, data } = await apiInstance.abacPoliciesCreate(
|
|
|
275
275
|
| Status code | Description | Response headers |
|
|
276
276
|
|-------------|-------------|------------------|
|
|
277
277
|
|**201** | Created | - |
|
|
278
|
-
|**400** | Invalid effect or policy conditions | - |
|
|
278
|
+
|**400** | Invalid effect, priority (a whole number from 0 to 1000) or policy conditions | - |
|
|
279
279
|
|**409** | A policy with this slug already exists | - |
|
|
280
280
|
|
|
281
281
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AdminAgentsAgentsRotateKeyRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**apiKeyExpiresInDays** | **number** | Days until the new key expires; null for a key that never expires. | [optional] [default to undefined]
|
|
9
|
+
**apiKeyExpiresAt** | **string** | Exact expiry of the new key (ISO 8601, in the future); null for never. Ignored when apiKeyExpiresInDays is sent. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminAgentsAgentsRotateKeyRequest } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminAgentsAgentsRotateKeyRequest = {
|
|
17
|
+
apiKeyExpiresInDays,
|
|
18
|
+
apiKeyExpiresAt,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**message** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**api_key** | **string** | The new plaintext API key — shown only in this response. | [optional] [default to undefined]
|
|
10
|
+
**api_key_expires_at** | **string** | When the new key expires; null = never. | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { AdminAgentsAgentsRotateKeyResponse } from '@lumoauth/api-client';
|
|
|
16
17
|
const instance: AdminAgentsAgentsRotateKeyResponse = {
|
|
17
18
|
message,
|
|
18
19
|
api_key,
|
|
20
|
+
api_key_expires_at,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
package/docs/AdminAgentsApi.md
CHANGED
|
@@ -199,7 +199,8 @@ const { status, data } = await apiInstance.adminAgentsAgentsEnable(
|
|
|
199
199
|
```typescript
|
|
200
200
|
import {
|
|
201
201
|
AdminAgentsApi,
|
|
202
|
-
Configuration
|
|
202
|
+
Configuration,
|
|
203
|
+
AdminAgentsAgentsRotateKeyRequest
|
|
203
204
|
} from '@lumoauth/api-client';
|
|
204
205
|
|
|
205
206
|
const configuration = new Configuration();
|
|
@@ -207,10 +208,12 @@ const apiInstance = new AdminAgentsApi(configuration);
|
|
|
207
208
|
|
|
208
209
|
let orgId: string; // (default to undefined)
|
|
209
210
|
let agentId: string; // (default to undefined)
|
|
211
|
+
let adminAgentsAgentsRotateKeyRequest: AdminAgentsAgentsRotateKeyRequest; //Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). (optional)
|
|
210
212
|
|
|
211
213
|
const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
212
214
|
orgId,
|
|
213
|
-
agentId
|
|
215
|
+
agentId,
|
|
216
|
+
adminAgentsAgentsRotateKeyRequest
|
|
214
217
|
);
|
|
215
218
|
```
|
|
216
219
|
|
|
@@ -218,6 +221,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
218
221
|
|
|
219
222
|
|Name | Type | Description | Notes|
|
|
220
223
|
|------------- | ------------- | ------------- | -------------|
|
|
224
|
+
| **adminAgentsAgentsRotateKeyRequest** | **AdminAgentsAgentsRotateKeyRequest**| Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). | |
|
|
221
225
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
222
226
|
| **agentId** | [**string**] | | defaults to undefined|
|
|
223
227
|
|
|
@@ -232,7 +236,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
232
236
|
|
|
233
237
|
### HTTP request headers
|
|
234
238
|
|
|
235
|
-
- **Content-Type**:
|
|
239
|
+
- **Content-Type**: application/json
|
|
236
240
|
- **Accept**: application/json
|
|
237
241
|
|
|
238
242
|
|
|
@@ -240,6 +244,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
240
244
|
| Status code | Description | Response headers |
|
|
241
245
|
|-------------|-------------|------------------|
|
|
242
246
|
|**200** | API key rotated. The new key is returned ONCE and cannot be retrieved again. | - |
|
|
247
|
+
|**400** | The agent does not authenticate with an API key (identity type other than api_key), or the lifetime is invalid. | - |
|
|
243
248
|
|**401** | Authentication required. | - |
|
|
244
249
|
|**403** | Admin privileges required. | - |
|
|
245
250
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -297,7 +302,7 @@ const { status, data } = await apiInstance.adminAgentsCreate(
|
|
|
297
302
|
| Status code | Description | Response headers |
|
|
298
303
|
|-------------|-------------|------------------|
|
|
299
304
|
|**201** | Agent created. The generated credential/secret is returned ONCE and cannot be retrieved again. | - |
|
|
300
|
-
|**400** | Missing required field: name. | - |
|
|
305
|
+
|**400** | Missing required field: name, or an invalid budgetPolicy (unknown key, or a value that is not a number greater than zero). | - |
|
|
301
306
|
|**401** | Authentication required. | - |
|
|
302
307
|
|**403** | Admin privileges required. | - |
|
|
303
308
|
|**404** | Tenant not found. | - |
|
|
@@ -470,10 +475,11 @@ const { status, data } = await apiInstance.adminAgentsGenerateToken(
|
|
|
470
475
|
| Status code | Description | Response headers |
|
|
471
476
|
|-------------|-------------|------------------|
|
|
472
477
|
|**200** | A generated agent token. The token value is returned ONCE. | - |
|
|
473
|
-
|**400** | Inactive agent, requested scopes outside the agent\'s capabilities, a resource that is not an active MCP server of this organization, or expiresIn above 3600 without a resource. | - |
|
|
478
|
+
|**400** | Inactive agent, an agent that only takes DPoP-bound tokens (a minted token cannot be bound to its key), requested scopes outside the agent\'s capabilities, a resource that is not an active MCP server of this organization, or expiresIn above 3600 without a resource. | - |
|
|
474
479
|
|**401** | Authentication required. | - |
|
|
475
480
|
|**403** | Admin privileges required. | - |
|
|
476
481
|
|**404** | Tenant or agent not found. | - |
|
|
482
|
+
|**429** | budget_exceeded: the agent budget is spent. A token mint counts as one call. Retry-After holds the seconds until the spent window starts again. | - |
|
|
477
483
|
|
|
478
484
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
479
485
|
|
|
@@ -769,7 +775,8 @@ const { status, data } = await apiInstance.adminAgentsRevokeKey(
|
|
|
769
775
|
```typescript
|
|
770
776
|
import {
|
|
771
777
|
AdminAgentsApi,
|
|
772
|
-
Configuration
|
|
778
|
+
Configuration,
|
|
779
|
+
AdminAgentsAgentsRotateKeyRequest
|
|
773
780
|
} from '@lumoauth/api-client';
|
|
774
781
|
|
|
775
782
|
const configuration = new Configuration();
|
|
@@ -777,10 +784,12 @@ const apiInstance = new AdminAgentsApi(configuration);
|
|
|
777
784
|
|
|
778
785
|
let orgId: string; // (default to undefined)
|
|
779
786
|
let agentId: string; // (default to undefined)
|
|
787
|
+
let adminAgentsAgentsRotateKeyRequest: AdminAgentsAgentsRotateKeyRequest; //For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). (optional)
|
|
780
788
|
|
|
781
789
|
const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
782
790
|
orgId,
|
|
783
|
-
agentId
|
|
791
|
+
agentId,
|
|
792
|
+
adminAgentsAgentsRotateKeyRequest
|
|
784
793
|
);
|
|
785
794
|
```
|
|
786
795
|
|
|
@@ -788,6 +797,7 @@ const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
|
788
797
|
|
|
789
798
|
|Name | Type | Description | Notes|
|
|
790
799
|
|------------- | ------------- | ------------- | -------------|
|
|
800
|
+
| **adminAgentsAgentsRotateKeyRequest** | **AdminAgentsAgentsRotateKeyRequest**| For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). | |
|
|
791
801
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
792
802
|
| **agentId** | [**string**] | | defaults to undefined|
|
|
793
803
|
|
|
@@ -802,7 +812,7 @@ const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
|
802
812
|
|
|
803
813
|
### HTTP request headers
|
|
804
814
|
|
|
805
|
-
- **Content-Type**:
|
|
815
|
+
- **Content-Type**: application/json
|
|
806
816
|
- **Accept**: application/json
|
|
807
817
|
|
|
808
818
|
|
|
@@ -932,6 +942,7 @@ const { status, data } = await apiInstance.patchAdminAgentsUpdate(
|
|
|
932
942
|
| Status code | Description | Response headers |
|
|
933
943
|
|-------------|-------------|------------------|
|
|
934
944
|
|**200** | Agent updated. | - |
|
|
945
|
+
|**400** | Invalid budgetPolicy: an unknown key, or a value that is not a number greater than zero. | - |
|
|
935
946
|
|**401** | Authentication required. | - |
|
|
936
947
|
|**403** | Admin privileges required. | - |
|
|
937
948
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -992,6 +1003,7 @@ const { status, data } = await apiInstance.putAdminAgentsUpdate(
|
|
|
992
1003
|
| Status code | Description | Response headers |
|
|
993
1004
|
|-------------|-------------|------------------|
|
|
994
1005
|
|**200** | Agent updated. | - |
|
|
1006
|
+
|**400** | Invalid budgetPolicy: an unknown key, or a value that is not a number greater than zero. | - |
|
|
995
1007
|
|**401** | Authentication required. | - |
|
|
996
1008
|
|**403** | Admin privileges required. | - |
|
|
997
1009
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **string** | Required. Human-readable agent name. | [optional] [default to undefined]
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**capabilities** | **Array<string>** | | [optional] [default to undefined]
|
|
11
|
+
**budgetPolicy** | **{ [key: string]: any; }** | The agent budget. Keys: max_api_calls_per_hour, max_api_calls_per_day, max_tokens_per_hour, max_tokens_per_day (whole numbers), max_cost_per_day_usd, max_cost_per_month_usd, hard_limit (USD), max_steps, timeout_seconds (whole numbers, read by the agent from UserInfo), and the gateway-only max_cost_usd, monthly_usd, max_budget (USD). Each value must be greater than zero; an unknown key or an invalid value is refused with 400. Leave it out for an agent without a budget. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: AdminAgentsCreateRequest = {
|
|
|
18
19
|
name,
|
|
19
20
|
description,
|
|
20
21
|
capabilities,
|
|
22
|
+
budgetPolicy,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -5,9 +5,12 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**retentionDays** | **number** |
|
|
9
|
-
**autoDelete** | **boolean** |
|
|
10
|
-
**planLimitDays** | **number** |
|
|
8
|
+
**retentionDays** | **number** | The organization\'s own period, between minRetentionDays and maxRetentionDays. It applies while data retention is on and autoDelete is not false. | [optional] [default to undefined]
|
|
9
|
+
**autoDelete** | **boolean** | false switches the organization\'s own period off; the plan\'s period still applies | [optional] [default to undefined]
|
|
10
|
+
**planLimitDays** | **number** | The plan\'s period: older entries are not returned and are deleted. null when the plan has no limit. | [optional] [default to undefined]
|
|
11
|
+
**effectiveRetentionDays** | **number** | How long entries are kept now; null when nothing is deleted | [optional] [default to undefined]
|
|
12
|
+
**minRetentionDays** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**maxRetentionDays** | **number** | | [optional] [default to undefined]
|
|
11
14
|
|
|
12
15
|
## Example
|
|
13
16
|
|
|
@@ -18,6 +21,9 @@ const instance: AdminAuditLogsRetentionResponseData = {
|
|
|
18
21
|
retentionDays,
|
|
19
22
|
autoDelete,
|
|
20
23
|
planLimitDays,
|
|
24
|
+
effectiveRetentionDays,
|
|
25
|
+
minRetentionDays,
|
|
26
|
+
maxRetentionDays,
|
|
21
27
|
};
|
|
22
28
|
```
|
|
23
29
|
|
|
@@ -6,7 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | **string** | | [default to undefined]
|
|
9
|
-
**idp_id** | **number** | SAML IdP config id (type=saml) | [optional] [default to undefined]
|
|
9
|
+
**idp_id** | **number** | SAML IdP config id (type=saml) or OpenID Connect connection id (type=oidc) | [optional] [default to undefined]
|
|
10
|
+
**subject** | **string** | Subject the OpenID Connect provider issues for this user (type=oidc) | [optional] [default to undefined]
|
|
10
11
|
**name_id** | **string** | NameID the IdP asserts for this user (type=saml) | [optional] [default to undefined]
|
|
11
12
|
**ldap_config_id** | **number** | LDAP directory id (type=ldap) | [optional] [default to undefined]
|
|
12
13
|
**dn** | **string** | Distinguished name (type=ldap); omitted = look up | [optional] [default to undefined]
|
|
@@ -20,6 +21,7 @@ import { AdminIdentitiesLinkRequest } from '@lumoauth/api-client';
|
|
|
20
21
|
const instance: AdminIdentitiesLinkRequest = {
|
|
21
22
|
type,
|
|
22
23
|
idp_id,
|
|
24
|
+
subject,
|
|
23
25
|
name_id,
|
|
24
26
|
ldap_config_id,
|
|
25
27
|
dn,
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**type** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**idp_id** | **number** | | [optional] [default to undefined]
|
|
10
10
|
**name_id** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**subject** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**legacy** | **boolean** | | [optional] [default to undefined]
|
|
12
13
|
**ldap_config_id** | **number** | | [optional] [default to undefined]
|
|
13
14
|
**dn** | **string** | | [optional] [default to undefined]
|
|
@@ -22,6 +23,7 @@ const instance: AdminIdentitiesListResponseDataBindingsItem = {
|
|
|
22
23
|
type,
|
|
23
24
|
idp_id,
|
|
24
25
|
name_id,
|
|
26
|
+
subject,
|
|
25
27
|
legacy,
|
|
26
28
|
ldap_config_id,
|
|
27
29
|
dn,
|
package/docs/AdminMcpApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
12
|
# **adminMcpServersCreate**
|
|
13
13
|
> AdminMcpServersCreateResponse adminMcpServersCreate()
|
|
14
14
|
|
|
15
|
-
Body:
|
|
15
|
+
Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -57,6 +57,7 @@ const { status, data } = await apiInstance.adminMcpServersCreate(
|
|
|
57
57
|
| Status code | Description | Response headers |
|
|
58
58
|
|-------------|-------------|------------------|
|
|
59
59
|
|**201** | MCP server created | - |
|
|
60
|
+
|**400** | Invalid resource_uri, or a field that cannot be set (include_scope_in_challenge, bearer_methods_supported) | - |
|
|
60
61
|
|**409** | An MCP server with this resource_uri already exists | - |
|
|
61
62
|
|**422** | validation_error | - |
|
|
62
63
|
|
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
18
18
|
|[**putAdminClientsUpdateBranding**](#putadminclientsupdatebranding) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Replace an OAuth client\'s login and/or consent page branding|
|
|
19
19
|
|[**rotateClientSecret**](#rotateclientsecret) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/rotate-secret | Rotate an OAuth client secret|
|
|
20
20
|
|[**setClientScopes**](#setclientscopes) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client|
|
|
21
|
-
|[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} |
|
|
21
|
+
|[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Update an OAuth client (same as PATCH: only the fields that are sent change)|
|
|
22
22
|
|
|
23
23
|
# **adminClientsCimdCheck**
|
|
24
24
|
> AdminClientsCimdCheckResponse adminClientsCimdCheck(adminClientsCimdCheckRequest)
|
|
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.createClient(
|
|
|
177
177
|
### HTTP response details
|
|
178
178
|
| Status code | Description | Response headers |
|
|
179
179
|
|-------------|-------------|------------------|
|
|
180
|
-
|**201** | Created
|
|
180
|
+
|**201** | Created. For a confidential client the plaintext secret is included once and never shown again; a public client (isConfidential false) has no secret and the field is absent | - |
|
|
181
181
|
|
|
182
182
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
183
183
|
|
package/docs/AdminSandboxApi.md
CHANGED
|
@@ -115,6 +115,7 @@ const { status, data } = await apiInstance.adminSandboxList(
|
|
|
115
115
|
# **adminSandboxSpawn**
|
|
116
116
|
> AdminSandboxSpawnResponse adminSandboxSpawn()
|
|
117
117
|
|
|
118
|
+
Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
118
119
|
|
|
119
120
|
### Example
|
|
120
121
|
|
|
@@ -162,7 +163,8 @@ const { status, data } = await apiInstance.adminSandboxSpawn(
|
|
|
162
163
|
### HTTP response details
|
|
163
164
|
| Status code | Description | Response headers |
|
|
164
165
|
|-------------|-------------|------------------|
|
|
165
|
-
|**201** | Sandbox created | - |
|
|
166
|
+
|**201** | Sandbox created. `data.api_key` is shown only once. | - |
|
|
167
|
+
|**403** | The organization lacks the Developer sandboxes add-on (`feature_not_in_plan`), or it is itself a sandbox | - |
|
|
166
168
|
|**429** | Per-owner active-sandbox cap reached | - |
|
|
167
169
|
|
|
168
170
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**data** | [**
|
|
8
|
+
**data** | [**AdminSandboxSpawnResponseData**](AdminSandboxSpawnResponseData.md) | | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# AdminSandboxSpawnResponseData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**slug** | **string** | | [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**created_at** | **string** | | [default to undefined]
|
|
11
|
+
**expires_at** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**owner_email** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**spawned_from** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**api_key** | **string** | API key of the sandbox, with every Admin API scope. Shown only in this response; it expires with the sandbox. | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { AdminSandboxSpawnResponseData } from '@lumoauth/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: AdminSandboxSpawnResponseData = {
|
|
22
|
+
slug,
|
|
23
|
+
name,
|
|
24
|
+
created_at,
|
|
25
|
+
expires_at,
|
|
26
|
+
owner_email,
|
|
27
|
+
spawned_from,
|
|
28
|
+
api_key,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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
|
+
# AdminSandboxSpawnResponseData1
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**api_key** | **string** | API key of the sandbox, with every Admin API scope. Shown only in this response; it expires with the sandbox. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AdminSandboxSpawnResponseData1 } from '@lumoauth/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: AdminSandboxSpawnResponseData1 = {
|
|
16
|
+
api_key,
|
|
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)
|
package/docs/AdminUsersApi.md
CHANGED
|
@@ -9,9 +9,9 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
9
9
|
|[**addUserRole**](#adduserrole) | **POST** /orgs/{orgId}/api/v1/admin/users/{userId}/roles | Assign a role to a user|
|
|
10
10
|
|[**adminIdentitiesLegacySamlRelink**](#adminidentitieslegacysamlrelink) | **POST** /orgs/{orgId}/api/v1/admin/identities/legacy-saml | Relink legacy SAML users to an IdP|
|
|
11
11
|
|[**adminIdentitiesLegacySamlReport**](#adminidentitieslegacysamlreport) | **GET** /orgs/{orgId}/api/v1/admin/identities/legacy-saml | Legacy SAML bindings report|
|
|
12
|
-
|[**adminIdentitiesLink**](#adminidentitieslink) | **POST** /orgs/{orgId}/api/v1/admin/users/{userId}/identities | Link a SAML or LDAP identity to a user|
|
|
12
|
+
|[**adminIdentitiesLink**](#adminidentitieslink) | **POST** /orgs/{orgId}/api/v1/admin/users/{userId}/identities | Link a SAML, OpenID Connect or LDAP identity to a user|
|
|
13
13
|
|[**adminIdentitiesList**](#adminidentitieslist) | **GET** /orgs/{orgId}/api/v1/admin/users/{userId}/identities | List a user\'s federated identity links|
|
|
14
|
-
|[**adminIdentitiesUnlink**](#adminidentitiesunlink) | **DELETE** /orgs/{orgId}/api/v1/admin/users/{userId}/identities/{type} | Unlink a user\'s SAML, LDAP or social identity|
|
|
14
|
+
|[**adminIdentitiesUnlink**](#adminidentitiesunlink) | **DELETE** /orgs/{orgId}/api/v1/admin/users/{userId}/identities/{type} | Unlink a user\'s SAML, OpenID Connect, LDAP or social identity|
|
|
15
15
|
|[**blockUser**](#blockuser) | **POST** /orgs/{orgId}/api/v1/admin/users/{userId}/block | Block a user|
|
|
16
16
|
|[**createUser**](#createuser) | **POST** /orgs/{orgId}/api/v1/admin/users | Create a user|
|
|
17
17
|
|[**deleteUser**](#deleteuser) | **DELETE** /orgs/{orgId}/api/v1/admin/users/{userId} | Delete a user|
|
|
@@ -310,7 +310,7 @@ const { status, data } = await apiInstance.adminIdentitiesLegacySamlReport(
|
|
|
310
310
|
# **adminIdentitiesLink**
|
|
311
311
|
> AdminAgentsGetResponse adminIdentitiesLink(adminIdentitiesLinkRequest)
|
|
312
312
|
|
|
313
|
-
Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
313
|
+
Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
314
314
|
|
|
315
315
|
### Example
|
|
316
316
|
|
|
@@ -363,7 +363,7 @@ const { status, data } = await apiInstance.adminIdentitiesLink(
|
|
|
363
363
|
|-------------|-------------|------------------|
|
|
364
364
|
|**201** | Linked | - |
|
|
365
365
|
|**403** | Actor does not outrank the user, or step_up_required | - |
|
|
366
|
-
|**404** | User,
|
|
366
|
+
|**404** | User, identity provider or directory not found | - |
|
|
367
367
|
|**409** | identity_conflict | - |
|
|
368
368
|
|**422** | invalid_identity / directory_lookup_failed | - |
|
|
369
369
|
|
|
@@ -372,7 +372,7 @@ const { status, data } = await apiInstance.adminIdentitiesLink(
|
|
|
372
372
|
# **adminIdentitiesList**
|
|
373
373
|
> AdminIdentitiesListResponse adminIdentitiesList()
|
|
374
374
|
|
|
375
|
-
SAML (IdP + NameID), LDAP (directory + DN)
|
|
375
|
+
SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
376
376
|
|
|
377
377
|
### Example
|
|
378
378
|
|
|
@@ -427,7 +427,7 @@ const { status, data } = await apiInstance.adminIdentitiesList(
|
|
|
427
427
|
# **adminIdentitiesUnlink**
|
|
428
428
|
> AdminAgentsGetResponse adminIdentitiesUnlink()
|
|
429
429
|
|
|
430
|
-
Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
430
|
+
Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
431
431
|
|
|
432
432
|
### Example
|
|
433
433
|
|
|
@@ -440,7 +440,7 @@ import {
|
|
|
440
440
|
const configuration = new Configuration();
|
|
441
441
|
const apiInstance = new AdminUsersApi(configuration);
|
|
442
442
|
|
|
443
|
-
let type: 'saml' | 'ldap' | 'social'; // (default to undefined)
|
|
443
|
+
let type: 'saml' | 'oidc' | 'ldap' | 'social'; // (default to undefined)
|
|
444
444
|
let orgId: string; // (default to undefined)
|
|
445
445
|
let userId: string; // (default to undefined)
|
|
446
446
|
|
|
@@ -455,7 +455,7 @@ const { status, data } = await apiInstance.adminIdentitiesUnlink(
|
|
|
455
455
|
|
|
456
456
|
|Name | Type | Description | Notes|
|
|
457
457
|
|------------- | ------------- | ------------- | -------------|
|
|
458
|
-
| **type** | [**'saml' | 'ldap' | 'social'**]**Array<'saml' | 'ldap' | 'social'>** | | defaults to undefined|
|
|
458
|
+
| **type** | [**'saml' | 'oidc' | 'ldap' | 'social'**]**Array<'saml' | 'oidc' | 'ldap' | 'social'>** | | defaults to undefined|
|
|
459
459
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
460
460
|
| **userId** | [**string**] | | defaults to undefined|
|
|
461
461
|
|
package/docs/AdminWebhooksApi.md
CHANGED
|
@@ -25,7 +25,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
25
25
|
# **adminWebhooksCreate**
|
|
26
26
|
> AdminWebhooksCreateResponse adminWebhooksCreate()
|
|
27
27
|
|
|
28
|
-
The signing secret is generated server-side and returned once in this response only.
|
|
28
|
+
Accepts `url`, `events`, `isActive` (also as `active` or `enabled`), `type` and `configuration`. The signing secret is generated server-side and returned once in this response only: a `secret` in the request, an unknown field and an event name that is not in the catalogue are refused with 400.
|
|
29
29
|
|
|
30
30
|
### Example
|
|
31
31
|
|
|
@@ -185,7 +185,7 @@ const { status, data } = await apiInstance.adminWebhooksDeliveriesList(
|
|
|
185
185
|
# **adminWebhooksDeliveryReplay**
|
|
186
186
|
> AdminWebhooksDeliveryReplayResponse adminWebhooksDeliveryReplay()
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
Queues a new delivery with the same event and payload and returns its id. The original delivery is not changed. A disabled webhook sends nothing, so the call answers 409 until the webhook is enabled.
|
|
189
189
|
|
|
190
190
|
### Example
|
|
191
191
|
|
|
@@ -235,8 +235,9 @@ const { status, data } = await apiInstance.adminWebhooksDeliveryReplay(
|
|
|
235
235
|
### HTTP response details
|
|
236
236
|
| Status code | Description | Response headers |
|
|
237
237
|
|-------------|-------------|------------------|
|
|
238
|
-
|**200** |
|
|
238
|
+
|**200** | Replay queued | - |
|
|
239
239
|
|**404** | Webhook or delivery not found | - |
|
|
240
|
+
|**409** | The webhook is disabled | - |
|
|
240
241
|
|
|
241
242
|
[[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)
|
|
242
243
|
|
|
@@ -456,7 +457,7 @@ const { status, data } = await apiInstance.adminWebhooksList(
|
|
|
456
457
|
# **adminWebhooksRotateSecret**
|
|
457
458
|
> AdminWebhooksRotateSecretResponse adminWebhooksRotateSecret()
|
|
458
459
|
|
|
459
|
-
Generates a new HMAC secret and
|
|
460
|
+
Generates a new HMAC secret and returns it once. For 24 hours every delivery also carries `X-LumoAuth-Signature-Previous`, signed with the secret that was replaced, so the receiver can be updated without losing events. The `kid` of `X-LumoAuth-Signature` changes with every rotation.
|
|
460
461
|
|
|
461
462
|
### Example
|
|
462
463
|
|
|
@@ -511,7 +512,7 @@ const { status, data } = await apiInstance.adminWebhooksRotateSecret(
|
|
|
511
512
|
# **adminWebhooksTest**
|
|
512
513
|
> AdminWebhooksTestResponse adminWebhooksTest()
|
|
513
514
|
|
|
514
|
-
|
|
515
|
+
Sends one `webhook.test` event to the webhook URL now, with the same body, headers and signature as any event, and records it in the delivery history. A receiver answer outside 2xx still yields HTTP 200 with `success: false`; when no answer was received (connection or TLS error) the endpoint answers 502. A failed test is not retried.
|
|
515
516
|
|
|
516
517
|
### Example
|
|
517
518
|
|
|
@@ -892,6 +893,7 @@ const { status, data } = await apiInstance.patchAdminWebhooksUpdate(
|
|
|
892
893
|
# **putAdminWebhooksUpdate**
|
|
893
894
|
> PutAdminWebhooksUpdateResponse putAdminWebhooksUpdate()
|
|
894
895
|
|
|
896
|
+
Changes only the fields that are sent: `url`, `events`, `isActive` (also as `active` or `enabled`), `type`, `configuration`, `rotateSecret`. A new `url` for a webhook that has a signing secret needs `rotateSecret: true`; the response then carries the new `secret` once. Unknown fields, `secret` and event names that are not in the catalogue are refused with 400.
|
|
895
897
|
|
|
896
898
|
### Example
|
|
897
899
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**data** | [**
|
|
8
|
+
**data** | [**AdminWebhooksDeliveryReplayResponseData**](AdminWebhooksDeliveryReplayResponseData.md) | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# AdminWebhooksDeliveryReplayResponseData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**delivery_id** | **string** | Id of the new delivery | [optional] [default to undefined]
|
|
9
|
+
**replay_of** | **string** | Id of the delivery that was replayed | [optional] [default to undefined]
|
|
10
|
+
**webhook_id** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**event_name** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**status** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { AdminWebhooksDeliveryReplayResponseData } from '@lumoauth/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: AdminWebhooksDeliveryReplayResponseData = {
|
|
20
|
+
delivery_id,
|
|
21
|
+
replay_of,
|
|
22
|
+
webhook_id,
|
|
23
|
+
event_name,
|
|
24
|
+
status,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**success** | **boolean** | | [optional] [default to undefined]
|
|
9
9
|
**statusCode** | **number** | HTTP status returned by the receiver | [optional] [default to undefined]
|
|
10
|
+
**deliveryId** | **string** | Id of the delivery row (the `X-LumoAuth-Delivery` header of the request) | [optional] [default to undefined]
|
|
10
11
|
**message** | **string** | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
@@ -17,6 +18,7 @@ import { AdminWebhooksTestResponse } from '@lumoauth/api-client';
|
|
|
17
18
|
const instance: AdminWebhooksTestResponse = {
|
|
18
19
|
success,
|
|
19
20
|
statusCode,
|
|
21
|
+
deliveryId,
|
|
20
22
|
message,
|
|
21
23
|
};
|
|
22
24
|
```
|