@lumoauth/api-client 1.3.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +22 -0
- package/README.md +19 -5
- package/api/admin-agents-api.ts +166 -10
- package/api/admin-mcp-api.ts +5 -5
- package/api/admin-oauth-clients-api.ts +5 -5
- package/api/admin-sandbox-api.ts +5 -5
- package/api/admin-users-api.ts +27 -26
- package/api/admin-webhooks-api.ts +25 -25
- package/api/agents-api.ts +118 -0
- package/api/oauth-api.ts +111 -0
- package/dist/api/admin-agents-api.d.ts +94 -4
- package/dist/api/admin-agents-api.js +100 -10
- package/dist/api/admin-mcp-api.d.ts +5 -5
- package/dist/api/admin-mcp-api.js +4 -4
- package/dist/api/admin-oauth-clients-api.d.ts +5 -5
- package/dist/api/admin-oauth-clients-api.js +4 -4
- package/dist/api/admin-sandbox-api.d.ts +5 -5
- package/dist/api/admin-sandbox-api.js +4 -4
- package/dist/api/admin-users-api.d.ts +27 -26
- package/dist/api/admin-users-api.js +21 -20
- package/dist/api/admin-webhooks-api.d.ts +25 -25
- package/dist/api/admin-webhooks-api.js +20 -20
- package/dist/api/agents-api.d.ts +65 -0
- package/dist/api/agents-api.js +77 -0
- package/dist/api/oauth-api.d.ts +65 -0
- package/dist/api/oauth-api.js +72 -0
- package/dist/esm/api/admin-agents-api.d.ts +94 -4
- package/dist/esm/api/admin-agents-api.js +100 -10
- package/dist/esm/api/admin-mcp-api.d.ts +5 -5
- package/dist/esm/api/admin-mcp-api.js +4 -4
- package/dist/esm/api/admin-oauth-clients-api.d.ts +5 -5
- package/dist/esm/api/admin-oauth-clients-api.js +4 -4
- package/dist/esm/api/admin-sandbox-api.d.ts +5 -5
- package/dist/esm/api/admin-sandbox-api.js +4 -4
- package/dist/esm/api/admin-users-api.d.ts +27 -26
- package/dist/esm/api/admin-users-api.js +21 -20
- package/dist/esm/api/admin-webhooks-api.d.ts +25 -25
- package/dist/esm/api/admin-webhooks-api.js +20 -20
- package/dist/esm/api/agents-api.d.ts +65 -0
- package/dist/esm/api/agents-api.js +77 -0
- package/dist/esm/api/oauth-api.d.ts +65 -0
- package/dist/esm/api/oauth-api.js +73 -1
- package/dist/esm/models/abac-attribute-definition.d.ts +1 -1
- package/dist/esm/models/abac-resource-attribute.d.ts +1 -1
- package/dist/esm/models/admin-agents-agents-rotate-key-request.d.ts +30 -0
- package/dist/esm/models/admin-agents-agents-rotate-key-request.js +14 -0
- package/dist/esm/models/admin-agents-agents-rotate-key-response.d.ts +6 -0
- package/dist/esm/models/admin-agents-create-request.d.ts +8 -0
- package/dist/esm/models/admin-agents-report-usage-request.d.ts +30 -0
- package/dist/esm/models/admin-agents-report-usage-request.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response-data-recorded.d.ts +30 -0
- package/dist/esm/models/admin-agents-report-usage-response-data-recorded.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response-data.d.ts +33 -0
- package/dist/esm/models/admin-agents-report-usage-response-data.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response.d.ts +25 -0
- package/dist/esm/models/admin-agents-report-usage-response.js +14 -0
- package/dist/esm/models/admin-audit-logs-retention-response-data.d.ts +21 -3
- package/dist/esm/models/admin-identities-link-request.d.ts +8 -1
- package/dist/esm/models/admin-identities-link-request.js +1 -0
- package/dist/esm/models/admin-identities-list-response-data-bindings-item.d.ts +7 -0
- package/dist/esm/models/admin-identities-list-response-data-bindings-item.js +1 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data.d.ts +18 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data.js +14 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data1.d.ts +24 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data1.js +14 -0
- package/dist/esm/models/admin-sandbox-spawn-response.d.ts +3 -3
- package/dist/esm/models/admin-webhooks-delivery-replay-response-data.d.ts +48 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response-data.js +14 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response.d.ts +3 -3
- package/dist/esm/models/admin-webhooks-test-response.d.ts +6 -0
- package/dist/esm/models/attest-response-identity.d.ts +1 -1
- package/dist/esm/models/audit-log-entry.d.ts +1 -1
- package/dist/esm/models/authentication-settings-password-policy.d.ts +25 -1
- package/dist/esm/models/authentication-settings-password-rotation-policy.d.ts +1 -13
- package/dist/esm/models/authentication-settings.d.ts +13 -15
- package/dist/esm/models/authentication-settings.js +11 -0
- package/dist/esm/models/get-approval-status-response-approved-by.d.ts +2 -2
- package/dist/esm/models/index.d.ts +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/esm/models/list-permissions-response-permissions-item.d.ts +1 -1
- package/dist/esm/models/oauth-client-secret-issued.d.ts +1 -1
- package/dist/esm/models/oauth-client.d.ts +6 -0
- package/dist/esm/models/push-enrollment-started.d.ts +1 -1
- package/dist/esm/models/put-admin-agents-update-request.d.ts +8 -0
- package/dist/esm/models/report-agent-usage-response.d.ts +33 -0
- package/dist/esm/models/report-agent-usage-response.js +14 -0
- package/dist/esm/models/request-magic-link-request.d.ts +42 -0
- package/dist/esm/models/request-magic-link-request.js +14 -0
- package/dist/esm/models/request-magic-link-response.d.ts +31 -0
- package/dist/esm/models/request-magic-link-response.js +21 -0
- package/dist/esm/models/scim-settings-inbound-protected-attributes.d.ts +2 -9
- package/dist/esm/models/scim-settings-inbound.d.ts +0 -8
- package/dist/esm/models/scim-settings-outbound.d.ts +2 -10
- package/dist/esm/models/set-user-attribute-response-data.d.ts +1 -1
- package/dist/esm/models/userinfo-response.d.ts +8 -0
- package/dist/models/abac-attribute-definition.d.ts +1 -1
- package/dist/models/abac-resource-attribute.d.ts +1 -1
- package/dist/models/admin-agents-agents-rotate-key-request.d.ts +30 -0
- package/dist/models/admin-agents-agents-rotate-key-request.js +15 -0
- package/dist/models/admin-agents-agents-rotate-key-response.d.ts +6 -0
- package/dist/models/admin-agents-create-request.d.ts +8 -0
- package/dist/models/admin-agents-report-usage-request.d.ts +30 -0
- package/dist/models/admin-agents-report-usage-request.js +15 -0
- package/dist/models/admin-agents-report-usage-response-data-recorded.d.ts +30 -0
- package/dist/models/admin-agents-report-usage-response-data-recorded.js +15 -0
- package/dist/models/admin-agents-report-usage-response-data.d.ts +33 -0
- package/dist/models/admin-agents-report-usage-response-data.js +15 -0
- package/dist/models/admin-agents-report-usage-response.d.ts +25 -0
- package/dist/models/admin-agents-report-usage-response.js +15 -0
- package/dist/models/admin-audit-logs-retention-response-data.d.ts +21 -3
- package/dist/models/admin-identities-link-request.d.ts +8 -1
- package/dist/models/admin-identities-link-request.js +1 -0
- package/dist/models/admin-identities-list-response-data-bindings-item.d.ts +7 -0
- package/dist/models/admin-identities-list-response-data-bindings-item.js +1 -0
- package/dist/models/admin-sandbox-spawn-response-data.d.ts +18 -0
- package/dist/models/admin-sandbox-spawn-response-data.js +15 -0
- package/dist/models/admin-sandbox-spawn-response-data1.d.ts +24 -0
- package/dist/models/admin-sandbox-spawn-response-data1.js +15 -0
- package/dist/models/admin-sandbox-spawn-response.d.ts +3 -3
- package/dist/models/admin-webhooks-delivery-replay-response-data.d.ts +48 -0
- package/dist/models/admin-webhooks-delivery-replay-response-data.js +15 -0
- package/dist/models/admin-webhooks-delivery-replay-response.d.ts +3 -3
- package/dist/models/admin-webhooks-test-response.d.ts +6 -0
- package/dist/models/attest-response-identity.d.ts +1 -1
- package/dist/models/audit-log-entry.d.ts +1 -1
- package/dist/models/authentication-settings-password-policy.d.ts +25 -1
- package/dist/models/authentication-settings-password-rotation-policy.d.ts +1 -13
- package/dist/models/authentication-settings.d.ts +13 -15
- package/dist/models/authentication-settings.js +12 -1
- package/dist/models/get-approval-status-response-approved-by.d.ts +2 -2
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/models/list-permissions-response-permissions-item.d.ts +1 -1
- package/dist/models/oauth-client-secret-issued.d.ts +1 -1
- package/dist/models/oauth-client.d.ts +6 -0
- package/dist/models/push-enrollment-started.d.ts +1 -1
- package/dist/models/put-admin-agents-update-request.d.ts +8 -0
- package/dist/models/report-agent-usage-response.d.ts +33 -0
- package/dist/models/report-agent-usage-response.js +15 -0
- package/dist/models/request-magic-link-request.d.ts +42 -0
- package/dist/models/request-magic-link-request.js +15 -0
- package/dist/models/request-magic-link-response.d.ts +31 -0
- package/dist/models/request-magic-link-response.js +24 -0
- package/dist/models/scim-settings-inbound-protected-attributes.d.ts +2 -9
- package/dist/models/scim-settings-inbound.d.ts +0 -8
- package/dist/models/scim-settings-outbound.d.ts +2 -10
- package/dist/models/set-user-attribute-response-data.d.ts +1 -1
- package/dist/models/userinfo-response.d.ts +8 -0
- package/docs/AAuthApi.md +1 -1
- package/docs/AdminAbacApi.md +1 -1
- package/docs/AdminAgentsAgentsRotateKeyRequest.md +22 -0
- package/docs/AdminAgentsAgentsRotateKeyResponse.md +2 -0
- package/docs/AdminAgentsApi.md +83 -8
- package/docs/AdminAgentsCreateRequest.md +2 -0
- package/docs/AdminAgentsReportUsageRequest.md +22 -0
- package/docs/AdminAgentsReportUsageResponse.md +20 -0
- package/docs/AdminAgentsReportUsageResponseData.md +22 -0
- package/docs/AdminAgentsReportUsageResponseDataRecorded.md +22 -0
- package/docs/AdminAuditLogsRetentionResponseData.md +9 -3
- package/docs/AdminIdentitiesLinkRequest.md +3 -1
- package/docs/AdminIdentitiesListResponseDataBindingsItem.md +2 -0
- package/docs/AdminMcpApi.md +2 -1
- package/docs/AdminOAuthClientsApi.md +2 -2
- package/docs/AdminSandboxApi.md +3 -1
- package/docs/AdminSandboxSpawnResponse.md +1 -1
- package/docs/AdminSandboxSpawnResponseData.md +32 -0
- package/docs/AdminSandboxSpawnResponseData1.md +20 -0
- package/docs/AdminUsersApi.md +8 -8
- package/docs/AdminWebhooksApi.md +7 -5
- package/docs/AdminWebhooksDeliveryReplayResponse.md +1 -1
- package/docs/AdminWebhooksDeliveryReplayResponseData.md +28 -0
- package/docs/AdminWebhooksTestResponse.md +2 -0
- package/docs/AgentsApi.md +64 -2
- package/docs/AttestResponseIdentity.md +1 -1
- package/docs/AuditLogEntry.md +1 -1
- package/docs/AuthenticationSettings.md +2 -6
- package/docs/AuthenticationSettingsPasswordPolicy.md +9 -0
- package/docs/AuthenticationSettingsPasswordRotationPolicy.md +1 -4
- package/docs/AuthorizationApi.md +1 -1
- package/docs/CreateClientResponseData.md +3 -1
- package/docs/EnrollAuthenticator201Response.md +1 -1
- package/docs/GetApprovalStatusResponseApprovedBy.md +1 -1
- package/docs/JitApi.md +3 -3
- package/docs/ListPermissionsResponsePermissionsItem.md +1 -1
- package/docs/OAuthApi.md +63 -2
- package/docs/OAuthClient.md +2 -0
- package/docs/OAuthClientSecretIssued.md +1 -1
- package/docs/OIDCApi.md +2 -2
- package/docs/PushEnrollmentStarted.md +1 -1
- package/docs/PutAdminAgentsUpdateRequest.md +2 -0
- package/docs/ReportAgentUsageResponse.md +22 -0
- package/docs/RequestMagicLinkRequest.md +26 -0
- package/docs/RequestMagicLinkResponse.md +20 -0
- package/docs/ScimSettingsInbound.md +0 -2
- package/docs/ScimSettingsInboundProtectedAttributes.md +3 -5
- package/docs/ScimSettingsOutbound.md +2 -4
- package/docs/TokenVaultApi.md +2 -2
- package/docs/UserinfoResponse.md +2 -0
- package/models/abac-attribute-definition.ts +1 -1
- package/models/abac-resource-attribute.ts +1 -1
- package/models/admin-agents-agents-rotate-key-request.ts +36 -0
- package/models/admin-agents-agents-rotate-key-response.ts +6 -0
- package/models/admin-agents-create-request.ts +6 -0
- package/models/admin-agents-report-usage-request.ts +36 -0
- package/models/admin-agents-report-usage-response-data-recorded.ts +36 -0
- package/models/admin-agents-report-usage-response-data.ts +39 -0
- package/models/admin-agents-report-usage-response.ts +33 -0
- package/models/admin-audit-logs-retention-response-data.ts +21 -3
- package/models/admin-identities-link-request.ts +8 -1
- package/models/admin-identities-list-response-data-bindings-item.ts +7 -0
- package/models/admin-sandbox-spawn-response-data.ts +29 -0
- package/models/admin-sandbox-spawn-response-data1.ts +30 -0
- package/models/admin-sandbox-spawn-response.ts +3 -3
- package/models/admin-webhooks-delivery-replay-response-data.ts +54 -0
- package/models/admin-webhooks-delivery-replay-response.ts +3 -3
- package/models/admin-webhooks-test-response.ts +6 -0
- package/models/attest-response-identity.ts +1 -1
- package/models/audit-log-entry.ts +1 -1
- package/models/authentication-settings-password-policy.ts +25 -1
- package/models/authentication-settings-password-rotation-policy.ts +1 -13
- package/models/authentication-settings.ts +13 -15
- package/models/get-approval-status-response-approved-by.ts +2 -2
- package/models/index.ts +11 -0
- package/models/list-permissions-response-permissions-item.ts +1 -1
- package/models/oauth-client-secret-issued.ts +1 -1
- package/models/oauth-client.ts +6 -0
- package/models/push-enrollment-started.ts +1 -1
- package/models/put-admin-agents-update-request.ts +6 -0
- package/models/report-agent-usage-response.ts +39 -0
- package/models/request-magic-link-request.ts +48 -0
- package/models/request-magic-link-response.ts +39 -0
- package/models/scim-settings-inbound-protected-attributes.ts +2 -10
- package/models/scim-settings-inbound.ts +0 -6
- package/models/scim-settings-outbound.ts +2 -8
- package/models/set-user-attribute-response-data.ts +1 -1
- package/models/userinfo-response.ts +6 -0
- package/package.json +1 -1
|
@@ -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
|
```
|
package/docs/AgentsApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
12
|
|[**getApprovalStatus**](#getapprovalstatus) | **GET** /orgs/{orgId}/api/v1/agents/me/approvals/{token}/status | |
|
|
13
13
|
|[**getCurrentAgent**](#getcurrentagent) | **GET** /orgs/{orgId}/api/v1/agents/me | Get details about the currently authenticated agent|
|
|
14
14
|
|[**registerAgent**](#registeragent) | **POST** /orgs/{orgId}/api/v1/agents/register | Register (or re-register) an agent|
|
|
15
|
+
|[**reportAgentUsage**](#reportagentusage) | **POST** /orgs/{orgId}/api/v1/agents/me/usage | Report the model tokens and cost that the agent used|
|
|
15
16
|
|[**verifyAgentCard**](#verifyagentcard) | **POST** /orgs/{orgId}/api/v1/agents/agent-card/verify | Verify a signed A2A agent card|
|
|
16
17
|
|
|
17
18
|
# **ask**
|
|
@@ -67,7 +68,8 @@ const { status, data } = await apiInstance.ask(
|
|
|
67
68
|
|-------------|-------------|------------------|
|
|
68
69
|
|**200** | Authorization decision for the requested action. | - |
|
|
69
70
|
|**400** | Missing required field: action. | - |
|
|
70
|
-
|**
|
|
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. | - |
|
|
71
73
|
|
|
72
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)
|
|
73
75
|
|
|
@@ -189,6 +191,7 @@ const { status, data } = await apiInstance.authorizeMcp(
|
|
|
189
191
|
|**403** | Denied — no matching per-tool or server-wide grant. | - |
|
|
190
192
|
|**400** | server_id and tool are required, or contain forbidden characters, or are too long together. | - |
|
|
191
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. | - |
|
|
192
195
|
|
|
193
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)
|
|
194
197
|
|
|
@@ -245,7 +248,7 @@ const { status, data } = await apiInstance.createApproval(
|
|
|
245
248
|
|**201** | Approval request created and push sent. | - |
|
|
246
249
|
|**202** | User has no push device; an email sign-in fallback link was sent. | - |
|
|
247
250
|
|**400** | Invalid JSON, task_id, reason, impact, or missing on_behalf_of. | - |
|
|
248
|
-
|**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. | - |
|
|
249
252
|
|**404** | Tenant or target user not found. | - |
|
|
250
253
|
|**428** | User has no enrolled push device and the email fallback could not be sent. | - |
|
|
251
254
|
|**429** | Rate limited (per tenant/agent/user). | - |
|
|
@@ -304,6 +307,7 @@ No authorization required
|
|
|
304
307
|
|-------------|-------------|------------------|
|
|
305
308
|
|**200** | The A2A AgentCard with a detached JWS signature over its JCS-canonical content (signatures[].protected + signature, verifiable against this organization\'s JWKS). | - |
|
|
306
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). | - |
|
|
307
311
|
|
|
308
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)
|
|
309
313
|
|
|
@@ -464,6 +468,64 @@ const { status, data } = await apiInstance.registerAgent(
|
|
|
464
468
|
|
|
465
469
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
466
470
|
|
|
471
|
+
# **reportAgentUsage**
|
|
472
|
+
> ReportAgentUsageResponse reportAgentUsage(adminAgentsReportUsageRequest)
|
|
473
|
+
|
|
474
|
+
Adds the reported tokens and cost to the agent\'s budget windows (current UTC hour, day and month). LumoAuth does not see model calls, so token and cost limits apply only to usage that is reported here or through the Admin API. The report adds no API call and is accepted even when the budget is spent. Agent credentials only; portal test tokens are refused. Rate limited per agent.
|
|
475
|
+
|
|
476
|
+
### Example
|
|
477
|
+
|
|
478
|
+
```typescript
|
|
479
|
+
import {
|
|
480
|
+
AgentsApi,
|
|
481
|
+
Configuration,
|
|
482
|
+
AdminAgentsReportUsageRequest
|
|
483
|
+
} from '@lumoauth/api-client';
|
|
484
|
+
|
|
485
|
+
const configuration = new Configuration();
|
|
486
|
+
const apiInstance = new AgentsApi(configuration);
|
|
487
|
+
|
|
488
|
+
let orgId: string; // (default to undefined)
|
|
489
|
+
let adminAgentsReportUsageRequest: AdminAgentsReportUsageRequest; //
|
|
490
|
+
|
|
491
|
+
const { status, data } = await apiInstance.reportAgentUsage(
|
|
492
|
+
orgId,
|
|
493
|
+
adminAgentsReportUsageRequest
|
|
494
|
+
);
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
### Parameters
|
|
498
|
+
|
|
499
|
+
|Name | Type | Description | Notes|
|
|
500
|
+
|------------- | ------------- | ------------- | -------------|
|
|
501
|
+
| **adminAgentsReportUsageRequest** | **AdminAgentsReportUsageRequest**| | |
|
|
502
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
### Return type
|
|
506
|
+
|
|
507
|
+
**ReportAgentUsageResponse**
|
|
508
|
+
|
|
509
|
+
### Authorization
|
|
510
|
+
|
|
511
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
512
|
+
|
|
513
|
+
### HTTP request headers
|
|
514
|
+
|
|
515
|
+
- **Content-Type**: application/json
|
|
516
|
+
- **Accept**: application/json
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
### HTTP response details
|
|
520
|
+
| Status code | Description | Response headers |
|
|
521
|
+
|-------------|-------------|------------------|
|
|
522
|
+
|**200** | Recorded. `budget` has the same shape as `budget_policy` in UserInfo; `exhausted: true` means that the next metered call gets 429. | - |
|
|
523
|
+
|**400** | invalid_request: tokens or cost_usd is missing, negative, too large or not a number. | - |
|
|
524
|
+
|**403** | test_token_not_accepted, cross_tenant or insufficient_scope (the token was narrowed with a scope). | - |
|
|
525
|
+
|**429** | rate_limited: too many reports from this agent. | - |
|
|
526
|
+
|
|
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)
|
|
528
|
+
|
|
467
529
|
# **verifyAgentCard**
|
|
468
530
|
> VerifyAgentCardResponse verifyAgentCard(requestBody)
|
|
469
531
|
|
|
@@ -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
|
|