@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
package/docs/AgentsApi.md
CHANGED
|
@@ -68,7 +68,8 @@ const { status, data } = await apiInstance.ask(
|
|
|
68
68
|
|-------------|-------------|------------------|
|
|
69
69
|
|**200** | Authorization decision for the requested action. | - |
|
|
70
70
|
|**400** | Missing required field: action. | - |
|
|
71
|
-
|**
|
|
71
|
+
|**403** | plan_limit_reached: the Ask API calls that the plan includes for this month are used (plans without overage only). | - |
|
|
72
|
+
|**429** | budget_exceeded: the agent budget is spent. Retry-After holds the seconds until the spent window starts again. | - |
|
|
72
73
|
|
|
73
74
|
[[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)
|
|
74
75
|
|
|
@@ -190,6 +191,7 @@ const { status, data } = await apiInstance.authorizeMcp(
|
|
|
190
191
|
|**403** | Denied — no matching per-tool or server-wide grant. | - |
|
|
191
192
|
|**400** | server_id and tool are required, or contain forbidden characters, or are too long together. | - |
|
|
192
193
|
|**404** | unknown_server — server_id is not an active MCP server of this organization. | - |
|
|
194
|
+
|**429** | budget_exceeded: the agent budget is spent. Retry-After holds the seconds until the spent window starts again. | - |
|
|
193
195
|
|
|
194
196
|
[[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)
|
|
195
197
|
|
|
@@ -246,7 +248,7 @@ const { status, data } = await apiInstance.createApproval(
|
|
|
246
248
|
|**201** | Approval request created and push sent. | - |
|
|
247
249
|
|**202** | User has no push device; an email sign-in fallback link was sent. | - |
|
|
248
250
|
|**400** | Invalid JSON, task_id, reason, impact, or missing on_behalf_of. | - |
|
|
249
|
-
|**403** | Caller is not an agent, is cross-tenant, or lacks delegation permission. | - |
|
|
251
|
+
|**403** | Caller is not an agent, is cross-tenant, presents a scope-narrowed token (insufficient_scope), or lacks delegation permission. | - |
|
|
250
252
|
|**404** | Tenant or target user not found. | - |
|
|
251
253
|
|**428** | User has no enrolled push device and the email fallback could not be sent. | - |
|
|
252
254
|
|**429** | Rate limited (per tenant/agent/user). | - |
|
|
@@ -305,6 +307,7 @@ No authorization required
|
|
|
305
307
|
|-------------|-------------|------------------|
|
|
306
308
|
|**200** | The A2A AgentCard with a detached JWS signature over its JCS-canonical content (signatures[].protected + signature, verifiable against this organization\'s JWKS). | - |
|
|
307
309
|
|**404** | not_found — unknown organization, or the agent is unknown, inactive or has no published A2A card. | - |
|
|
310
|
+
|**429** | rate_limited — too many card requests from this address (Retry-After). | - |
|
|
308
311
|
|
|
309
312
|
[[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)
|
|
310
313
|
|
|
@@ -518,7 +521,7 @@ const { status, data } = await apiInstance.reportAgentUsage(
|
|
|
518
521
|
|-------------|-------------|------------------|
|
|
519
522
|
|**200** | Recorded. `budget` has the same shape as `budget_policy` in UserInfo; `exhausted: true` means that the next metered call gets 429. | - |
|
|
520
523
|
|**400** | invalid_request: tokens or cost_usd is missing, negative, too large or not a number. | - |
|
|
521
|
-
|**403** | test_token_not_accepted or
|
|
524
|
+
|**403** | test_token_not_accepted, cross_tenant or insufficient_scope (the token was narrowed with a scope). | - |
|
|
522
525
|
|**429** | rate_limited: too many reports from this agent. | - |
|
|
523
526
|
|
|
524
527
|
[[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)
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**provider** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**subject** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**issuer** | **string** | | [optional] [default to undefined]
|
|
12
|
-
**audience_generic** | **boolean** | True when the registered audience is not specific to
|
|
12
|
+
**audience_generic** | **boolean** | True when the registered audience is not specific to LumoAuth (move to the agent-specific audience). | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/AuditLogEntry.md
CHANGED
|
@@ -27,7 +27,7 @@ Name | Type | Description | Notes
|
|
|
27
27
|
**geoLocation** | **{ [key: string]: any; }** | Detailed responses only | [optional] [default to undefined]
|
|
28
28
|
**sessionId** | **string** | Detailed responses only | [optional] [default to undefined]
|
|
29
29
|
**requestId** | **string** | Detailed responses only | [optional] [default to undefined]
|
|
30
|
-
**status** | **string** |
|
|
30
|
+
**status** | **string** | Result of the event: success, failure, pending or partial | [optional] [default to undefined]
|
|
31
31
|
**statusReason** | **string** | Detailed responses only | [optional] [default to undefined]
|
|
32
32
|
**oldValue** | **{ [key: string]: any; }** | Detailed responses only | [optional] [default to undefined]
|
|
33
33
|
**newValue** | **{ [key: string]: any; }** | Detailed responses only | [optional] [default to undefined]
|
|
@@ -7,7 +7,6 @@ Authentication settings (entity defaults merged with the stored values). Any oth
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**passkey_enabled** | **boolean** | | [optional] [default to undefined]
|
|
10
|
-
**biometric_enabled** | **boolean** | | [optional] [default to undefined]
|
|
11
10
|
**passkeys** | [**AuthenticationSettingsPasskeys**](AuthenticationSettingsPasskeys.md) | | [optional] [default to undefined]
|
|
12
11
|
**mfa_required** | **boolean** | | [optional] [default to undefined]
|
|
13
12
|
**mfa_methods** | **Array<string>** | | [optional] [default to undefined]
|
|
@@ -15,7 +14,7 @@ Name | Type | Description | Notes
|
|
|
15
14
|
**mfa_policy** | [**AuthenticationSettingsMfaPolicy**](AuthenticationSettingsMfaPolicy.md) | | [optional] [default to undefined]
|
|
16
15
|
**push_auth_required** | **boolean** | | [optional] [default to undefined]
|
|
17
16
|
**push_app_name** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**social_login_enabled** | **boolean** |
|
|
17
|
+
**social_login_enabled** | **boolean** | Legacy. Switches on the older social sign-in flow that uses social_configs and social_providers. Social sign-in on the hosted sign-in page follows the enabled social providers, not this flag. | [optional] [default to undefined]
|
|
19
18
|
**social_providers** | **Array<string>** | | [optional] [default to undefined]
|
|
20
19
|
**social_configs** | **{ [key: string]: { [key: string]: any; }; }** | Per-provider OAuth credentials keyed by provider (google, github, microsoft, facebook, apple, linkedin). Each value is a free-form object of provider fields (client_id, hosted_domain, tenant_id, team_id, key_id, ...); the secret fields client_secret and private_key are returned as the redaction marker {\"configured\": true, \"redacted\": true} when set, null otherwise. | [optional] [default to undefined]
|
|
21
20
|
**password_min_length** | **number** | Legacy; mirrored by password_policy.min_length. | [optional] [default to undefined]
|
|
@@ -23,8 +22,7 @@ Name | Type | Description | Notes
|
|
|
23
22
|
**password_policy** | [**AuthenticationSettingsPasswordPolicy**](AuthenticationSettingsPasswordPolicy.md) | | [optional] [default to undefined]
|
|
24
23
|
**password_rotation_policy** | [**AuthenticationSettingsPasswordRotationPolicy**](AuthenticationSettingsPasswordRotationPolicy.md) | | [optional] [default to undefined]
|
|
25
24
|
**no_mfa_action** | **string** | | [optional] [default to undefined]
|
|
26
|
-
**session_timeout** | **number** |
|
|
27
|
-
**encrypt_client_secrets** | **boolean** | | [optional] [default to undefined]
|
|
25
|
+
**session_timeout** | **number** | Idle timeout in seconds. | [optional] [default to undefined]
|
|
28
26
|
**dynamic_client_registration_enabled** | **boolean** | | [optional] [default to undefined]
|
|
29
27
|
**cimd_enabled** | **boolean** | Accept Client ID Metadata Documents (an https URL as client_id). On by default on every plan; set false to opt the organization out. | [optional] [default to true]
|
|
30
28
|
**cimd_allowed_domains** | **Array<string>** | | [optional] [default to undefined]
|
|
@@ -40,7 +38,6 @@ import { AuthenticationSettings } from '@lumoauth/api-client';
|
|
|
40
38
|
|
|
41
39
|
const instance: AuthenticationSettings = {
|
|
42
40
|
passkey_enabled,
|
|
43
|
-
biometric_enabled,
|
|
44
41
|
passkeys,
|
|
45
42
|
mfa_required,
|
|
46
43
|
mfa_methods,
|
|
@@ -57,7 +54,6 @@ const instance: AuthenticationSettings = {
|
|
|
57
54
|
password_rotation_policy,
|
|
58
55
|
no_mfa_action,
|
|
59
56
|
session_timeout,
|
|
60
|
-
encrypt_client_secrets,
|
|
61
57
|
dynamic_client_registration_enabled,
|
|
62
58
|
cimd_enabled,
|
|
63
59
|
cimd_allowed_domains,
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# AuthenticationSettingsPasswordPolicy
|
|
2
2
|
|
|
3
|
+
The password rules that apply. A write is merged with the stored object. A named template sets its own rules; rules sent without a template make the policy custom.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
@@ -10,6 +11,10 @@ Name | Type | Description | Notes
|
|
|
10
11
|
**require_special** | **boolean** | | [optional] [default to undefined]
|
|
11
12
|
**require_numbers** | **boolean** | | [optional] [default to undefined]
|
|
12
13
|
**require_uppercase** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
**require_lowercase** | **boolean** | | [optional] [default to undefined]
|
|
15
|
+
**reject_breached_passwords** | **boolean** | | [optional] [default to undefined]
|
|
16
|
+
**breached_password_min_count** | **number** | | [optional] [default to undefined]
|
|
17
|
+
**check_breached_on_login** | **boolean** | | [optional] [default to undefined]
|
|
13
18
|
|
|
14
19
|
## Example
|
|
15
20
|
|
|
@@ -22,6 +27,10 @@ const instance: AuthenticationSettingsPasswordPolicy = {
|
|
|
22
27
|
require_special,
|
|
23
28
|
require_numbers,
|
|
24
29
|
require_uppercase,
|
|
30
|
+
require_lowercase,
|
|
31
|
+
reject_breached_passwords,
|
|
32
|
+
breached_password_min_count,
|
|
33
|
+
check_breached_on_login,
|
|
25
34
|
};
|
|
26
35
|
```
|
|
27
36
|
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# AuthenticationSettingsPasswordRotationPolicy
|
|
2
2
|
|
|
3
|
+
A write is merged with the stored object.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
@@ -7,8 +8,6 @@ Name | Type | Description | Notes
|
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
9
|
**enabled** | **boolean** | | [optional] [default to undefined]
|
|
9
10
|
**max_age_days** | **number** | | [optional] [default to undefined]
|
|
10
|
-
**notify_before_days** | **number** | | [optional] [default to undefined]
|
|
11
|
-
**history_count** | **number** | | [optional] [default to undefined]
|
|
12
11
|
|
|
13
12
|
## Example
|
|
14
13
|
|
|
@@ -18,8 +17,6 @@ import { AuthenticationSettingsPasswordRotationPolicy } from '@lumoauth/api-clie
|
|
|
18
17
|
const instance: AuthenticationSettingsPasswordRotationPolicy = {
|
|
19
18
|
enabled,
|
|
20
19
|
max_age_days,
|
|
21
|
-
notify_before_days,
|
|
22
|
-
history_count,
|
|
23
20
|
};
|
|
24
21
|
```
|
|
25
22
|
|
package/docs/AuthorizationApi.md
CHANGED
|
@@ -796,7 +796,7 @@ This endpoint does not have any parameters.
|
|
|
796
796
|
### HTTP response details
|
|
797
797
|
| Status code | Description | Response headers |
|
|
798
798
|
|-------------|-------------|------------------|
|
|
799
|
-
|**200** | Permissions from the user\'s roles (including group-inherited roles). `permissions` and `data` are identical. | - |
|
|
799
|
+
|**200** | Permissions from the user\'s roles (including group-inherited roles) and permissions granted to the user directly. `permissions` and `data` are identical. | - |
|
|
800
800
|
|
|
801
801
|
[[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)
|
|
802
802
|
|
|
@@ -16,7 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**redirectUris** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
17
17
|
**scopes** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
18
18
|
**grantTypes** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
19
|
-
**
|
|
19
|
+
**cibaEnabled** | **boolean** | Detailed responses only. Whether the client may use CIBA (backchannel authentication). | [optional] [default to undefined]
|
|
20
|
+
**secret** | **string** | Plaintext client secret — returned only once, never retrievable again. Absent for a public client | [optional] [default to undefined]
|
|
20
21
|
**_note** | **string** | | [optional] [default to undefined]
|
|
21
22
|
|
|
22
23
|
## Example
|
|
@@ -36,6 +37,7 @@ const instance: CreateClientResponseData = {
|
|
|
36
37
|
redirectUris,
|
|
37
38
|
scopes,
|
|
38
39
|
grantTypes,
|
|
40
|
+
cibaEnabled,
|
|
39
41
|
secret,
|
|
40
42
|
_note,
|
|
41
43
|
};
|
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**resend_after** | **number** | Seconds until a new code may be requested | [optional] [default to undefined]
|
|
17
17
|
**masked_email** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**deep_link** | **string** | https://<server>/push-auth/enroll?d=… — an Android App Link / iOS Universal Link that opens the authenticator app on a phone (falls back to a help page without it). | [optional] [default to undefined]
|
|
19
|
-
**deep_link_android** | **string** | Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when
|
|
19
|
+
**deep_link_android** | **string** | Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when it is not available. | [optional] [default to undefined]
|
|
20
20
|
**activation_code** | **string** | | [optional] [default to undefined]
|
|
21
21
|
**public_key** | **object** | WebAuthn PublicKeyCredentialCreationOptions | [optional] [default to undefined]
|
|
22
22
|
|
package/docs/JitApi.md
CHANGED
|
@@ -304,7 +304,7 @@ const { status, data } = await apiInstance.evaluateTask(
|
|
|
304
304
|
|-------------|-------------|------------------|
|
|
305
305
|
|**200** | Continuous access evaluation (CAEP) result for the task. | - |
|
|
306
306
|
|**401** | Authentication required. | - |
|
|
307
|
-
|**403** |
|
|
307
|
+
|**403** | The caller is not a user of this organization with the `jit.approve` permission. | - |
|
|
308
308
|
|**404** | Tenant or task not found. | - |
|
|
309
309
|
|
|
310
310
|
[[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)
|
|
@@ -421,7 +421,7 @@ const { status, data } = await apiInstance.getRequestToken(
|
|
|
421
421
|
|**401** | Invalid or missing agent token. | - |
|
|
422
422
|
|**403** | Request belongs to a different agent, is not yet approved, is no longer redeemable (expired window, ended task, inactive agent/organization), or a JIT token was used. | - |
|
|
423
423
|
|**404** | Tenant or request not found. | - |
|
|
424
|
-
|**429** |
|
|
424
|
+
|**429** | rate_limit_exceeded, or budget_exceeded when the agent budget is spent (Retry-After holds the seconds until the spent window starts again). | - |
|
|
425
425
|
|
|
426
426
|
[[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)
|
|
427
427
|
|
|
@@ -532,7 +532,7 @@ const { status, data } = await apiInstance.requestPermission(
|
|
|
532
532
|
|**201** | Permission request created (auto-approved for low risk, otherwise pending HITL). | - |
|
|
533
533
|
|**400** | Missing/invalid task_id, authorization_details, or the task is not active. | - |
|
|
534
534
|
|**401** | Invalid or missing agent token. | - |
|
|
535
|
-
|**403** | Task belongs to a different agent. | - |
|
|
535
|
+
|**403** | Task belongs to a different agent, or task_suspended: continuous access evaluation suspended the task on this request. | - |
|
|
536
536
|
|**404** | Tenant or task not found. | - |
|
|
537
537
|
|**429** | Rate limit exceeded. | - |
|
|
538
538
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**slug** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**source** | **string** | role:<role name> that grants it | [optional] [default to undefined]
|
|
10
|
+
**source** | **string** | role:<role name> that grants it, or direct for a permission granted to the user directly | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/OAuthApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
13
13
|
|[**introspect**](#introspect) | **POST** /orgs/{orgId}/api/v1/oauth/introspect | Token introspection (RFC 7662)|
|
|
14
14
|
|[**par**](#par) | **POST** /orgs/{orgId}/api/v1/oauth/par | Pushed authorization request (RFC 9126)|
|
|
15
15
|
|[**registerClient**](#registerclient) | **POST** /orgs/{orgId}/api/v1/connect/register | Dynamic client registration (RFC 7591 / OIDC DCR)|
|
|
16
|
+
|[**requestMagicLink**](#requestmagiclink) | **POST** /orgs/{orgId}/api/v1/oauth/magic-link | Request a sign-in link by email|
|
|
16
17
|
|[**revoke**](#revoke) | **POST** /orgs/{orgId}/api/v1/oauth/revoke | Token revocation (RFC 7009)|
|
|
17
18
|
|[**socialCallback**](#socialcallback) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback|
|
|
18
19
|
|[**socialCallbackPost**](#socialcallbackpost) | **POST** /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback (form_post)|
|
|
@@ -450,7 +451,7 @@ const { status, data } = await apiInstance.par(
|
|
|
450
451
|
| Status code | Description | Response headers |
|
|
451
452
|
|-------------|-------------|------------------|
|
|
452
453
|
|**201** | Pushed authorization request created (RFC 9126 §2.2). | - |
|
|
453
|
-
|**400** | invalid_request / invalid_target / invalid_request_object, or the
|
|
454
|
+
|**400** | invalid_request / invalid_target / invalid_request_object, or the organization is unknown. | - |
|
|
454
455
|
|**401** | invalid_client — client authentication failed. | - |
|
|
455
456
|
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
456
457
|
|
|
@@ -511,6 +512,65 @@ const { status, data } = await apiInstance.registerClient(
|
|
|
511
512
|
|
|
512
513
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
513
514
|
|
|
515
|
+
# **requestMagicLink**
|
|
516
|
+
> RequestMagicLinkResponse requestMagicLink(requestMagicLinkRequest)
|
|
517
|
+
|
|
518
|
+
For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
519
|
+
|
|
520
|
+
### Example
|
|
521
|
+
|
|
522
|
+
```typescript
|
|
523
|
+
import {
|
|
524
|
+
OAuthApi,
|
|
525
|
+
Configuration,
|
|
526
|
+
RequestMagicLinkRequest
|
|
527
|
+
} from '@lumoauth/api-client';
|
|
528
|
+
|
|
529
|
+
const configuration = new Configuration();
|
|
530
|
+
const apiInstance = new OAuthApi(configuration);
|
|
531
|
+
|
|
532
|
+
let orgId: string; // (default to undefined)
|
|
533
|
+
let requestMagicLinkRequest: RequestMagicLinkRequest; //
|
|
534
|
+
|
|
535
|
+
const { status, data } = await apiInstance.requestMagicLink(
|
|
536
|
+
orgId,
|
|
537
|
+
requestMagicLinkRequest
|
|
538
|
+
);
|
|
539
|
+
```
|
|
540
|
+
|
|
541
|
+
### Parameters
|
|
542
|
+
|
|
543
|
+
|Name | Type | Description | Notes|
|
|
544
|
+
|------------- | ------------- | ------------- | -------------|
|
|
545
|
+
| **requestMagicLinkRequest** | **RequestMagicLinkRequest**| | |
|
|
546
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
### Return type
|
|
550
|
+
|
|
551
|
+
**RequestMagicLinkResponse**
|
|
552
|
+
|
|
553
|
+
### Authorization
|
|
554
|
+
|
|
555
|
+
No authorization required
|
|
556
|
+
|
|
557
|
+
### HTTP request headers
|
|
558
|
+
|
|
559
|
+
- **Content-Type**: application/json
|
|
560
|
+
- **Accept**: application/json
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
### HTTP response details
|
|
564
|
+
| Status code | Description | Response headers |
|
|
565
|
+
|-------------|-------------|------------------|
|
|
566
|
+
|**200** | The request was accepted. The answer is the same whether or not the address belongs to an account. | - |
|
|
567
|
+
|**400** | `{\"error\": …, \"message\": …}` with error `invalid_request`, `invalid_client`, `invalid_return_to`, `captcha_required` or `captcha_failed`. | - |
|
|
568
|
+
|**403** | `{\"error\":\"origin_not_allowed\"}`: the page that made the request is not one of the application\'s allowed origins. | - |
|
|
569
|
+
|**404** | `{\"error\":\"not_found\"}` for an unknown organization, `{\"error\":\"magic_link_disabled\"}` when the organization does not offer sign-in links. | - |
|
|
570
|
+
|**429** | `{\"error\":\"rate_limited\"}`. | - |
|
|
571
|
+
|
|
572
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
573
|
+
|
|
514
574
|
# **revoke**
|
|
515
575
|
> object revoke()
|
|
516
576
|
|
|
@@ -885,7 +945,7 @@ No authorization required
|
|
|
885
945
|
|**200** | Signed in (status=complete — continue to /oauth/authorize) or a second factor is required (status=mfa_required with the challenge page URL). | - |
|
|
886
946
|
|**400** | {\"status\":\"invalid_request\"} or {\"status\":\"captcha_required\",\"message\":…}. | - |
|
|
887
947
|
|**401** | {\"status\":\"invalid_credentials\"}. | - |
|
|
888
|
-
|**403** | {\"status\":\"blocked\"} or {\"status\":\"inactive\"}. | - |
|
|
948
|
+
|**403** | {\"status\":\"blocked\"} or {\"status\":\"inactive\"}; {\"status\":\"sso_required\",\"redirect_url\":…} for an administrator of an organization that requires single sign-on for administrators. | - |
|
|
889
949
|
|**404** | {\"status\":\"not_found\"} — unknown or inactive organization. | - |
|
|
890
950
|
|**429** | {\"status\":\"rate_limited\"}. | - |
|
|
891
951
|
|
|
@@ -994,6 +1054,7 @@ const { status, data } = await apiInstance.token(
|
|
|
994
1054
|
|**200** | Token response (RFC 6749 §5.1). Which optional members are present depends on the grant: refresh_token only when the client may use the refresh_token grant; id_token for authorization_code / CIBA / device grants with the openid scope; issued_token_type for token exchange (including ID-JAG and Txn-Token, whose token_type is N_A and which carry no scope unless scopes were granted); authorization_details, jit_request_id and task_id only for agent-initiated CIBA. Always sent with Cache-Control: no-store. | * DPoP-Nonce - Fresh server nonce when the request carried a DPoP proof (RFC 9449 §8). <br> |
|
|
995
1055
|
|**400** | invalid_request / invalid_grant / unsupported_grant_type / invalid_scope (RFC 6749 §5.2). | - |
|
|
996
1056
|
|**401** | invalid_client — client authentication failed. | - |
|
|
1057
|
+
|**403** | plan_limit_reached — the month\'s included machine-to-machine tokens or active agents are used on a plan without overage; error_description says which. | - |
|
|
997
1058
|
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
998
1059
|
|
|
999
1060
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
package/docs/OAuthClient.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**redirectUris** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
17
17
|
**scopes** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
18
18
|
**grantTypes** | **Array<string>** | Detailed responses only | [optional] [default to undefined]
|
|
19
|
+
**cibaEnabled** | **boolean** | Detailed responses only. Whether the client may use CIBA (backchannel authentication). | [optional] [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -34,6 +35,7 @@ const instance: OAuthClient = {
|
|
|
34
35
|
redirectUris,
|
|
35
36
|
scopes,
|
|
36
37
|
grantTypes,
|
|
38
|
+
cibaEnabled,
|
|
37
39
|
};
|
|
38
40
|
```
|
|
39
41
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**secret** | **string** | Plaintext client secret — returned only once, never retrievable again | [optional] [default to undefined]
|
|
8
|
+
**secret** | **string** | Plaintext client secret — returned only once, never retrievable again. Absent for a public client | [optional] [default to undefined]
|
|
9
9
|
**_note** | **string** | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**state** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**qr_data_uri** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**deep_link** | **string** | https://<server>/push-auth/enroll?d=… — an Android App Link / iOS Universal Link that opens the authenticator app on a phone (falls back to a help page without it). | [optional] [default to undefined]
|
|
12
|
-
**deep_link_android** | **string** | Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when
|
|
12
|
+
**deep_link_android** | **string** | Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when it is not available. | [optional] [default to undefined]
|
|
13
13
|
**activation_code** | **string** | | [optional] [default to undefined]
|
|
14
14
|
**expires_at** | **string** | | [optional] [default to undefined]
|
|
15
15
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**capabilities** | **Array<string>** | | [optional] [default to undefined]
|
|
11
|
+
**budgetPolicy** | **{ [key: string]: any; }** | The agent budget. Keys: max_api_calls_per_hour, max_api_calls_per_day, max_tokens_per_hour, max_tokens_per_day (whole numbers), max_cost_per_day_usd, max_cost_per_month_usd, hard_limit (USD), max_steps, timeout_seconds (whole numbers, read by the agent from UserInfo), and the gateway-only max_cost_usd, monthly_usd, max_budget (USD). Each value must be greater than zero; an unknown key or an invalid value is refused with 400. An update replaces the whole policy; {} or null removes the budget, and a request without the field leaves it as it is. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: PutAdminAgentsUpdateRequest = {
|
|
|
18
19
|
name,
|
|
19
20
|
description,
|
|
20
21
|
capabilities,
|
|
22
|
+
budgetPolicy,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# RequestMagicLinkRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | The address to mail the sign-in link to. | [default to undefined]
|
|
9
|
+
**client_id** | **string** | Client ID of an active application of the organization. | [default to undefined]
|
|
10
|
+
**return_to** | **string** | Page of the application that the person goes to after signing in. An absolute https URL (http only on localhost) whose origin is one of the application\'s allowed origins or the origin of one of its redirect URIs. Without it the person goes to the organization\'s default page. | [optional] [default to undefined]
|
|
11
|
+
**captcha_token** | **string** | Token from the CAPTCHA widget. Required when the organization protects sign-in link requests with a CAPTCHA. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { RequestMagicLinkRequest } from '@lumoauth/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: RequestMagicLinkRequest = {
|
|
19
|
+
email,
|
|
20
|
+
client_id,
|
|
21
|
+
return_to,
|
|
22
|
+
captcha_token,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RequestMagicLinkResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { RequestMagicLinkResponse } from '@lumoauth/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: RequestMagicLinkResponse = {
|
|
16
|
+
status,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -16,7 +16,6 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**allow_user_deletion** | **boolean** | | [optional] [default to undefined]
|
|
17
17
|
**allow_group_operations** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**protected_attributes** | [**ScimSettingsInboundProtectedAttributes**](ScimSettingsInboundProtectedAttributes.md) | | [optional] [default to undefined]
|
|
19
|
-
**attribute_mapping** | **{ [key: string]: string; }** | SCIM attribute => user field. | [optional] [default to undefined]
|
|
20
19
|
**auto_activate_users** | **boolean** | | [optional] [default to undefined]
|
|
21
20
|
**deprovisioning_action** | **string** | | [optional] [default to undefined]
|
|
22
21
|
|
|
@@ -36,7 +35,6 @@ const instance: ScimSettingsInbound = {
|
|
|
36
35
|
allow_user_deletion,
|
|
37
36
|
allow_group_operations,
|
|
38
37
|
protected_attributes,
|
|
39
|
-
attribute_mapping,
|
|
40
38
|
auto_activate_users,
|
|
41
39
|
deprovisioning_action,
|
|
42
40
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ScimSettingsInboundProtectedAttributes
|
|
2
2
|
|
|
3
|
-
Attribute name => true when SCIM may not change it.
|
|
3
|
+
Attribute name => true when SCIM may not change it. role_membership stops every /Groups request that would add or remove a member of a role.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
@@ -9,8 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**email** | **boolean** | | [optional] [default to undefined]
|
|
10
10
|
**name** | **boolean** | | [optional] [default to undefined]
|
|
11
11
|
**active** | **boolean** | | [optional] [default to undefined]
|
|
12
|
-
**
|
|
13
|
-
**permissions** | **boolean** | | [optional] [default to undefined]
|
|
12
|
+
**role_membership** | **boolean** | | [optional] [default to undefined]
|
|
14
13
|
|
|
15
14
|
## Example
|
|
16
15
|
|
|
@@ -21,8 +20,7 @@ const instance: ScimSettingsInboundProtectedAttributes = {
|
|
|
21
20
|
email,
|
|
22
21
|
name,
|
|
23
22
|
active,
|
|
24
|
-
|
|
25
|
-
permissions,
|
|
23
|
+
role_membership,
|
|
26
24
|
};
|
|
27
25
|
```
|
|
28
26
|
|
|
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**oauth2_client_secret** | [**RedactedSecret**](RedactedSecret.md) | | [optional] [default to undefined]
|
|
17
17
|
**oauth2_token_url** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**oauth2_scope** | **string** | | [optional] [default to undefined]
|
|
19
|
-
**tls_certificate** | **string** | Optional PEM CA certificate used for TLS verification. | [optional] [default to undefined]
|
|
20
|
-
**verify_tls** | **boolean** |
|
|
19
|
+
**tls_certificate** | **string** | Optional PEM CA certificate used for TLS verification. Send null or an empty string to remove it. Changing it requires re-entering the stored secrets. | [optional] [default to undefined]
|
|
20
|
+
**verify_tls** | **boolean** | Always true. The endpoint certificate is always verified; false is rejected with 400. | [optional] [default to undefined]
|
|
21
21
|
**push_user_creates** | **boolean** | | [optional] [default to undefined]
|
|
22
22
|
**push_user_updates** | **boolean** | | [optional] [default to undefined]
|
|
23
23
|
**push_user_deletes** | **boolean** | | [optional] [default to undefined]
|
|
@@ -25,7 +25,6 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**sync_on_login** | **boolean** | | [optional] [default to undefined]
|
|
26
26
|
**batch_sync_enabled** | **boolean** | | [optional] [default to undefined]
|
|
27
27
|
**batch_sync_interval** | **string** | | [optional] [default to undefined]
|
|
28
|
-
**attribute_mapping** | **{ [key: string]: string; }** | User field => SCIM attribute. | [optional] [default to undefined]
|
|
29
28
|
**last_sync_at** | **string** | | [optional] [default to undefined]
|
|
30
29
|
**last_sync_status** | **string** | | [optional] [default to undefined]
|
|
31
30
|
**last_sync_error** | **string** | | [optional] [default to undefined]
|
|
@@ -59,7 +58,6 @@ const instance: ScimSettingsOutbound = {
|
|
|
59
58
|
sync_on_login,
|
|
60
59
|
batch_sync_enabled,
|
|
61
60
|
batch_sync_interval,
|
|
62
|
-
attribute_mapping,
|
|
63
61
|
last_sync_at,
|
|
64
62
|
last_sync_status,
|
|
65
63
|
last_sync_error,
|
package/docs/TokenVaultApi.md
CHANGED
|
@@ -63,10 +63,10 @@ const { status, data } = await apiInstance.getConnectionToken(
|
|
|
63
63
|
|-------------|-------------|------------------|
|
|
64
64
|
|**200** | The provider access token. | - |
|
|
65
65
|
|**400** | invalid_user_id. | - |
|
|
66
|
-
|**403** | agent_token_required, cross_tenant, delegation_not_permitted, agent_not_allowed, delegation_not_allowed or connection_disabled. | - |
|
|
66
|
+
|**403** | agent_token_required, cross_tenant, insufficient_scope (the token was narrowed with a scope), delegation_not_permitted, agent_not_allowed, delegation_not_allowed or connection_disabled. | - |
|
|
67
67
|
|**404** | tenant_not_found, connection_not_found or grant_not_found. | - |
|
|
68
68
|
|**409** | grant_revoked, grant_expired or refresh_failed. | - |
|
|
69
|
-
|**429** | rate_limited. | - |
|
|
69
|
+
|**429** | rate_limited, or budget_exceeded when the agent budget is spent. | - |
|
|
70
70
|
|**503** | refresh_in_progress (Retry-After: 2) or provider_unavailable. | - |
|
|
71
71
|
|
|
72
72
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LumoAuth API
|
|
5
|
+
* LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: sdk@lumoauth.dev
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface AdminAgentsAgentsRotateKeyRequest
|
|
21
|
+
*/
|
|
22
|
+
export interface AdminAgentsAgentsRotateKeyRequest {
|
|
23
|
+
/**
|
|
24
|
+
* Days until the new key expires; null for a key that never expires.
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof AdminAgentsAgentsRotateKeyRequest
|
|
27
|
+
*/
|
|
28
|
+
'apiKeyExpiresInDays'?: number | null;
|
|
29
|
+
/**
|
|
30
|
+
* Exact expiry of the new key (ISO 8601, in the future); null for never. Ignored when apiKeyExpiresInDays is sent.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof AdminAgentsAgentsRotateKeyRequest
|
|
33
|
+
*/
|
|
34
|
+
'apiKeyExpiresAt'?: string | null;
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -32,5 +32,11 @@ export interface AdminAgentsAgentsRotateKeyResponse {
|
|
|
32
32
|
* @memberof AdminAgentsAgentsRotateKeyResponse
|
|
33
33
|
*/
|
|
34
34
|
'api_key'?: string;
|
|
35
|
+
/**
|
|
36
|
+
* When the new key expires; null = never.
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof AdminAgentsAgentsRotateKeyResponse
|
|
39
|
+
*/
|
|
40
|
+
'api_key_expires_at'?: string | null;
|
|
35
41
|
}
|
|
36
42
|
|
|
@@ -38,5 +38,11 @@ export interface AdminAgentsCreateRequest {
|
|
|
38
38
|
* @memberof AdminAgentsCreateRequest
|
|
39
39
|
*/
|
|
40
40
|
'capabilities'?: Array<string>;
|
|
41
|
+
/**
|
|
42
|
+
* The agent budget. Keys: max_api_calls_per_hour, max_api_calls_per_day, max_tokens_per_hour, max_tokens_per_day (whole numbers), max_cost_per_day_usd, max_cost_per_month_usd, hard_limit (USD), max_steps, timeout_seconds (whole numbers, read by the agent from UserInfo), and the gateway-only max_cost_usd, monthly_usd, max_budget (USD). Each value must be greater than zero; an unknown key or an invalid value is refused with 400. Leave it out for an agent without a budget.
|
|
43
|
+
* @type {{ [key: string]: any; }}
|
|
44
|
+
* @memberof AdminAgentsCreateRequest
|
|
45
|
+
*/
|
|
46
|
+
'budgetPolicy'?: { [key: string]: any; } | null;
|
|
41
47
|
}
|
|
42
48
|
|