@lumoauth/api-client 1.5.0 → 1.6.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 -2
- package/README.md +10 -3
- package/api/admin-abac-api.ts +18 -5
- package/api/admin-agents-api.ts +50 -5
- package/api/admin-audit-logs-api.ts +15 -15
- package/api/admin-email-api.ts +15 -15
- package/api/admin-groups-api.ts +15 -15
- package/api/admin-mfa-api.ts +10 -10
- package/api/admin-oauth-clients-api.ts +15 -15
- package/api/admin-roles-api.ts +20 -20
- package/api/admin-settings-api.ts +112 -60
- package/api/admin-users-api.ts +320 -31
- package/api/agents-api.ts +5 -5
- package/api/authorization-api.ts +20 -20
- package/api/oauth-api.ts +116 -5
- package/api/ssf-api.ts +10 -10
- package/dist/api/admin-abac-api.d.ts +10 -2
- package/dist/api/admin-abac-api.js +10 -5
- package/dist/api/admin-agents-api.d.ts +37 -2
- package/dist/api/admin-agents-api.js +37 -6
- package/dist/api/admin-audit-logs-api.d.ts +15 -15
- package/dist/api/admin-audit-logs-api.js +12 -12
- package/dist/api/admin-email-api.d.ts +15 -15
- package/dist/api/admin-email-api.js +12 -12
- package/dist/api/admin-groups-api.d.ts +15 -15
- package/dist/api/admin-groups-api.js +12 -12
- package/dist/api/admin-mfa-api.d.ts +10 -10
- package/dist/api/admin-mfa-api.js +8 -8
- package/dist/api/admin-oauth-clients-api.d.ts +15 -15
- package/dist/api/admin-oauth-clients-api.js +12 -12
- package/dist/api/admin-roles-api.d.ts +20 -20
- package/dist/api/admin-roles-api.js +16 -16
- package/dist/api/admin-settings-api.d.ts +82 -48
- package/dist/api/admin-settings-api.js +68 -52
- package/dist/api/admin-users-api.d.ts +201 -22
- package/dist/api/admin-users-api.js +185 -28
- package/dist/api/agents-api.d.ts +5 -5
- package/dist/api/agents-api.js +4 -4
- package/dist/api/authorization-api.d.ts +20 -20
- package/dist/api/authorization-api.js +16 -16
- package/dist/api/oauth-api.d.ts +70 -5
- package/dist/api/oauth-api.js +76 -4
- package/dist/api/ssf-api.d.ts +10 -10
- package/dist/api/ssf-api.js +8 -8
- package/dist/esm/api/admin-abac-api.d.ts +10 -2
- package/dist/esm/api/admin-abac-api.js +10 -5
- package/dist/esm/api/admin-agents-api.d.ts +37 -2
- package/dist/esm/api/admin-agents-api.js +36 -5
- package/dist/esm/api/admin-audit-logs-api.d.ts +15 -15
- package/dist/esm/api/admin-audit-logs-api.js +12 -12
- package/dist/esm/api/admin-email-api.d.ts +15 -15
- package/dist/esm/api/admin-email-api.js +12 -12
- package/dist/esm/api/admin-groups-api.d.ts +15 -15
- package/dist/esm/api/admin-groups-api.js +12 -12
- package/dist/esm/api/admin-mfa-api.d.ts +10 -10
- package/dist/esm/api/admin-mfa-api.js +8 -8
- package/dist/esm/api/admin-oauth-clients-api.d.ts +15 -15
- package/dist/esm/api/admin-oauth-clients-api.js +12 -12
- package/dist/esm/api/admin-roles-api.d.ts +20 -20
- package/dist/esm/api/admin-roles-api.js +16 -16
- package/dist/esm/api/admin-settings-api.d.ts +82 -48
- package/dist/esm/api/admin-settings-api.js +69 -53
- package/dist/esm/api/admin-users-api.d.ts +201 -22
- package/dist/esm/api/admin-users-api.js +184 -27
- package/dist/esm/api/agents-api.d.ts +5 -5
- package/dist/esm/api/agents-api.js +4 -4
- package/dist/esm/api/authorization-api.d.ts +20 -20
- package/dist/esm/api/authorization-api.js +16 -16
- package/dist/esm/api/oauth-api.d.ts +70 -5
- package/dist/esm/api/oauth-api.js +76 -4
- package/dist/esm/api/ssf-api.d.ts +10 -10
- package/dist/esm/api/ssf-api.js +8 -8
- package/dist/esm/models/abac-attribute-definition.d.ts +6 -0
- package/dist/esm/models/abac-policy.d.ts +7 -1
- package/dist/esm/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/esm/models/admin-groups-list-response.d.ts +6 -0
- package/dist/esm/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/esm/models/admin-settings-all-response-data-general.d.ts +13 -1
- package/dist/esm/models/admin-settings-all-response-data.d.ts +4 -5
- package/dist/esm/models/admin-settings-email-get-response.d.ts +4 -5
- package/dist/esm/models/admin-settings-general-get-response-data.d.ts +4 -10
- package/dist/esm/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
- package/dist/esm/models/ask-response.d.ts +15 -0
- package/dist/esm/models/ask-response.js +10 -1
- package/dist/esm/models/attest-response.d.ts +2 -2
- package/dist/esm/models/authorization-server-metadata.d.ts +8 -2
- package/dist/esm/models/check-email-first-request.d.ts +30 -0
- package/dist/esm/models/check-email-first-request.js +14 -0
- package/dist/esm/models/check-email-first-response.d.ts +42 -0
- package/dist/esm/models/check-email-first-response.js +14 -0
- package/dist/esm/models/email-sender-settings.d.ts +62 -0
- package/dist/esm/models/email-sender-settings.js +22 -0
- package/dist/esm/models/get-me-response.d.ts +18 -0
- package/dist/esm/models/get-server-challenge-response.d.ts +3 -2
- package/dist/esm/models/get-server-challenge-response.js +1 -0
- package/dist/esm/models/index.d.ts +6 -1
- package/dist/esm/models/index.js +6 -1
- package/dist/esm/models/introspect-response.d.ts +6 -0
- package/dist/esm/models/issue-agent-token-request.d.ts +6 -0
- package/dist/esm/models/list-users-response.d.ts +6 -0
- package/dist/esm/models/oauth-scope.d.ts +1 -7
- package/dist/esm/models/open-id-configuration.d.ts +3 -3
- package/dist/esm/models/put-admin-settings-branding-update-response.d.ts +6 -0
- package/dist/esm/models/put-admin-settings-email-update-request.d.ts +36 -0
- package/dist/esm/models/put-admin-settings-email-update-request.js +14 -0
- package/dist/esm/models/put-admin-settings-email-update-response.d.ts +4 -5
- package/dist/esm/models/put-admin-settings-general-update-request.d.ts +30 -0
- package/dist/esm/models/put-admin-settings-general-update-request.js +14 -0
- package/dist/esm/models/put-admin-settings-general-update-response-data.d.ts +1 -7
- package/dist/esm/models/register-client-response.d.ts +0 -24
- package/dist/esm/models/registered-client-metadata.d.ts +0 -24
- package/dist/esm/models/social-login-provider.d.ts +2 -1
- package/dist/esm/models/user.d.ts +12 -0
- package/dist/esm/models/userinfo-response.d.ts +4 -12
- package/dist/esm/models/userinfo-response.js +0 -2
- package/dist/models/abac-attribute-definition.d.ts +6 -0
- package/dist/models/abac-policy.d.ts +7 -1
- package/dist/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/models/admin-groups-list-response.d.ts +6 -0
- package/dist/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/models/admin-settings-all-response-data-general.d.ts +13 -1
- package/dist/models/admin-settings-all-response-data.d.ts +4 -5
- package/dist/models/admin-settings-email-get-response.d.ts +4 -5
- package/dist/models/admin-settings-general-get-response-data.d.ts +4 -10
- package/dist/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
- package/dist/models/ask-response.d.ts +15 -0
- package/dist/models/ask-response.js +11 -0
- package/dist/models/attest-response.d.ts +2 -2
- package/dist/models/authorization-server-metadata.d.ts +8 -2
- package/dist/models/check-email-first-request.d.ts +30 -0
- package/dist/models/check-email-first-request.js +15 -0
- package/dist/models/check-email-first-response.d.ts +42 -0
- package/dist/models/check-email-first-response.js +15 -0
- package/dist/models/email-sender-settings.d.ts +62 -0
- package/dist/models/email-sender-settings.js +25 -0
- package/dist/models/get-me-response.d.ts +18 -0
- package/dist/models/get-server-challenge-response.d.ts +3 -2
- package/dist/models/get-server-challenge-response.js +1 -0
- package/dist/models/index.d.ts +6 -1
- package/dist/models/index.js +6 -1
- package/dist/models/introspect-response.d.ts +6 -0
- package/dist/models/issue-agent-token-request.d.ts +6 -0
- package/dist/models/list-users-response.d.ts +6 -0
- package/dist/models/oauth-scope.d.ts +1 -7
- package/dist/models/open-id-configuration.d.ts +3 -3
- package/dist/models/put-admin-settings-branding-update-response.d.ts +6 -0
- package/dist/models/put-admin-settings-email-update-request.d.ts +36 -0
- package/dist/models/put-admin-settings-email-update-request.js +15 -0
- package/dist/models/put-admin-settings-email-update-response.d.ts +4 -5
- package/dist/models/put-admin-settings-general-update-request.d.ts +30 -0
- package/dist/models/put-admin-settings-general-update-request.js +15 -0
- package/dist/models/put-admin-settings-general-update-response-data.d.ts +1 -7
- package/dist/models/register-client-response.d.ts +0 -24
- package/dist/models/registered-client-metadata.d.ts +0 -24
- package/dist/models/social-login-provider.d.ts +2 -1
- package/dist/models/user.d.ts +12 -0
- package/dist/models/userinfo-response.d.ts +4 -12
- package/dist/models/userinfo-response.js +0 -2
- package/docs/AbacAttributeDefinition.md +2 -0
- package/docs/AbacPolicy.md +3 -1
- package/docs/AdminAbacApi.md +14 -9
- package/docs/AdminAgentsApi.md +7 -1
- package/docs/AdminAnalyticsDashboardResponseDataAudit.md +1 -1
- package/docs/AdminAuditLogsApi.md +3 -0
- package/docs/AdminEmailApi.md +3 -0
- package/docs/AdminGroupsApi.md +3 -0
- package/docs/AdminGroupsListResponse.md +2 -0
- package/docs/AdminMcpServersListResponse.md +3 -1
- package/docs/AdminMfaApi.md +4 -2
- package/docs/AdminOAuthClientsApi.md +3 -1
- package/docs/AdminOrganizationsApi.md +13 -5
- package/docs/AdminRolesApi.md +10 -0
- package/docs/AdminSettingsAllResponseData.md +1 -1
- package/docs/AdminSettingsAllResponseDataGeneral.md +5 -1
- package/docs/AdminSettingsApi.md +54 -12
- package/docs/AdminSettingsEmailGetResponse.md +1 -1
- package/docs/AdminSettingsGeneralGetResponseData.md +4 -6
- package/docs/AdminUsersApi.md +104 -2
- package/docs/AdminUsersRestoreResponse.md +22 -0
- package/docs/AgentsApi.md +2 -2
- package/docs/AskResponse.md +2 -0
- package/docs/AttestResponse.md +1 -1
- package/docs/AuthorizationApi.md +4 -4
- package/docs/AuthorizationServerMetadata.md +4 -2
- package/docs/CheckEmailFirstRequest.md +22 -0
- package/docs/CheckEmailFirstResponse.md +26 -0
- package/docs/EmailSenderSettings.md +31 -0
- package/docs/GetMeResponse.md +6 -0
- package/docs/GetServerChallengeResponse.md +1 -1
- package/docs/IdentityApi.md +2 -2
- package/docs/IntrospectResponse.md +2 -0
- package/docs/IssueAgentTokenRequest.md +2 -0
- package/docs/ListUsersResponse.md +2 -0
- package/docs/McpApi.md +5 -6
- package/docs/OAuthApi.md +72 -12
- package/docs/OAuthScope.md +1 -3
- package/docs/OIDCApi.md +4 -4
- package/docs/OpenIdConfiguration.md +3 -3
- package/docs/PutAdminSettingsBrandingUpdateResponse.md +2 -0
- package/docs/PutAdminSettingsEmailUpdateRequest.md +24 -0
- package/docs/PutAdminSettingsEmailUpdateResponse.md +1 -1
- package/docs/PutAdminSettingsGeneralUpdateRequest.md +22 -0
- package/docs/PutAdminSettingsGeneralUpdateResponseData.md +1 -3
- package/docs/RegisterClientResponse.md +0 -8
- package/docs/RegisteredClientMetadata.md +0 -8
- package/docs/SocialLoginProvider.md +1 -1
- package/docs/SsfApi.md +2 -0
- package/docs/User.md +4 -0
- package/docs/UserinfoResponse.md +3 -5
- package/docs/WellKnownApi.md +2 -2
- package/models/abac-attribute-definition.ts +6 -0
- package/models/abac-policy.ts +7 -1
- package/models/admin-analytics-dashboard-response-data-audit.ts +1 -1
- package/models/admin-groups-list-response.ts +6 -0
- package/models/admin-mcp-servers-list-response.ts +8 -5
- package/models/admin-settings-all-response-data-general.ts +13 -1
- package/models/admin-settings-all-response-data.ts +6 -3
- package/models/admin-settings-email-get-response.ts +6 -3
- package/models/admin-settings-general-get-response-data.ts +4 -10
- package/models/{admin-mcp-servers-list-response-meta.ts → admin-users-restore-response.ts} +11 -14
- package/models/ask-response.ts +17 -0
- package/models/attest-response.ts +2 -2
- package/models/authorization-server-metadata.ts +8 -2
- package/models/check-email-first-request.ts +36 -0
- package/models/check-email-first-response.ts +48 -0
- package/models/email-sender-settings.ts +70 -0
- package/models/get-me-response.ts +18 -0
- package/models/get-server-challenge-response.ts +3 -2
- package/models/index.ts +6 -1
- package/models/introspect-response.ts +6 -0
- package/models/issue-agent-token-request.ts +6 -0
- package/models/list-users-response.ts +6 -0
- package/models/oauth-scope.ts +1 -7
- package/models/open-id-configuration.ts +3 -3
- package/models/put-admin-settings-branding-update-response.ts +6 -0
- package/models/put-admin-settings-email-update-request.ts +42 -0
- package/models/put-admin-settings-email-update-response.ts +6 -3
- package/models/put-admin-settings-general-update-request.ts +36 -0
- package/models/put-admin-settings-general-update-response-data.ts +1 -7
- package/models/register-client-response.ts +0 -24
- package/models/registered-client-metadata.ts +0 -24
- package/models/social-login-provider.ts +2 -1
- package/models/user.ts +12 -0
- package/models/userinfo-response.ts +4 -12
- package/package.json +1 -1
- package/docs/AdminMcpServersListResponseMeta.md +0 -24
- /package/dist/esm/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
- /package/dist/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
package/docs/AdminSettingsApi.md
CHANGED
|
@@ -245,6 +245,7 @@ const { status, data } = await apiInstance.adminOrganizationGet(
|
|
|
245
245
|
# **adminSettingsAll**
|
|
246
246
|
> AdminSettingsAllResponse adminSettingsAll()
|
|
247
247
|
|
|
248
|
+
Needs `settings.view`. The `branding` part is returned only to a caller who also holds `branding.view` (for an API key, its creator), as for GET /settings/branding and the portal\'s branding page; without it the key is left out.
|
|
248
249
|
|
|
249
250
|
### Example
|
|
250
251
|
|
|
@@ -445,6 +446,7 @@ const { status, data } = await apiInstance.adminSettingsBrandingGet(
|
|
|
445
446
|
# **adminSettingsEmailGet**
|
|
446
447
|
> AdminSettingsEmailGetResponse adminSettingsEmailGet()
|
|
447
448
|
|
|
449
|
+
Shows who sends the organization\'s mail: its own mail provider (set up in the portal) with the From address, From name and Reply-To stored there, or LumoAuth with LumoAuth\'s sender.
|
|
448
450
|
|
|
449
451
|
### Example
|
|
450
452
|
|
|
@@ -739,6 +741,7 @@ const { status, data } = await apiInstance.patchAdminOrganizationUpdate(
|
|
|
739
741
|
| Status code | Description | Response headers |
|
|
740
742
|
|-------------|-------------|------------------|
|
|
741
743
|
|**200** | Updated organization profile | - |
|
|
744
|
+
|**403** | The caller does not hold settings.manage, or settings.audit_log_retention_days or settings.audit_log_auto_delete would change and the caller does not hold gdpr.manage. Nothing is stored. | - |
|
|
742
745
|
|
|
743
746
|
[[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)
|
|
744
747
|
|
|
@@ -789,6 +792,7 @@ const { status, data } = await apiInstance.patchAdminSettingsAuthUpdate(
|
|
|
789
792
|
| Status code | Description | Response headers |
|
|
790
793
|
|-------------|-------------|------------------|
|
|
791
794
|
|**200** | Updated authentication settings | - |
|
|
795
|
+
|**403** | The caller does not hold settings.manage; or cimd_allowed_scopes gains an admin scope and the caller is not a full administrator (settings.manage and users.delete), or gains authz:check and the caller does not hold policies.view; or the change repoints a social provider that accounts the caller does not outrank are bound to. Nothing is stored. | - |
|
|
792
796
|
|
|
793
797
|
[[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)
|
|
794
798
|
|
|
@@ -839,12 +843,14 @@ const { status, data } = await apiInstance.patchAdminSettingsAuthenticationUpdat
|
|
|
839
843
|
| Status code | Description | Response headers |
|
|
840
844
|
|-------------|-------------|------------------|
|
|
841
845
|
|**200** | Updated authentication settings | - |
|
|
846
|
+
|**403** | The caller does not hold settings.manage; or cimd_allowed_scopes gains an admin scope and the caller is not a full administrator (settings.manage and users.delete), or gains authz:check and the caller does not hold policies.view; or the change repoints a social provider that accounts the caller does not outrank are bound to. Nothing is stored. | - |
|
|
842
847
|
|
|
843
848
|
[[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)
|
|
844
849
|
|
|
845
850
|
# **patchAdminSettingsBrandingUpdate**
|
|
846
851
|
> PutAdminSettingsBrandingUpdateResponse patchAdminSettingsBrandingUpdate()
|
|
847
852
|
|
|
853
|
+
Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
|
|
848
854
|
|
|
849
855
|
### Example
|
|
850
856
|
|
|
@@ -889,28 +895,33 @@ const { status, data } = await apiInstance.patchAdminSettingsBrandingUpdate(
|
|
|
889
895
|
| Status code | Description | Response headers |
|
|
890
896
|
|-------------|-------------|------------------|
|
|
891
897
|
|**200** | Updated branding settings | - |
|
|
898
|
+
|**403** | A sign-in policy key would change without settings.manage, or custom_css, custom_html or show_powered_by: false would be set on a plan that does not include it. | - |
|
|
892
899
|
|
|
893
900
|
[[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)
|
|
894
901
|
|
|
895
902
|
# **patchAdminSettingsEmailUpdate**
|
|
896
903
|
> PutAdminSettingsEmailUpdateResponse patchAdminSettingsEmailUpdate()
|
|
897
904
|
|
|
905
|
+
Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
|
|
898
906
|
|
|
899
907
|
### Example
|
|
900
908
|
|
|
901
909
|
```typescript
|
|
902
910
|
import {
|
|
903
911
|
AdminSettingsApi,
|
|
904
|
-
Configuration
|
|
912
|
+
Configuration,
|
|
913
|
+
PutAdminSettingsEmailUpdateRequest
|
|
905
914
|
} from '@lumoauth/api-client';
|
|
906
915
|
|
|
907
916
|
const configuration = new Configuration();
|
|
908
917
|
const apiInstance = new AdminSettingsApi(configuration);
|
|
909
918
|
|
|
910
919
|
let orgId: string; // (default to undefined)
|
|
920
|
+
let putAdminSettingsEmailUpdateRequest: PutAdminSettingsEmailUpdateRequest; // (optional)
|
|
911
921
|
|
|
912
922
|
const { status, data } = await apiInstance.patchAdminSettingsEmailUpdate(
|
|
913
|
-
orgId
|
|
923
|
+
orgId,
|
|
924
|
+
putAdminSettingsEmailUpdateRequest
|
|
914
925
|
);
|
|
915
926
|
```
|
|
916
927
|
|
|
@@ -918,6 +929,7 @@ const { status, data } = await apiInstance.patchAdminSettingsEmailUpdate(
|
|
|
918
929
|
|
|
919
930
|
|Name | Type | Description | Notes|
|
|
920
931
|
|------------- | ------------- | ------------- | -------------|
|
|
932
|
+
| **putAdminSettingsEmailUpdateRequest** | **PutAdminSettingsEmailUpdateRequest**| | |
|
|
921
933
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
922
934
|
|
|
923
935
|
|
|
@@ -931,7 +943,7 @@ const { status, data } = await apiInstance.patchAdminSettingsEmailUpdate(
|
|
|
931
943
|
|
|
932
944
|
### HTTP request headers
|
|
933
945
|
|
|
934
|
-
- **Content-Type**:
|
|
946
|
+
- **Content-Type**: application/json
|
|
935
947
|
- **Accept**: application/json
|
|
936
948
|
|
|
937
949
|
|
|
@@ -939,28 +951,34 @@ const { status, data } = await apiInstance.patchAdminSettingsEmailUpdate(
|
|
|
939
951
|
| Status code | Description | Response headers |
|
|
940
952
|
|-------------|-------------|------------------|
|
|
941
953
|
|**200** | Updated email settings | - |
|
|
954
|
+
|**400** | A value is not valid, a field is not supported, or the organization has no mail provider of its own (details.rejected_keys names the fields). Nothing is stored. | - |
|
|
955
|
+
|**403** | The caller does not hold settings.manage and users.delete. | - |
|
|
942
956
|
|
|
943
957
|
[[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)
|
|
944
958
|
|
|
945
959
|
# **patchAdminSettingsGeneralUpdate**
|
|
946
960
|
> PutAdminSettingsGeneralUpdateResponse patchAdminSettingsGeneralUpdate()
|
|
947
961
|
|
|
962
|
+
Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
|
|
948
963
|
|
|
949
964
|
### Example
|
|
950
965
|
|
|
951
966
|
```typescript
|
|
952
967
|
import {
|
|
953
968
|
AdminSettingsApi,
|
|
954
|
-
Configuration
|
|
969
|
+
Configuration,
|
|
970
|
+
PutAdminSettingsGeneralUpdateRequest
|
|
955
971
|
} from '@lumoauth/api-client';
|
|
956
972
|
|
|
957
973
|
const configuration = new Configuration();
|
|
958
974
|
const apiInstance = new AdminSettingsApi(configuration);
|
|
959
975
|
|
|
960
976
|
let orgId: string; // (default to undefined)
|
|
977
|
+
let putAdminSettingsGeneralUpdateRequest: PutAdminSettingsGeneralUpdateRequest; // (optional)
|
|
961
978
|
|
|
962
979
|
const { status, data } = await apiInstance.patchAdminSettingsGeneralUpdate(
|
|
963
|
-
orgId
|
|
980
|
+
orgId,
|
|
981
|
+
putAdminSettingsGeneralUpdateRequest
|
|
964
982
|
);
|
|
965
983
|
```
|
|
966
984
|
|
|
@@ -968,6 +986,7 @@ const { status, data } = await apiInstance.patchAdminSettingsGeneralUpdate(
|
|
|
968
986
|
|
|
969
987
|
|Name | Type | Description | Notes|
|
|
970
988
|
|------------- | ------------- | ------------- | -------------|
|
|
989
|
+
| **putAdminSettingsGeneralUpdateRequest** | **PutAdminSettingsGeneralUpdateRequest**| | |
|
|
971
990
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
972
991
|
|
|
973
992
|
|
|
@@ -981,7 +1000,7 @@ const { status, data } = await apiInstance.patchAdminSettingsGeneralUpdate(
|
|
|
981
1000
|
|
|
982
1001
|
### HTTP request headers
|
|
983
1002
|
|
|
984
|
-
- **Content-Type**:
|
|
1003
|
+
- **Content-Type**: application/json
|
|
985
1004
|
- **Accept**: application/json
|
|
986
1005
|
|
|
987
1006
|
|
|
@@ -989,6 +1008,8 @@ const { status, data } = await apiInstance.patchAdminSettingsGeneralUpdate(
|
|
|
989
1008
|
| Status code | Description | Response headers |
|
|
990
1009
|
|-------------|-------------|------------------|
|
|
991
1010
|
|**200** | Updated general settings | - |
|
|
1011
|
+
|**400** | A value is not valid (empty or too long name, unknown language, different values for name and one of its aliases) or is not a setting (timezone). Nothing is stored. | - |
|
|
1012
|
+
|**403** | The caller does not hold settings.manage, or locale would change and the caller does not hold branding.edit. Nothing is stored. | - |
|
|
992
1013
|
|
|
993
1014
|
[[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)
|
|
994
1015
|
|
|
@@ -1139,6 +1160,7 @@ const { status, data } = await apiInstance.patchAdminTenantUpdate(
|
|
|
1139
1160
|
| Status code | Description | Response headers |
|
|
1140
1161
|
|-------------|-------------|------------------|
|
|
1141
1162
|
|**200** | Updated organization profile | - |
|
|
1163
|
+
|**403** | The caller does not hold settings.manage, or settings.audit_log_retention_days or settings.audit_log_auto_delete would change and the caller does not hold gdpr.manage. Nothing is stored. | - |
|
|
1142
1164
|
|
|
1143
1165
|
[[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)
|
|
1144
1166
|
|
|
@@ -1189,6 +1211,7 @@ const { status, data } = await apiInstance.putAdminOrganizationUpdate(
|
|
|
1189
1211
|
| Status code | Description | Response headers |
|
|
1190
1212
|
|-------------|-------------|------------------|
|
|
1191
1213
|
|**200** | Updated organization profile | - |
|
|
1214
|
+
|**403** | The caller does not hold settings.manage, or settings.audit_log_retention_days or settings.audit_log_auto_delete would change and the caller does not hold gdpr.manage. Nothing is stored. | - |
|
|
1192
1215
|
|
|
1193
1216
|
[[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)
|
|
1194
1217
|
|
|
@@ -1239,6 +1262,7 @@ const { status, data } = await apiInstance.putAdminSettingsAuthUpdate(
|
|
|
1239
1262
|
| Status code | Description | Response headers |
|
|
1240
1263
|
|-------------|-------------|------------------|
|
|
1241
1264
|
|**200** | Updated authentication settings | - |
|
|
1265
|
+
|**403** | The caller does not hold settings.manage; or cimd_allowed_scopes gains an admin scope and the caller is not a full administrator (settings.manage and users.delete), or gains authz:check and the caller does not hold policies.view; or the change repoints a social provider that accounts the caller does not outrank are bound to. Nothing is stored. | - |
|
|
1242
1266
|
|
|
1243
1267
|
[[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)
|
|
1244
1268
|
|
|
@@ -1289,12 +1313,14 @@ const { status, data } = await apiInstance.putAdminSettingsAuthenticationUpdate(
|
|
|
1289
1313
|
| Status code | Description | Response headers |
|
|
1290
1314
|
|-------------|-------------|------------------|
|
|
1291
1315
|
|**200** | Updated authentication settings | - |
|
|
1316
|
+
|**403** | The caller does not hold settings.manage; or cimd_allowed_scopes gains an admin scope and the caller is not a full administrator (settings.manage and users.delete), or gains authz:check and the caller does not hold policies.view; or the change repoints a social provider that accounts the caller does not outrank are bound to. Nothing is stored. | - |
|
|
1292
1317
|
|
|
1293
1318
|
[[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)
|
|
1294
1319
|
|
|
1295
1320
|
# **putAdminSettingsBrandingUpdate**
|
|
1296
1321
|
> PutAdminSettingsBrandingUpdateResponse putAdminSettingsBrandingUpdate()
|
|
1297
1322
|
|
|
1323
|
+
Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
|
|
1298
1324
|
|
|
1299
1325
|
### Example
|
|
1300
1326
|
|
|
@@ -1339,28 +1365,33 @@ const { status, data } = await apiInstance.putAdminSettingsBrandingUpdate(
|
|
|
1339
1365
|
| Status code | Description | Response headers |
|
|
1340
1366
|
|-------------|-------------|------------------|
|
|
1341
1367
|
|**200** | Updated branding settings | - |
|
|
1368
|
+
|**403** | A sign-in policy key would change without settings.manage, or custom_css, custom_html or show_powered_by: false would be set on a plan that does not include it. | - |
|
|
1342
1369
|
|
|
1343
1370
|
[[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)
|
|
1344
1371
|
|
|
1345
1372
|
# **putAdminSettingsEmailUpdate**
|
|
1346
1373
|
> PutAdminSettingsEmailUpdateResponse putAdminSettingsEmailUpdate()
|
|
1347
1374
|
|
|
1375
|
+
Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
|
|
1348
1376
|
|
|
1349
1377
|
### Example
|
|
1350
1378
|
|
|
1351
1379
|
```typescript
|
|
1352
1380
|
import {
|
|
1353
1381
|
AdminSettingsApi,
|
|
1354
|
-
Configuration
|
|
1382
|
+
Configuration,
|
|
1383
|
+
PutAdminSettingsEmailUpdateRequest
|
|
1355
1384
|
} from '@lumoauth/api-client';
|
|
1356
1385
|
|
|
1357
1386
|
const configuration = new Configuration();
|
|
1358
1387
|
const apiInstance = new AdminSettingsApi(configuration);
|
|
1359
1388
|
|
|
1360
1389
|
let orgId: string; // (default to undefined)
|
|
1390
|
+
let putAdminSettingsEmailUpdateRequest: PutAdminSettingsEmailUpdateRequest; // (optional)
|
|
1361
1391
|
|
|
1362
1392
|
const { status, data } = await apiInstance.putAdminSettingsEmailUpdate(
|
|
1363
|
-
orgId
|
|
1393
|
+
orgId,
|
|
1394
|
+
putAdminSettingsEmailUpdateRequest
|
|
1364
1395
|
);
|
|
1365
1396
|
```
|
|
1366
1397
|
|
|
@@ -1368,6 +1399,7 @@ const { status, data } = await apiInstance.putAdminSettingsEmailUpdate(
|
|
|
1368
1399
|
|
|
1369
1400
|
|Name | Type | Description | Notes|
|
|
1370
1401
|
|------------- | ------------- | ------------- | -------------|
|
|
1402
|
+
| **putAdminSettingsEmailUpdateRequest** | **PutAdminSettingsEmailUpdateRequest**| | |
|
|
1371
1403
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
1372
1404
|
|
|
1373
1405
|
|
|
@@ -1381,7 +1413,7 @@ const { status, data } = await apiInstance.putAdminSettingsEmailUpdate(
|
|
|
1381
1413
|
|
|
1382
1414
|
### HTTP request headers
|
|
1383
1415
|
|
|
1384
|
-
- **Content-Type**:
|
|
1416
|
+
- **Content-Type**: application/json
|
|
1385
1417
|
- **Accept**: application/json
|
|
1386
1418
|
|
|
1387
1419
|
|
|
@@ -1389,28 +1421,34 @@ const { status, data } = await apiInstance.putAdminSettingsEmailUpdate(
|
|
|
1389
1421
|
| Status code | Description | Response headers |
|
|
1390
1422
|
|-------------|-------------|------------------|
|
|
1391
1423
|
|**200** | Updated email settings | - |
|
|
1424
|
+
|**400** | A value is not valid, a field is not supported, or the organization has no mail provider of its own (details.rejected_keys names the fields). Nothing is stored. | - |
|
|
1425
|
+
|**403** | The caller does not hold settings.manage and users.delete. | - |
|
|
1392
1426
|
|
|
1393
1427
|
[[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)
|
|
1394
1428
|
|
|
1395
1429
|
# **putAdminSettingsGeneralUpdate**
|
|
1396
1430
|
> PutAdminSettingsGeneralUpdateResponse putAdminSettingsGeneralUpdate()
|
|
1397
1431
|
|
|
1432
|
+
Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
|
|
1398
1433
|
|
|
1399
1434
|
### Example
|
|
1400
1435
|
|
|
1401
1436
|
```typescript
|
|
1402
1437
|
import {
|
|
1403
1438
|
AdminSettingsApi,
|
|
1404
|
-
Configuration
|
|
1439
|
+
Configuration,
|
|
1440
|
+
PutAdminSettingsGeneralUpdateRequest
|
|
1405
1441
|
} from '@lumoauth/api-client';
|
|
1406
1442
|
|
|
1407
1443
|
const configuration = new Configuration();
|
|
1408
1444
|
const apiInstance = new AdminSettingsApi(configuration);
|
|
1409
1445
|
|
|
1410
1446
|
let orgId: string; // (default to undefined)
|
|
1447
|
+
let putAdminSettingsGeneralUpdateRequest: PutAdminSettingsGeneralUpdateRequest; // (optional)
|
|
1411
1448
|
|
|
1412
1449
|
const { status, data } = await apiInstance.putAdminSettingsGeneralUpdate(
|
|
1413
|
-
orgId
|
|
1450
|
+
orgId,
|
|
1451
|
+
putAdminSettingsGeneralUpdateRequest
|
|
1414
1452
|
);
|
|
1415
1453
|
```
|
|
1416
1454
|
|
|
@@ -1418,6 +1456,7 @@ const { status, data } = await apiInstance.putAdminSettingsGeneralUpdate(
|
|
|
1418
1456
|
|
|
1419
1457
|
|Name | Type | Description | Notes|
|
|
1420
1458
|
|------------- | ------------- | ------------- | -------------|
|
|
1459
|
+
| **putAdminSettingsGeneralUpdateRequest** | **PutAdminSettingsGeneralUpdateRequest**| | |
|
|
1421
1460
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
1422
1461
|
|
|
1423
1462
|
|
|
@@ -1431,7 +1470,7 @@ const { status, data } = await apiInstance.putAdminSettingsGeneralUpdate(
|
|
|
1431
1470
|
|
|
1432
1471
|
### HTTP request headers
|
|
1433
1472
|
|
|
1434
|
-
- **Content-Type**:
|
|
1473
|
+
- **Content-Type**: application/json
|
|
1435
1474
|
- **Accept**: application/json
|
|
1436
1475
|
|
|
1437
1476
|
|
|
@@ -1439,6 +1478,8 @@ const { status, data } = await apiInstance.putAdminSettingsGeneralUpdate(
|
|
|
1439
1478
|
| Status code | Description | Response headers |
|
|
1440
1479
|
|-------------|-------------|------------------|
|
|
1441
1480
|
|**200** | Updated general settings | - |
|
|
1481
|
+
|**400** | A value is not valid (empty or too long name, unknown language, different values for name and one of its aliases) or is not a setting (timezone). Nothing is stored. | - |
|
|
1482
|
+
|**403** | The caller does not hold settings.manage, or locale would change and the caller does not hold branding.edit. Nothing is stored. | - |
|
|
1442
1483
|
|
|
1443
1484
|
[[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)
|
|
1444
1485
|
|
|
@@ -1589,6 +1630,7 @@ const { status, data } = await apiInstance.putAdminTenantUpdate(
|
|
|
1589
1630
|
| Status code | Description | Response headers |
|
|
1590
1631
|
|-------------|-------------|------------------|
|
|
1591
1632
|
|**200** | Updated organization profile | - |
|
|
1633
|
+
|**403** | The caller does not hold settings.manage, or settings.audit_log_retention_days or settings.audit_log_auto_delete would change and the caller does not hold gdpr.manage. Nothing is stored. | - |
|
|
1592
1634
|
|
|
1593
1635
|
[[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)
|
|
1594
1636
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**data** | **
|
|
8
|
+
**data** | [**EmailSenderSettings**](EmailSenderSettings.md) | | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# AdminSettingsGeneralGetResponseData
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
name, displayName (the same value) and locale, then the stored settings dictionary: any stored key (security, audit_log_retention_days, audit_log_auto_delete, agent_governance, ...) is returned as-is; secret-looking keys are redacted.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**name** | **string** |
|
|
10
|
-
**displayName** | **string** |
|
|
11
|
-
**
|
|
12
|
-
**locale** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | Name of the organization, shown on the hosted pages and in mail. | [optional] [default to undefined]
|
|
10
|
+
**displayName** | **string** | The same value as name. | [optional] [default to undefined]
|
|
11
|
+
**locale** | **string** | Default language of the hosted pages (the Default language of the login page settings). | [optional] [default to undefined]
|
|
13
12
|
|
|
14
13
|
## Example
|
|
15
14
|
|
|
@@ -19,7 +18,6 @@ import { AdminSettingsGeneralGetResponseData } from '@lumoauth/api-client';
|
|
|
19
18
|
const instance: AdminSettingsGeneralGetResponseData = {
|
|
20
19
|
name,
|
|
21
20
|
displayName,
|
|
22
|
-
timezone,
|
|
23
21
|
locale,
|
|
24
22
|
};
|
|
25
23
|
```
|
package/docs/AdminUsersApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
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
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
|
+
|[**adminUsersRestore**](#adminusersrestore) | **POST** /orgs/{orgId}/api/v1/admin/users/{userId}/restore | Restore a deleted user|
|
|
15
16
|
|[**blockUser**](#blockuser) | **POST** /orgs/{orgId}/api/v1/admin/users/{userId}/block | Block a user|
|
|
16
17
|
|[**createUser**](#createuser) | **POST** /orgs/{orgId}/api/v1/admin/users | Create a user|
|
|
17
18
|
|[**deleteUser**](#deleteuser) | **DELETE** /orgs/{orgId}/api/v1/admin/users/{userId} | Delete a user|
|
|
@@ -91,6 +92,7 @@ const { status, data } = await apiInstance.addUserGroup(
|
|
|
91
92
|
# **addUserPermission**
|
|
92
93
|
> AddUserPermissionResponse addUserPermission()
|
|
93
94
|
|
|
95
|
+
Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
94
96
|
|
|
95
97
|
### Example
|
|
96
98
|
|
|
@@ -197,7 +199,7 @@ const { status, data } = await apiInstance.addUserRole(
|
|
|
197
199
|
# **adminIdentitiesLegacySamlRelink**
|
|
198
200
|
> AdminIdentitiesLegacySamlRelinkResponse adminIdentitiesLegacySamlRelink(adminIdentitiesLegacySamlRelinkRequest)
|
|
199
201
|
|
|
200
|
-
Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
202
|
+
Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
201
203
|
|
|
202
204
|
### Example
|
|
203
205
|
|
|
@@ -484,6 +486,63 @@ const { status, data } = await apiInstance.adminIdentitiesUnlink(
|
|
|
484
486
|
|
|
485
487
|
[[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)
|
|
486
488
|
|
|
489
|
+
# **adminUsersRestore**
|
|
490
|
+
> AdminUsersRestoreResponse adminUsersRestore()
|
|
491
|
+
|
|
492
|
+
Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
493
|
+
|
|
494
|
+
### Example
|
|
495
|
+
|
|
496
|
+
```typescript
|
|
497
|
+
import {
|
|
498
|
+
AdminUsersApi,
|
|
499
|
+
Configuration
|
|
500
|
+
} from '@lumoauth/api-client';
|
|
501
|
+
|
|
502
|
+
const configuration = new Configuration();
|
|
503
|
+
const apiInstance = new AdminUsersApi(configuration);
|
|
504
|
+
|
|
505
|
+
let orgId: string; // (default to undefined)
|
|
506
|
+
let userId: string; // (default to undefined)
|
|
507
|
+
|
|
508
|
+
const { status, data } = await apiInstance.adminUsersRestore(
|
|
509
|
+
orgId,
|
|
510
|
+
userId
|
|
511
|
+
);
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### Parameters
|
|
515
|
+
|
|
516
|
+
|Name | Type | Description | Notes|
|
|
517
|
+
|------------- | ------------- | ------------- | -------------|
|
|
518
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
519
|
+
| **userId** | [**string**] | | defaults to undefined|
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
### Return type
|
|
523
|
+
|
|
524
|
+
**AdminUsersRestoreResponse**
|
|
525
|
+
|
|
526
|
+
### Authorization
|
|
527
|
+
|
|
528
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
529
|
+
|
|
530
|
+
### HTTP request headers
|
|
531
|
+
|
|
532
|
+
- **Content-Type**: Not defined
|
|
533
|
+
- **Accept**: application/json
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
### HTTP response details
|
|
537
|
+
| Status code | Description | Response headers |
|
|
538
|
+
|-------------|-------------|------------------|
|
|
539
|
+
|**200** | User restored | - |
|
|
540
|
+
|**403** | The user holds privileges that the caller lacks, or the plan has no free administrator seat | - |
|
|
541
|
+
|**404** | No such user in this organization | - |
|
|
542
|
+
|**409** | The user is not deleted (`user_not_deleted`), was erased (`user_erased`), or its address is used by another account (`address_in_use`) | - |
|
|
543
|
+
|
|
544
|
+
[[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)
|
|
545
|
+
|
|
487
546
|
# **blockUser**
|
|
488
547
|
> BlockUserResponse blockUser()
|
|
489
548
|
|
|
@@ -584,6 +643,7 @@ const { status, data } = await apiInstance.createUser(
|
|
|
584
643
|
| Status code | Description | Response headers |
|
|
585
644
|
|-------------|-------------|------------------|
|
|
586
645
|
|**201** | User created | - |
|
|
646
|
+
|**403** | Missing permission, or a plan limit (`plan_limit_reached`): no admin seat free for a user created with admin access (`limit`: `admin_seats`), or every monthly-active-user place of a plan with a hard cap used this month (`limit`: `mau`, with `resets_on`). Nothing is created | - |
|
|
587
647
|
|
|
588
648
|
[[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)
|
|
589
649
|
|
|
@@ -868,9 +928,33 @@ const configuration = new Configuration();
|
|
|
868
928
|
const apiInstance = new AdminUsersApi(configuration);
|
|
869
929
|
|
|
870
930
|
let orgId: string; // (default to undefined)
|
|
931
|
+
let page: number; //Page number. (optional) (default to 1)
|
|
932
|
+
let limit: number; //Users per page (1 to 100). (optional) (default to 25)
|
|
933
|
+
let search: string; //Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used). (optional) (default to undefined)
|
|
934
|
+
let active: boolean; //Only active (`true`) or inactive (`false`) users. (optional) (default to undefined)
|
|
935
|
+
let blocked: boolean; //Only blocked (`true`) or not blocked (`false`) users. (optional) (default to undefined)
|
|
936
|
+
let deleted: boolean; //`true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out. (optional) (default to false)
|
|
937
|
+
let emailVerified: boolean; //Only users whose email address is verified (`true`) or not (`false`). (optional) (default to undefined)
|
|
938
|
+
let mfaEnabled: boolean; //Only users with (`true`) or without (`false`) multi-factor authentication. (optional) (default to undefined)
|
|
939
|
+
let role: string; //Only users who hold the role with this slug. (optional) (default to undefined)
|
|
940
|
+
let group: string; //Only members of the group with this slug. (optional) (default to undefined)
|
|
941
|
+
let sortBy: 'email' | 'name' | 'username' | 'createdAt' | 'lastLoginAt'; //Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt. (optional) (default to undefined)
|
|
942
|
+
let sortDir: 'ASC' | 'DESC'; //Sort direction. Used only together with sortBy. (optional) (default to 'DESC')
|
|
871
943
|
|
|
872
944
|
const { status, data } = await apiInstance.listUsers(
|
|
873
|
-
orgId
|
|
945
|
+
orgId,
|
|
946
|
+
page,
|
|
947
|
+
limit,
|
|
948
|
+
search,
|
|
949
|
+
active,
|
|
950
|
+
blocked,
|
|
951
|
+
deleted,
|
|
952
|
+
emailVerified,
|
|
953
|
+
mfaEnabled,
|
|
954
|
+
role,
|
|
955
|
+
group,
|
|
956
|
+
sortBy,
|
|
957
|
+
sortDir
|
|
874
958
|
);
|
|
875
959
|
```
|
|
876
960
|
|
|
@@ -879,6 +963,18 @@ const { status, data } = await apiInstance.listUsers(
|
|
|
879
963
|
|Name | Type | Description | Notes|
|
|
880
964
|
|------------- | ------------- | ------------- | -------------|
|
|
881
965
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
966
|
+
| **page** | [**number**] | Page number. | (optional) defaults to 1|
|
|
967
|
+
| **limit** | [**number**] | Users per page (1 to 100). | (optional) defaults to 25|
|
|
968
|
+
| **search** | [**string**] | Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used). | (optional) defaults to undefined|
|
|
969
|
+
| **active** | [**boolean**] | Only active (`true`) or inactive (`false`) users. | (optional) defaults to undefined|
|
|
970
|
+
| **blocked** | [**boolean**] | Only blocked (`true`) or not blocked (`false`) users. | (optional) defaults to undefined|
|
|
971
|
+
| **deleted** | [**boolean**] | `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out. | (optional) defaults to false|
|
|
972
|
+
| **emailVerified** | [**boolean**] | Only users whose email address is verified (`true`) or not (`false`). | (optional) defaults to undefined|
|
|
973
|
+
| **mfaEnabled** | [**boolean**] | Only users with (`true`) or without (`false`) multi-factor authentication. | (optional) defaults to undefined|
|
|
974
|
+
| **role** | [**string**] | Only users who hold the role with this slug. | (optional) defaults to undefined|
|
|
975
|
+
| **group** | [**string**] | Only members of the group with this slug. | (optional) defaults to undefined|
|
|
976
|
+
| **sortBy** | [**'email' | 'name' | 'username' | 'createdAt' | 'lastLoginAt'**]**Array<'email' | 'name' | 'username' | 'createdAt' | 'lastLoginAt'>** | Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt. | (optional) defaults to undefined|
|
|
977
|
+
| **sortDir** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | Sort direction. Used only together with sortBy. | (optional) defaults to 'DESC'|
|
|
882
978
|
|
|
883
979
|
|
|
884
980
|
### Return type
|
|
@@ -1286,6 +1382,7 @@ const { status, data } = await apiInstance.sendUserVerificationEmail(
|
|
|
1286
1382
|
# **setUserPassword**
|
|
1287
1383
|
> SetUserPasswordPostResponse setUserPassword()
|
|
1288
1384
|
|
|
1385
|
+
Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
1289
1386
|
|
|
1290
1387
|
### Example
|
|
1291
1388
|
|
|
@@ -1333,12 +1430,15 @@ const { status, data } = await apiInstance.setUserPassword(
|
|
|
1333
1430
|
| Status code | Description | Response headers |
|
|
1334
1431
|
|-------------|-------------|------------------|
|
|
1335
1432
|
|**200** | Password updated | - |
|
|
1433
|
+
|**401** | insufficient_user_authentication: the access token comes from a sign-in older than 10 minutes | - |
|
|
1434
|
+
|**403** | Actor does not outrank the user, or step_up_required | - |
|
|
1336
1435
|
|
|
1337
1436
|
[[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)
|
|
1338
1437
|
|
|
1339
1438
|
# **setUserPasswordPost**
|
|
1340
1439
|
> SetUserPasswordPostResponse setUserPasswordPost()
|
|
1341
1440
|
|
|
1441
|
+
Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
1342
1442
|
|
|
1343
1443
|
### Example
|
|
1344
1444
|
|
|
@@ -1386,6 +1486,8 @@ const { status, data } = await apiInstance.setUserPasswordPost(
|
|
|
1386
1486
|
| Status code | Description | Response headers |
|
|
1387
1487
|
|-------------|-------------|------------------|
|
|
1388
1488
|
|**200** | Password updated | - |
|
|
1489
|
+
|**401** | insufficient_user_authentication: the access token comes from a sign-in older than 10 minutes | - |
|
|
1490
|
+
|**403** | Actor does not outrank the user, or step_up_required | - |
|
|
1389
1491
|
|
|
1390
1492
|
[[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)
|
|
1391
1493
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AdminUsersRestoreResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**User**](User.md) | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminUsersRestoreResponse } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminUsersRestoreResponse = {
|
|
17
|
+
data,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/AgentsApi.md
CHANGED
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
18
18
|
# **ask**
|
|
19
19
|
> AskResponse ask(askRequest)
|
|
20
20
|
|
|
21
|
-
POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document
|
|
21
|
+
POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document:read\", \"context\": {\"id\": \"123\"} }
|
|
22
22
|
|
|
23
23
|
### Example
|
|
24
24
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.ask(
|
|
|
67
67
|
| Status code | Description | Response headers |
|
|
68
68
|
|-------------|-------------|------------------|
|
|
69
69
|
|**200** | Authorization decision for the requested action. | - |
|
|
70
|
-
|**400** | Missing required field: action. | - |
|
|
70
|
+
|**400** | Missing required field: action; or invalid_action: an agent wrote the action in the dot form (invoices.read). Agents write <resource>:<action> (invoices:read); a user\'s action is a permission slug. | - |
|
|
71
71
|
|**403** | plan_limit_reached: the Ask API calls that the plan includes for this month are used (plans without overage only). | - |
|
|
72
72
|
|**429** | budget_exceeded: the agent budget is spent. Retry-After holds the seconds until the spent window starts again. | - |
|
|
73
73
|
|
package/docs/AskResponse.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**action** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**context** | **object** | | [optional] [default to undefined]
|
|
11
11
|
**reason** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**decided_by** | **string** | Which check produced the answer. Always pdp for a user caller. | [optional] [default to undefined]
|
|
12
13
|
**audit_id** | **string** | | [optional] [default to undefined]
|
|
13
14
|
|
|
14
15
|
## Example
|
|
@@ -21,6 +22,7 @@ const instance: AskResponse = {
|
|
|
21
22
|
action,
|
|
22
23
|
context,
|
|
23
24
|
reason,
|
|
25
|
+
decided_by,
|
|
24
26
|
audit_id,
|
|
25
27
|
};
|
|
26
28
|
```
|
package/docs/AttestResponse.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**access_token** | **string** | | [default to undefined]
|
|
9
9
|
**token_type** | **string** | | [default to undefined]
|
|
10
10
|
**expires_in** | **number** | | [default to undefined]
|
|
11
|
-
**scope** | **string** |
|
|
11
|
+
**scope** | **string** | The issued scope values (the agent\'s capabilities, or the requested subset), separated by one space. Left out when none was issued. | [optional] [default to undefined]
|
|
12
12
|
**identity** | [**AttestResponseIdentity**](AttestResponseIdentity.md) | | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
package/docs/AuthorizationApi.md
CHANGED
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.checkAbacBulk(
|
|
|
128
128
|
# **checkAllPermissions**
|
|
129
129
|
> CheckAnyPermissionResponse checkAllPermissions()
|
|
130
130
|
|
|
131
|
-
POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
131
|
+
POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -172,7 +172,7 @@ This endpoint does not have any parameters.
|
|
|
172
172
|
# **checkAnyPermission**
|
|
173
173
|
> CheckAnyPermissionResponse checkAnyPermission()
|
|
174
174
|
|
|
175
|
-
POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
175
|
+
POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
|
|
176
176
|
|
|
177
177
|
### Example
|
|
178
178
|
|
|
@@ -216,7 +216,7 @@ This endpoint does not have any parameters.
|
|
|
216
216
|
# **checkPermission**
|
|
217
217
|
> CheckPermissionResponse checkPermission()
|
|
218
218
|
|
|
219
|
-
POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
219
|
+
POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
|
|
220
220
|
|
|
221
221
|
### Example
|
|
222
222
|
|
|
@@ -260,7 +260,7 @@ This endpoint does not have any parameters.
|
|
|
260
260
|
# **checkPermissionsBulk**
|
|
261
261
|
> CheckPermissionsBulkResponse checkPermissionsBulk()
|
|
262
262
|
|
|
263
|
-
POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
263
|
+
POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
|
|
264
264
|
|
|
265
265
|
### Example
|
|
266
266
|
|