@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
|
@@ -25,7 +25,9 @@ import type { AdminSettingsSecurityGetResponse } from '../models';
|
|
|
25
25
|
import type { AdminTenantGetResponse } from '../models';
|
|
26
26
|
import type { PutAdminSettingsAuthenticationUpdateResponse } from '../models';
|
|
27
27
|
import type { PutAdminSettingsBrandingUpdateResponse } from '../models';
|
|
28
|
+
import type { PutAdminSettingsEmailUpdateRequest } from '../models';
|
|
28
29
|
import type { PutAdminSettingsEmailUpdateResponse } from '../models';
|
|
30
|
+
import type { PutAdminSettingsGeneralUpdateRequest } from '../models';
|
|
29
31
|
import type { PutAdminSettingsGeneralUpdateResponse } from '../models';
|
|
30
32
|
import type { PutAdminSettingsScimUpdateResponse } from '../models';
|
|
31
33
|
import type { PutAdminSettingsSecurityUpdateResponse } from '../models';
|
|
@@ -70,7 +72,7 @@ export declare const AdminSettingsApiAxiosParamCreator: (configuration?: Configu
|
|
|
70
72
|
*/
|
|
71
73
|
adminOrganizationGet: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
74
|
/**
|
|
73
|
-
*
|
|
75
|
+
* 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.
|
|
74
76
|
* @summary Get all settings (combined)
|
|
75
77
|
* @param {string} orgId
|
|
76
78
|
* @param {*} [options] Override http request option.
|
|
@@ -102,7 +104,7 @@ export declare const AdminSettingsApiAxiosParamCreator: (configuration?: Configu
|
|
|
102
104
|
*/
|
|
103
105
|
adminSettingsBrandingGet: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
106
|
/**
|
|
105
|
-
*
|
|
107
|
+
* 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.
|
|
106
108
|
* @summary Get email settings
|
|
107
109
|
* @param {string} orgId
|
|
108
110
|
* @param {*} [options] Override http request option.
|
|
@@ -166,7 +168,7 @@ export declare const AdminSettingsApiAxiosParamCreator: (configuration?: Configu
|
|
|
166
168
|
*/
|
|
167
169
|
patchAdminSettingsAuthenticationUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
168
170
|
/**
|
|
169
|
-
*
|
|
171
|
+
* 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.
|
|
170
172
|
* @summary Update branding/login page settings
|
|
171
173
|
* @param {string} orgId
|
|
172
174
|
* @param {*} [options] Override http request option.
|
|
@@ -174,21 +176,23 @@ export declare const AdminSettingsApiAxiosParamCreator: (configuration?: Configu
|
|
|
174
176
|
*/
|
|
175
177
|
patchAdminSettingsBrandingUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
176
178
|
/**
|
|
177
|
-
*
|
|
179
|
+
* 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.
|
|
178
180
|
* @summary Update email settings
|
|
179
181
|
* @param {string} orgId
|
|
182
|
+
* @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
|
|
180
183
|
* @param {*} [options] Override http request option.
|
|
181
184
|
* @throws {RequiredError}
|
|
182
185
|
*/
|
|
183
|
-
patchAdminSettingsEmailUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
186
|
+
patchAdminSettingsEmailUpdate: (orgId: string, putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
184
187
|
/**
|
|
185
|
-
*
|
|
188
|
+
* 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.
|
|
186
189
|
* @summary Update general settings
|
|
187
190
|
* @param {string} orgId
|
|
191
|
+
* @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
|
|
188
192
|
* @param {*} [options] Override http request option.
|
|
189
193
|
* @throws {RequiredError}
|
|
190
194
|
*/
|
|
191
|
-
patchAdminSettingsGeneralUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
195
|
+
patchAdminSettingsGeneralUpdate: (orgId: string, putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
192
196
|
/**
|
|
193
197
|
*
|
|
194
198
|
* @summary Update SCIM settings
|
|
@@ -238,7 +242,7 @@ export declare const AdminSettingsApiAxiosParamCreator: (configuration?: Configu
|
|
|
238
242
|
*/
|
|
239
243
|
putAdminSettingsAuthenticationUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
240
244
|
/**
|
|
241
|
-
*
|
|
245
|
+
* 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.
|
|
242
246
|
* @summary Update branding/login page settings
|
|
243
247
|
* @param {string} orgId
|
|
244
248
|
* @param {*} [options] Override http request option.
|
|
@@ -246,21 +250,23 @@ export declare const AdminSettingsApiAxiosParamCreator: (configuration?: Configu
|
|
|
246
250
|
*/
|
|
247
251
|
putAdminSettingsBrandingUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
248
252
|
/**
|
|
249
|
-
*
|
|
253
|
+
* 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.
|
|
250
254
|
* @summary Update email settings
|
|
251
255
|
* @param {string} orgId
|
|
256
|
+
* @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
|
|
252
257
|
* @param {*} [options] Override http request option.
|
|
253
258
|
* @throws {RequiredError}
|
|
254
259
|
*/
|
|
255
|
-
putAdminSettingsEmailUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
260
|
+
putAdminSettingsEmailUpdate: (orgId: string, putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
256
261
|
/**
|
|
257
|
-
*
|
|
262
|
+
* 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.
|
|
258
263
|
* @summary Update general settings
|
|
259
264
|
* @param {string} orgId
|
|
265
|
+
* @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
|
|
260
266
|
* @param {*} [options] Override http request option.
|
|
261
267
|
* @throws {RequiredError}
|
|
262
268
|
*/
|
|
263
|
-
putAdminSettingsGeneralUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
269
|
+
putAdminSettingsGeneralUpdate: (orgId: string, putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
264
270
|
/**
|
|
265
271
|
*
|
|
266
272
|
* @summary Update SCIM settings
|
|
@@ -326,7 +332,7 @@ export declare const AdminSettingsApiFp: (configuration?: Configuration) => {
|
|
|
326
332
|
*/
|
|
327
333
|
adminOrganizationGet(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminTenantGetResponse>>;
|
|
328
334
|
/**
|
|
329
|
-
*
|
|
335
|
+
* 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.
|
|
330
336
|
* @summary Get all settings (combined)
|
|
331
337
|
* @param {string} orgId
|
|
332
338
|
* @param {*} [options] Override http request option.
|
|
@@ -358,7 +364,7 @@ export declare const AdminSettingsApiFp: (configuration?: Configuration) => {
|
|
|
358
364
|
*/
|
|
359
365
|
adminSettingsBrandingGet(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminSettingsBrandingGetResponse>>;
|
|
360
366
|
/**
|
|
361
|
-
*
|
|
367
|
+
* 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.
|
|
362
368
|
* @summary Get email settings
|
|
363
369
|
* @param {string} orgId
|
|
364
370
|
* @param {*} [options] Override http request option.
|
|
@@ -422,7 +428,7 @@ export declare const AdminSettingsApiFp: (configuration?: Configuration) => {
|
|
|
422
428
|
*/
|
|
423
429
|
patchAdminSettingsAuthenticationUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsAuthenticationUpdateResponse>>;
|
|
424
430
|
/**
|
|
425
|
-
*
|
|
431
|
+
* 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.
|
|
426
432
|
* @summary Update branding/login page settings
|
|
427
433
|
* @param {string} orgId
|
|
428
434
|
* @param {*} [options] Override http request option.
|
|
@@ -430,21 +436,23 @@ export declare const AdminSettingsApiFp: (configuration?: Configuration) => {
|
|
|
430
436
|
*/
|
|
431
437
|
patchAdminSettingsBrandingUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsBrandingUpdateResponse>>;
|
|
432
438
|
/**
|
|
433
|
-
*
|
|
439
|
+
* 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.
|
|
434
440
|
* @summary Update email settings
|
|
435
441
|
* @param {string} orgId
|
|
442
|
+
* @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
|
|
436
443
|
* @param {*} [options] Override http request option.
|
|
437
444
|
* @throws {RequiredError}
|
|
438
445
|
*/
|
|
439
|
-
patchAdminSettingsEmailUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsEmailUpdateResponse>>;
|
|
446
|
+
patchAdminSettingsEmailUpdate(orgId: string, putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsEmailUpdateResponse>>;
|
|
440
447
|
/**
|
|
441
|
-
*
|
|
448
|
+
* 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.
|
|
442
449
|
* @summary Update general settings
|
|
443
450
|
* @param {string} orgId
|
|
451
|
+
* @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
|
|
444
452
|
* @param {*} [options] Override http request option.
|
|
445
453
|
* @throws {RequiredError}
|
|
446
454
|
*/
|
|
447
|
-
patchAdminSettingsGeneralUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsGeneralUpdateResponse>>;
|
|
455
|
+
patchAdminSettingsGeneralUpdate(orgId: string, putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsGeneralUpdateResponse>>;
|
|
448
456
|
/**
|
|
449
457
|
*
|
|
450
458
|
* @summary Update SCIM settings
|
|
@@ -494,7 +502,7 @@ export declare const AdminSettingsApiFp: (configuration?: Configuration) => {
|
|
|
494
502
|
*/
|
|
495
503
|
putAdminSettingsAuthenticationUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsAuthenticationUpdateResponse>>;
|
|
496
504
|
/**
|
|
497
|
-
*
|
|
505
|
+
* 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.
|
|
498
506
|
* @summary Update branding/login page settings
|
|
499
507
|
* @param {string} orgId
|
|
500
508
|
* @param {*} [options] Override http request option.
|
|
@@ -502,21 +510,23 @@ export declare const AdminSettingsApiFp: (configuration?: Configuration) => {
|
|
|
502
510
|
*/
|
|
503
511
|
putAdminSettingsBrandingUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsBrandingUpdateResponse>>;
|
|
504
512
|
/**
|
|
505
|
-
*
|
|
513
|
+
* 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.
|
|
506
514
|
* @summary Update email settings
|
|
507
515
|
* @param {string} orgId
|
|
516
|
+
* @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
|
|
508
517
|
* @param {*} [options] Override http request option.
|
|
509
518
|
* @throws {RequiredError}
|
|
510
519
|
*/
|
|
511
|
-
putAdminSettingsEmailUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsEmailUpdateResponse>>;
|
|
520
|
+
putAdminSettingsEmailUpdate(orgId: string, putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsEmailUpdateResponse>>;
|
|
512
521
|
/**
|
|
513
|
-
*
|
|
522
|
+
* 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.
|
|
514
523
|
* @summary Update general settings
|
|
515
524
|
* @param {string} orgId
|
|
525
|
+
* @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
|
|
516
526
|
* @param {*} [options] Override http request option.
|
|
517
527
|
* @throws {RequiredError}
|
|
518
528
|
*/
|
|
519
|
-
putAdminSettingsGeneralUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsGeneralUpdateResponse>>;
|
|
529
|
+
putAdminSettingsGeneralUpdate(orgId: string, putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsGeneralUpdateResponse>>;
|
|
520
530
|
/**
|
|
521
531
|
*
|
|
522
532
|
* @summary Update SCIM settings
|
|
@@ -580,7 +590,7 @@ export declare const AdminSettingsApiFactory: (configuration?: Configuration, ba
|
|
|
580
590
|
*/
|
|
581
591
|
adminOrganizationGet(requestParameters: AdminSettingsApiAdminOrganizationGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminTenantGetResponse>;
|
|
582
592
|
/**
|
|
583
|
-
*
|
|
593
|
+
* 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.
|
|
584
594
|
* @summary Get all settings (combined)
|
|
585
595
|
* @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
|
|
586
596
|
* @param {*} [options] Override http request option.
|
|
@@ -612,7 +622,7 @@ export declare const AdminSettingsApiFactory: (configuration?: Configuration, ba
|
|
|
612
622
|
*/
|
|
613
623
|
adminSettingsBrandingGet(requestParameters: AdminSettingsApiAdminSettingsBrandingGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminSettingsBrandingGetResponse>;
|
|
614
624
|
/**
|
|
615
|
-
*
|
|
625
|
+
* 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.
|
|
616
626
|
* @summary Get email settings
|
|
617
627
|
* @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
|
|
618
628
|
* @param {*} [options] Override http request option.
|
|
@@ -676,7 +686,7 @@ export declare const AdminSettingsApiFactory: (configuration?: Configuration, ba
|
|
|
676
686
|
*/
|
|
677
687
|
patchAdminSettingsAuthenticationUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsAuthenticationUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsAuthenticationUpdateResponse>;
|
|
678
688
|
/**
|
|
679
|
-
*
|
|
689
|
+
* 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.
|
|
680
690
|
* @summary Update branding/login page settings
|
|
681
691
|
* @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
682
692
|
* @param {*} [options] Override http request option.
|
|
@@ -684,7 +694,7 @@ export declare const AdminSettingsApiFactory: (configuration?: Configuration, ba
|
|
|
684
694
|
*/
|
|
685
695
|
patchAdminSettingsBrandingUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsBrandingUpdateResponse>;
|
|
686
696
|
/**
|
|
687
|
-
*
|
|
697
|
+
* 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.
|
|
688
698
|
* @summary Update email settings
|
|
689
699
|
* @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
690
700
|
* @param {*} [options] Override http request option.
|
|
@@ -692,7 +702,7 @@ export declare const AdminSettingsApiFactory: (configuration?: Configuration, ba
|
|
|
692
702
|
*/
|
|
693
703
|
patchAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsEmailUpdateResponse>;
|
|
694
704
|
/**
|
|
695
|
-
*
|
|
705
|
+
* 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.
|
|
696
706
|
* @summary Update general settings
|
|
697
707
|
* @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
698
708
|
* @param {*} [options] Override http request option.
|
|
@@ -748,7 +758,7 @@ export declare const AdminSettingsApiFactory: (configuration?: Configuration, ba
|
|
|
748
758
|
*/
|
|
749
759
|
putAdminSettingsAuthenticationUpdate(requestParameters: AdminSettingsApiPutAdminSettingsAuthenticationUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsAuthenticationUpdateResponse>;
|
|
750
760
|
/**
|
|
751
|
-
*
|
|
761
|
+
* 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.
|
|
752
762
|
* @summary Update branding/login page settings
|
|
753
763
|
* @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
754
764
|
* @param {*} [options] Override http request option.
|
|
@@ -756,7 +766,7 @@ export declare const AdminSettingsApiFactory: (configuration?: Configuration, ba
|
|
|
756
766
|
*/
|
|
757
767
|
putAdminSettingsBrandingUpdate(requestParameters: AdminSettingsApiPutAdminSettingsBrandingUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsBrandingUpdateResponse>;
|
|
758
768
|
/**
|
|
759
|
-
*
|
|
769
|
+
* 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.
|
|
760
770
|
* @summary Update email settings
|
|
761
771
|
* @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
762
772
|
* @param {*} [options] Override http request option.
|
|
@@ -764,7 +774,7 @@ export declare const AdminSettingsApiFactory: (configuration?: Configuration, ba
|
|
|
764
774
|
*/
|
|
765
775
|
putAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsEmailUpdateResponse>;
|
|
766
776
|
/**
|
|
767
|
-
*
|
|
777
|
+
* 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.
|
|
768
778
|
* @summary Update general settings
|
|
769
779
|
* @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
770
780
|
* @param {*} [options] Override http request option.
|
|
@@ -839,7 +849,7 @@ export interface AdminSettingsApiInterface {
|
|
|
839
849
|
*/
|
|
840
850
|
adminOrganizationGet(requestParameters: AdminSettingsApiAdminOrganizationGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminTenantGetResponse>;
|
|
841
851
|
/**
|
|
842
|
-
*
|
|
852
|
+
* 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.
|
|
843
853
|
* @summary Get all settings (combined)
|
|
844
854
|
* @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
|
|
845
855
|
* @param {*} [options] Override http request option.
|
|
@@ -875,7 +885,7 @@ export interface AdminSettingsApiInterface {
|
|
|
875
885
|
*/
|
|
876
886
|
adminSettingsBrandingGet(requestParameters: AdminSettingsApiAdminSettingsBrandingGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminSettingsBrandingGetResponse>;
|
|
877
887
|
/**
|
|
878
|
-
*
|
|
888
|
+
* 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.
|
|
879
889
|
* @summary Get email settings
|
|
880
890
|
* @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
|
|
881
891
|
* @param {*} [options] Override http request option.
|
|
@@ -947,7 +957,7 @@ export interface AdminSettingsApiInterface {
|
|
|
947
957
|
*/
|
|
948
958
|
patchAdminSettingsAuthenticationUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsAuthenticationUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsAuthenticationUpdateResponse>;
|
|
949
959
|
/**
|
|
950
|
-
*
|
|
960
|
+
* 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.
|
|
951
961
|
* @summary Update branding/login page settings
|
|
952
962
|
* @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
953
963
|
* @param {*} [options] Override http request option.
|
|
@@ -956,7 +966,7 @@ export interface AdminSettingsApiInterface {
|
|
|
956
966
|
*/
|
|
957
967
|
patchAdminSettingsBrandingUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsBrandingUpdateResponse>;
|
|
958
968
|
/**
|
|
959
|
-
*
|
|
969
|
+
* 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.
|
|
960
970
|
* @summary Update email settings
|
|
961
971
|
* @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
962
972
|
* @param {*} [options] Override http request option.
|
|
@@ -965,7 +975,7 @@ export interface AdminSettingsApiInterface {
|
|
|
965
975
|
*/
|
|
966
976
|
patchAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsEmailUpdateResponse>;
|
|
967
977
|
/**
|
|
968
|
-
*
|
|
978
|
+
* 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.
|
|
969
979
|
* @summary Update general settings
|
|
970
980
|
* @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
971
981
|
* @param {*} [options] Override http request option.
|
|
@@ -1028,7 +1038,7 @@ export interface AdminSettingsApiInterface {
|
|
|
1028
1038
|
*/
|
|
1029
1039
|
putAdminSettingsAuthenticationUpdate(requestParameters: AdminSettingsApiPutAdminSettingsAuthenticationUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsAuthenticationUpdateResponse>;
|
|
1030
1040
|
/**
|
|
1031
|
-
*
|
|
1041
|
+
* 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.
|
|
1032
1042
|
* @summary Update branding/login page settings
|
|
1033
1043
|
* @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
1034
1044
|
* @param {*} [options] Override http request option.
|
|
@@ -1037,7 +1047,7 @@ export interface AdminSettingsApiInterface {
|
|
|
1037
1047
|
*/
|
|
1038
1048
|
putAdminSettingsBrandingUpdate(requestParameters: AdminSettingsApiPutAdminSettingsBrandingUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsBrandingUpdateResponse>;
|
|
1039
1049
|
/**
|
|
1040
|
-
*
|
|
1050
|
+
* 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.
|
|
1041
1051
|
* @summary Update email settings
|
|
1042
1052
|
* @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
1043
1053
|
* @param {*} [options] Override http request option.
|
|
@@ -1046,7 +1056,7 @@ export interface AdminSettingsApiInterface {
|
|
|
1046
1056
|
*/
|
|
1047
1057
|
putAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsEmailUpdateResponse>;
|
|
1048
1058
|
/**
|
|
1049
|
-
*
|
|
1059
|
+
* 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.
|
|
1050
1060
|
* @summary Update general settings
|
|
1051
1061
|
* @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
1052
1062
|
* @param {*} [options] Override http request option.
|
|
@@ -1327,6 +1337,12 @@ export interface AdminSettingsApiPatchAdminSettingsEmailUpdateRequest {
|
|
|
1327
1337
|
* @memberof AdminSettingsApiPatchAdminSettingsEmailUpdate
|
|
1328
1338
|
*/
|
|
1329
1339
|
readonly orgId: string;
|
|
1340
|
+
/**
|
|
1341
|
+
*
|
|
1342
|
+
* @type {PutAdminSettingsEmailUpdateRequest}
|
|
1343
|
+
* @memberof AdminSettingsApiPatchAdminSettingsEmailUpdate
|
|
1344
|
+
*/
|
|
1345
|
+
readonly putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest;
|
|
1330
1346
|
}
|
|
1331
1347
|
/**
|
|
1332
1348
|
* Request parameters for patchAdminSettingsGeneralUpdate operation in AdminSettingsApi.
|
|
@@ -1340,6 +1356,12 @@ export interface AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest {
|
|
|
1340
1356
|
* @memberof AdminSettingsApiPatchAdminSettingsGeneralUpdate
|
|
1341
1357
|
*/
|
|
1342
1358
|
readonly orgId: string;
|
|
1359
|
+
/**
|
|
1360
|
+
*
|
|
1361
|
+
* @type {PutAdminSettingsGeneralUpdateRequest}
|
|
1362
|
+
* @memberof AdminSettingsApiPatchAdminSettingsGeneralUpdate
|
|
1363
|
+
*/
|
|
1364
|
+
readonly putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest;
|
|
1343
1365
|
}
|
|
1344
1366
|
/**
|
|
1345
1367
|
* Request parameters for patchAdminSettingsScimUpdate operation in AdminSettingsApi.
|
|
@@ -1444,6 +1466,12 @@ export interface AdminSettingsApiPutAdminSettingsEmailUpdateRequest {
|
|
|
1444
1466
|
* @memberof AdminSettingsApiPutAdminSettingsEmailUpdate
|
|
1445
1467
|
*/
|
|
1446
1468
|
readonly orgId: string;
|
|
1469
|
+
/**
|
|
1470
|
+
*
|
|
1471
|
+
* @type {PutAdminSettingsEmailUpdateRequest}
|
|
1472
|
+
* @memberof AdminSettingsApiPutAdminSettingsEmailUpdate
|
|
1473
|
+
*/
|
|
1474
|
+
readonly putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest;
|
|
1447
1475
|
}
|
|
1448
1476
|
/**
|
|
1449
1477
|
* Request parameters for putAdminSettingsGeneralUpdate operation in AdminSettingsApi.
|
|
@@ -1457,6 +1485,12 @@ export interface AdminSettingsApiPutAdminSettingsGeneralUpdateRequest {
|
|
|
1457
1485
|
* @memberof AdminSettingsApiPutAdminSettingsGeneralUpdate
|
|
1458
1486
|
*/
|
|
1459
1487
|
readonly orgId: string;
|
|
1488
|
+
/**
|
|
1489
|
+
*
|
|
1490
|
+
* @type {PutAdminSettingsGeneralUpdateRequest}
|
|
1491
|
+
* @memberof AdminSettingsApiPutAdminSettingsGeneralUpdate
|
|
1492
|
+
*/
|
|
1493
|
+
readonly putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest;
|
|
1460
1494
|
}
|
|
1461
1495
|
/**
|
|
1462
1496
|
* Request parameters for putAdminSettingsScimUpdate operation in AdminSettingsApi.
|
|
@@ -1541,7 +1575,7 @@ export declare class AdminSettingsApi extends BaseAPI implements AdminSettingsAp
|
|
|
1541
1575
|
*/
|
|
1542
1576
|
adminOrganizationGet(requestParameters: AdminSettingsApiAdminOrganizationGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminTenantGetResponse, any, {}>>;
|
|
1543
1577
|
/**
|
|
1544
|
-
*
|
|
1578
|
+
* 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.
|
|
1545
1579
|
* @summary Get all settings (combined)
|
|
1546
1580
|
* @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
|
|
1547
1581
|
* @param {*} [options] Override http request option.
|
|
@@ -1577,7 +1611,7 @@ export declare class AdminSettingsApi extends BaseAPI implements AdminSettingsAp
|
|
|
1577
1611
|
*/
|
|
1578
1612
|
adminSettingsBrandingGet(requestParameters: AdminSettingsApiAdminSettingsBrandingGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminSettingsBrandingGetResponse, any, {}>>;
|
|
1579
1613
|
/**
|
|
1580
|
-
*
|
|
1614
|
+
* 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.
|
|
1581
1615
|
* @summary Get email settings
|
|
1582
1616
|
* @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
|
|
1583
1617
|
* @param {*} [options] Override http request option.
|
|
@@ -1649,7 +1683,7 @@ export declare class AdminSettingsApi extends BaseAPI implements AdminSettingsAp
|
|
|
1649
1683
|
*/
|
|
1650
1684
|
patchAdminSettingsAuthenticationUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsAuthenticationUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PutAdminSettingsAuthenticationUpdateResponse, any, {}>>;
|
|
1651
1685
|
/**
|
|
1652
|
-
*
|
|
1686
|
+
* 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.
|
|
1653
1687
|
* @summary Update branding/login page settings
|
|
1654
1688
|
* @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
1655
1689
|
* @param {*} [options] Override http request option.
|
|
@@ -1658,7 +1692,7 @@ export declare class AdminSettingsApi extends BaseAPI implements AdminSettingsAp
|
|
|
1658
1692
|
*/
|
|
1659
1693
|
patchAdminSettingsBrandingUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PutAdminSettingsBrandingUpdateResponse, any, {}>>;
|
|
1660
1694
|
/**
|
|
1661
|
-
*
|
|
1695
|
+
* 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.
|
|
1662
1696
|
* @summary Update email settings
|
|
1663
1697
|
* @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
1664
1698
|
* @param {*} [options] Override http request option.
|
|
@@ -1667,7 +1701,7 @@ export declare class AdminSettingsApi extends BaseAPI implements AdminSettingsAp
|
|
|
1667
1701
|
*/
|
|
1668
1702
|
patchAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PutAdminSettingsEmailUpdateResponse, any, {}>>;
|
|
1669
1703
|
/**
|
|
1670
|
-
*
|
|
1704
|
+
* 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.
|
|
1671
1705
|
* @summary Update general settings
|
|
1672
1706
|
* @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
1673
1707
|
* @param {*} [options] Override http request option.
|
|
@@ -1730,7 +1764,7 @@ export declare class AdminSettingsApi extends BaseAPI implements AdminSettingsAp
|
|
|
1730
1764
|
*/
|
|
1731
1765
|
putAdminSettingsAuthenticationUpdate(requestParameters: AdminSettingsApiPutAdminSettingsAuthenticationUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PutAdminSettingsAuthenticationUpdateResponse, any, {}>>;
|
|
1732
1766
|
/**
|
|
1733
|
-
*
|
|
1767
|
+
* 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.
|
|
1734
1768
|
* @summary Update branding/login page settings
|
|
1735
1769
|
* @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
1736
1770
|
* @param {*} [options] Override http request option.
|
|
@@ -1739,7 +1773,7 @@ export declare class AdminSettingsApi extends BaseAPI implements AdminSettingsAp
|
|
|
1739
1773
|
*/
|
|
1740
1774
|
putAdminSettingsBrandingUpdate(requestParameters: AdminSettingsApiPutAdminSettingsBrandingUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PutAdminSettingsBrandingUpdateResponse, any, {}>>;
|
|
1741
1775
|
/**
|
|
1742
|
-
*
|
|
1776
|
+
* 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.
|
|
1743
1777
|
* @summary Update email settings
|
|
1744
1778
|
* @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
1745
1779
|
* @param {*} [options] Override http request option.
|
|
@@ -1748,7 +1782,7 @@ export declare class AdminSettingsApi extends BaseAPI implements AdminSettingsAp
|
|
|
1748
1782
|
*/
|
|
1749
1783
|
putAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PutAdminSettingsEmailUpdateResponse, any, {}>>;
|
|
1750
1784
|
/**
|
|
1751
|
-
*
|
|
1785
|
+
* 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.
|
|
1752
1786
|
* @summary Update general settings
|
|
1753
1787
|
* @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
1754
1788
|
* @param {*} [options] Override http request option.
|