@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
|
@@ -23,7 +23,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
23
23
|
import globalAxios from 'axios';
|
|
24
24
|
// Some imports not used depending on template conditions
|
|
25
25
|
// @ts-ignore
|
|
26
|
-
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
|
|
26
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
29
29
|
/**
|
|
@@ -177,7 +177,7 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
177
177
|
};
|
|
178
178
|
}),
|
|
179
179
|
/**
|
|
180
|
-
*
|
|
180
|
+
* 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.
|
|
181
181
|
* @summary Get all settings (combined)
|
|
182
182
|
* @param {string} orgId
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
@@ -313,7 +313,7 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
313
313
|
};
|
|
314
314
|
}),
|
|
315
315
|
/**
|
|
316
|
-
*
|
|
316
|
+
* 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.
|
|
317
317
|
* @summary Get email settings
|
|
318
318
|
* @param {string} orgId
|
|
319
319
|
* @param {*} [options] Override http request option.
|
|
@@ -585,7 +585,7 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
585
585
|
};
|
|
586
586
|
}),
|
|
587
587
|
/**
|
|
588
|
-
*
|
|
588
|
+
* 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.
|
|
589
589
|
* @summary Update branding/login page settings
|
|
590
590
|
* @param {string} orgId
|
|
591
591
|
* @param {*} [options] Override http request option.
|
|
@@ -619,13 +619,14 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
619
619
|
};
|
|
620
620
|
}),
|
|
621
621
|
/**
|
|
622
|
-
*
|
|
622
|
+
* 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.
|
|
623
623
|
* @summary Update email settings
|
|
624
624
|
* @param {string} orgId
|
|
625
|
+
* @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
|
|
625
626
|
* @param {*} [options] Override http request option.
|
|
626
627
|
* @throws {RequiredError}
|
|
627
628
|
*/
|
|
628
|
-
patchAdminSettingsEmailUpdate: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
|
|
629
|
+
patchAdminSettingsEmailUpdate: (orgId_1, putAdminSettingsEmailUpdateRequest_1, ...args_1) => __awaiter(this, [orgId_1, putAdminSettingsEmailUpdateRequest_1, ...args_1], void 0, function* (orgId, putAdminSettingsEmailUpdateRequest, options = {}) {
|
|
629
630
|
// verify required parameter 'orgId' is not null or undefined
|
|
630
631
|
assertParamExists('patchAdminSettingsEmailUpdate', 'orgId', orgId);
|
|
631
632
|
const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/email`
|
|
@@ -644,22 +645,25 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
644
645
|
// authentication BearerAuth required
|
|
645
646
|
// http bearer authentication required
|
|
646
647
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
648
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
647
649
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
648
650
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
649
651
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
652
|
+
localVarRequestOptions.data = serializeDataIfNeeded(putAdminSettingsEmailUpdateRequest, localVarRequestOptions, configuration);
|
|
650
653
|
return {
|
|
651
654
|
url: toPathString(localVarUrlObj),
|
|
652
655
|
options: localVarRequestOptions,
|
|
653
656
|
};
|
|
654
657
|
}),
|
|
655
658
|
/**
|
|
656
|
-
*
|
|
659
|
+
* 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.
|
|
657
660
|
* @summary Update general settings
|
|
658
661
|
* @param {string} orgId
|
|
662
|
+
* @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
|
|
659
663
|
* @param {*} [options] Override http request option.
|
|
660
664
|
* @throws {RequiredError}
|
|
661
665
|
*/
|
|
662
|
-
patchAdminSettingsGeneralUpdate: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
|
|
666
|
+
patchAdminSettingsGeneralUpdate: (orgId_1, putAdminSettingsGeneralUpdateRequest_1, ...args_1) => __awaiter(this, [orgId_1, putAdminSettingsGeneralUpdateRequest_1, ...args_1], void 0, function* (orgId, putAdminSettingsGeneralUpdateRequest, options = {}) {
|
|
663
667
|
// verify required parameter 'orgId' is not null or undefined
|
|
664
668
|
assertParamExists('patchAdminSettingsGeneralUpdate', 'orgId', orgId);
|
|
665
669
|
const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/general`
|
|
@@ -678,9 +682,11 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
678
682
|
// authentication BearerAuth required
|
|
679
683
|
// http bearer authentication required
|
|
680
684
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
685
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
681
686
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
682
687
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
683
688
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
689
|
+
localVarRequestOptions.data = serializeDataIfNeeded(putAdminSettingsGeneralUpdateRequest, localVarRequestOptions, configuration);
|
|
684
690
|
return {
|
|
685
691
|
url: toPathString(localVarUrlObj),
|
|
686
692
|
options: localVarRequestOptions,
|
|
@@ -891,7 +897,7 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
891
897
|
};
|
|
892
898
|
}),
|
|
893
899
|
/**
|
|
894
|
-
*
|
|
900
|
+
* 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.
|
|
895
901
|
* @summary Update branding/login page settings
|
|
896
902
|
* @param {string} orgId
|
|
897
903
|
* @param {*} [options] Override http request option.
|
|
@@ -925,13 +931,14 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
925
931
|
};
|
|
926
932
|
}),
|
|
927
933
|
/**
|
|
928
|
-
*
|
|
934
|
+
* 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.
|
|
929
935
|
* @summary Update email settings
|
|
930
936
|
* @param {string} orgId
|
|
937
|
+
* @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
|
|
931
938
|
* @param {*} [options] Override http request option.
|
|
932
939
|
* @throws {RequiredError}
|
|
933
940
|
*/
|
|
934
|
-
putAdminSettingsEmailUpdate: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
|
|
941
|
+
putAdminSettingsEmailUpdate: (orgId_1, putAdminSettingsEmailUpdateRequest_1, ...args_1) => __awaiter(this, [orgId_1, putAdminSettingsEmailUpdateRequest_1, ...args_1], void 0, function* (orgId, putAdminSettingsEmailUpdateRequest, options = {}) {
|
|
935
942
|
// verify required parameter 'orgId' is not null or undefined
|
|
936
943
|
assertParamExists('putAdminSettingsEmailUpdate', 'orgId', orgId);
|
|
937
944
|
const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/email`
|
|
@@ -950,22 +957,25 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
950
957
|
// authentication BearerAuth required
|
|
951
958
|
// http bearer authentication required
|
|
952
959
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
960
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
953
961
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
954
962
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
955
963
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
964
|
+
localVarRequestOptions.data = serializeDataIfNeeded(putAdminSettingsEmailUpdateRequest, localVarRequestOptions, configuration);
|
|
956
965
|
return {
|
|
957
966
|
url: toPathString(localVarUrlObj),
|
|
958
967
|
options: localVarRequestOptions,
|
|
959
968
|
};
|
|
960
969
|
}),
|
|
961
970
|
/**
|
|
962
|
-
*
|
|
971
|
+
* 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.
|
|
963
972
|
* @summary Update general settings
|
|
964
973
|
* @param {string} orgId
|
|
974
|
+
* @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
|
|
965
975
|
* @param {*} [options] Override http request option.
|
|
966
976
|
* @throws {RequiredError}
|
|
967
977
|
*/
|
|
968
|
-
putAdminSettingsGeneralUpdate: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
|
|
978
|
+
putAdminSettingsGeneralUpdate: (orgId_1, putAdminSettingsGeneralUpdateRequest_1, ...args_1) => __awaiter(this, [orgId_1, putAdminSettingsGeneralUpdateRequest_1, ...args_1], void 0, function* (orgId, putAdminSettingsGeneralUpdateRequest, options = {}) {
|
|
969
979
|
// verify required parameter 'orgId' is not null or undefined
|
|
970
980
|
assertParamExists('putAdminSettingsGeneralUpdate', 'orgId', orgId);
|
|
971
981
|
const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/general`
|
|
@@ -984,9 +994,11 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration) {
|
|
|
984
994
|
// authentication BearerAuth required
|
|
985
995
|
// http bearer authentication required
|
|
986
996
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
997
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
987
998
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
988
999
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
989
1000
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1001
|
+
localVarRequestOptions.data = serializeDataIfNeeded(putAdminSettingsGeneralUpdateRequest, localVarRequestOptions, configuration);
|
|
990
1002
|
return {
|
|
991
1003
|
url: toPathString(localVarUrlObj),
|
|
992
1004
|
options: localVarRequestOptions,
|
|
@@ -1170,7 +1182,7 @@ export const AdminSettingsApiFp = function (configuration) {
|
|
|
1170
1182
|
});
|
|
1171
1183
|
},
|
|
1172
1184
|
/**
|
|
1173
|
-
*
|
|
1185
|
+
* 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.
|
|
1174
1186
|
* @summary Get all settings (combined)
|
|
1175
1187
|
* @param {string} orgId
|
|
1176
1188
|
* @param {*} [options] Override http request option.
|
|
@@ -1234,7 +1246,7 @@ export const AdminSettingsApiFp = function (configuration) {
|
|
|
1234
1246
|
});
|
|
1235
1247
|
},
|
|
1236
1248
|
/**
|
|
1237
|
-
*
|
|
1249
|
+
* 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.
|
|
1238
1250
|
* @summary Get email settings
|
|
1239
1251
|
* @param {string} orgId
|
|
1240
1252
|
* @param {*} [options] Override http request option.
|
|
@@ -1362,7 +1374,7 @@ export const AdminSettingsApiFp = function (configuration) {
|
|
|
1362
1374
|
});
|
|
1363
1375
|
},
|
|
1364
1376
|
/**
|
|
1365
|
-
*
|
|
1377
|
+
* 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.
|
|
1366
1378
|
* @summary Update branding/login page settings
|
|
1367
1379
|
* @param {string} orgId
|
|
1368
1380
|
* @param {*} [options] Override http request option.
|
|
@@ -1378,32 +1390,34 @@ export const AdminSettingsApiFp = function (configuration) {
|
|
|
1378
1390
|
});
|
|
1379
1391
|
},
|
|
1380
1392
|
/**
|
|
1381
|
-
*
|
|
1393
|
+
* 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.
|
|
1382
1394
|
* @summary Update email settings
|
|
1383
1395
|
* @param {string} orgId
|
|
1396
|
+
* @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
|
|
1384
1397
|
* @param {*} [options] Override http request option.
|
|
1385
1398
|
* @throws {RequiredError}
|
|
1386
1399
|
*/
|
|
1387
|
-
patchAdminSettingsEmailUpdate(orgId, options) {
|
|
1400
|
+
patchAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options) {
|
|
1388
1401
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1389
1402
|
var _a, _b, _c;
|
|
1390
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminSettingsEmailUpdate(orgId, options);
|
|
1403
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options);
|
|
1391
1404
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1392
1405
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminSettingsApi.patchAdminSettingsEmailUpdate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1393
1406
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1394
1407
|
});
|
|
1395
1408
|
},
|
|
1396
1409
|
/**
|
|
1397
|
-
*
|
|
1410
|
+
* 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
1411
|
* @summary Update general settings
|
|
1399
1412
|
* @param {string} orgId
|
|
1413
|
+
* @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
|
|
1400
1414
|
* @param {*} [options] Override http request option.
|
|
1401
1415
|
* @throws {RequiredError}
|
|
1402
1416
|
*/
|
|
1403
|
-
patchAdminSettingsGeneralUpdate(orgId, options) {
|
|
1417
|
+
patchAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options) {
|
|
1404
1418
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1405
1419
|
var _a, _b, _c;
|
|
1406
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminSettingsGeneralUpdate(orgId, options);
|
|
1420
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options);
|
|
1407
1421
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1408
1422
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminSettingsApi.patchAdminSettingsGeneralUpdate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1409
1423
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1506,7 +1520,7 @@ export const AdminSettingsApiFp = function (configuration) {
|
|
|
1506
1520
|
});
|
|
1507
1521
|
},
|
|
1508
1522
|
/**
|
|
1509
|
-
*
|
|
1523
|
+
* 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.
|
|
1510
1524
|
* @summary Update branding/login page settings
|
|
1511
1525
|
* @param {string} orgId
|
|
1512
1526
|
* @param {*} [options] Override http request option.
|
|
@@ -1522,32 +1536,34 @@ export const AdminSettingsApiFp = function (configuration) {
|
|
|
1522
1536
|
});
|
|
1523
1537
|
},
|
|
1524
1538
|
/**
|
|
1525
|
-
*
|
|
1539
|
+
* 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.
|
|
1526
1540
|
* @summary Update email settings
|
|
1527
1541
|
* @param {string} orgId
|
|
1542
|
+
* @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
|
|
1528
1543
|
* @param {*} [options] Override http request option.
|
|
1529
1544
|
* @throws {RequiredError}
|
|
1530
1545
|
*/
|
|
1531
|
-
putAdminSettingsEmailUpdate(orgId, options) {
|
|
1546
|
+
putAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options) {
|
|
1532
1547
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1533
1548
|
var _a, _b, _c;
|
|
1534
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminSettingsEmailUpdate(orgId, options);
|
|
1549
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options);
|
|
1535
1550
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1536
1551
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminSettingsApi.putAdminSettingsEmailUpdate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1537
1552
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1538
1553
|
});
|
|
1539
1554
|
},
|
|
1540
1555
|
/**
|
|
1541
|
-
*
|
|
1556
|
+
* 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.
|
|
1542
1557
|
* @summary Update general settings
|
|
1543
1558
|
* @param {string} orgId
|
|
1559
|
+
* @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
|
|
1544
1560
|
* @param {*} [options] Override http request option.
|
|
1545
1561
|
* @throws {RequiredError}
|
|
1546
1562
|
*/
|
|
1547
|
-
putAdminSettingsGeneralUpdate(orgId, options) {
|
|
1563
|
+
putAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options) {
|
|
1548
1564
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1549
1565
|
var _a, _b, _c;
|
|
1550
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminSettingsGeneralUpdate(orgId, options);
|
|
1566
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options);
|
|
1551
1567
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1552
1568
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminSettingsApi.putAdminSettingsGeneralUpdate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1553
1569
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1651,7 +1667,7 @@ export const AdminSettingsApiFactory = function (configuration, basePath, axios)
|
|
|
1651
1667
|
return localVarFp.adminOrganizationGet(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1652
1668
|
},
|
|
1653
1669
|
/**
|
|
1654
|
-
*
|
|
1670
|
+
* 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.
|
|
1655
1671
|
* @summary Get all settings (combined)
|
|
1656
1672
|
* @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
|
|
1657
1673
|
* @param {*} [options] Override http request option.
|
|
@@ -1691,7 +1707,7 @@ export const AdminSettingsApiFactory = function (configuration, basePath, axios)
|
|
|
1691
1707
|
return localVarFp.adminSettingsBrandingGet(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1692
1708
|
},
|
|
1693
1709
|
/**
|
|
1694
|
-
*
|
|
1710
|
+
* 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.
|
|
1695
1711
|
* @summary Get email settings
|
|
1696
1712
|
* @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
|
|
1697
1713
|
* @param {*} [options] Override http request option.
|
|
@@ -1771,7 +1787,7 @@ export const AdminSettingsApiFactory = function (configuration, basePath, axios)
|
|
|
1771
1787
|
return localVarFp.patchAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1772
1788
|
},
|
|
1773
1789
|
/**
|
|
1774
|
-
*
|
|
1790
|
+
* 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.
|
|
1775
1791
|
* @summary Update branding/login page settings
|
|
1776
1792
|
* @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
1777
1793
|
* @param {*} [options] Override http request option.
|
|
@@ -1781,24 +1797,24 @@ export const AdminSettingsApiFactory = function (configuration, basePath, axios)
|
|
|
1781
1797
|
return localVarFp.patchAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1782
1798
|
},
|
|
1783
1799
|
/**
|
|
1784
|
-
*
|
|
1800
|
+
* 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.
|
|
1785
1801
|
* @summary Update email settings
|
|
1786
1802
|
* @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
1787
1803
|
* @param {*} [options] Override http request option.
|
|
1788
1804
|
* @throws {RequiredError}
|
|
1789
1805
|
*/
|
|
1790
1806
|
patchAdminSettingsEmailUpdate(requestParameters, options) {
|
|
1791
|
-
return localVarFp.patchAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1807
|
+
return localVarFp.patchAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(axios, basePath));
|
|
1792
1808
|
},
|
|
1793
1809
|
/**
|
|
1794
|
-
*
|
|
1810
|
+
* 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.
|
|
1795
1811
|
* @summary Update general settings
|
|
1796
1812
|
* @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
1797
1813
|
* @param {*} [options] Override http request option.
|
|
1798
1814
|
* @throws {RequiredError}
|
|
1799
1815
|
*/
|
|
1800
1816
|
patchAdminSettingsGeneralUpdate(requestParameters, options) {
|
|
1801
|
-
return localVarFp.patchAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1817
|
+
return localVarFp.patchAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(axios, basePath));
|
|
1802
1818
|
},
|
|
1803
1819
|
/**
|
|
1804
1820
|
*
|
|
@@ -1861,7 +1877,7 @@ export const AdminSettingsApiFactory = function (configuration, basePath, axios)
|
|
|
1861
1877
|
return localVarFp.putAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1862
1878
|
},
|
|
1863
1879
|
/**
|
|
1864
|
-
*
|
|
1880
|
+
* 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.
|
|
1865
1881
|
* @summary Update branding/login page settings
|
|
1866
1882
|
* @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
1867
1883
|
* @param {*} [options] Override http request option.
|
|
@@ -1871,24 +1887,24 @@ export const AdminSettingsApiFactory = function (configuration, basePath, axios)
|
|
|
1871
1887
|
return localVarFp.putAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1872
1888
|
},
|
|
1873
1889
|
/**
|
|
1874
|
-
*
|
|
1890
|
+
* 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.
|
|
1875
1891
|
* @summary Update email settings
|
|
1876
1892
|
* @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
1877
1893
|
* @param {*} [options] Override http request option.
|
|
1878
1894
|
* @throws {RequiredError}
|
|
1879
1895
|
*/
|
|
1880
1896
|
putAdminSettingsEmailUpdate(requestParameters, options) {
|
|
1881
|
-
return localVarFp.putAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1897
|
+
return localVarFp.putAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(axios, basePath));
|
|
1882
1898
|
},
|
|
1883
1899
|
/**
|
|
1884
|
-
*
|
|
1900
|
+
* 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.
|
|
1885
1901
|
* @summary Update general settings
|
|
1886
1902
|
* @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
1887
1903
|
* @param {*} [options] Override http request option.
|
|
1888
1904
|
* @throws {RequiredError}
|
|
1889
1905
|
*/
|
|
1890
1906
|
putAdminSettingsGeneralUpdate(requestParameters, options) {
|
|
1891
|
-
return localVarFp.putAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1907
|
+
return localVarFp.putAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(axios, basePath));
|
|
1892
1908
|
},
|
|
1893
1909
|
/**
|
|
1894
1910
|
*
|
|
@@ -1974,7 +1990,7 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
1974
1990
|
return AdminSettingsApiFp(this.configuration).adminOrganizationGet(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1975
1991
|
}
|
|
1976
1992
|
/**
|
|
1977
|
-
*
|
|
1993
|
+
* 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.
|
|
1978
1994
|
* @summary Get all settings (combined)
|
|
1979
1995
|
* @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
|
|
1980
1996
|
* @param {*} [options] Override http request option.
|
|
@@ -2018,7 +2034,7 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2018
2034
|
return AdminSettingsApiFp(this.configuration).adminSettingsBrandingGet(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2019
2035
|
}
|
|
2020
2036
|
/**
|
|
2021
|
-
*
|
|
2037
|
+
* 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.
|
|
2022
2038
|
* @summary Get email settings
|
|
2023
2039
|
* @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
|
|
2024
2040
|
* @param {*} [options] Override http request option.
|
|
@@ -2106,7 +2122,7 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2106
2122
|
return AdminSettingsApiFp(this.configuration).patchAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2107
2123
|
}
|
|
2108
2124
|
/**
|
|
2109
|
-
*
|
|
2125
|
+
* 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.
|
|
2110
2126
|
* @summary Update branding/login page settings
|
|
2111
2127
|
* @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
2112
2128
|
* @param {*} [options] Override http request option.
|
|
@@ -2117,7 +2133,7 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2117
2133
|
return AdminSettingsApiFp(this.configuration).patchAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2118
2134
|
}
|
|
2119
2135
|
/**
|
|
2120
|
-
*
|
|
2136
|
+
* 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.
|
|
2121
2137
|
* @summary Update email settings
|
|
2122
2138
|
* @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
2123
2139
|
* @param {*} [options] Override http request option.
|
|
@@ -2125,10 +2141,10 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2125
2141
|
* @memberof AdminSettingsApi
|
|
2126
2142
|
*/
|
|
2127
2143
|
patchAdminSettingsEmailUpdate(requestParameters, options) {
|
|
2128
|
-
return AdminSettingsApiFp(this.configuration).patchAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2144
|
+
return AdminSettingsApiFp(this.configuration).patchAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2129
2145
|
}
|
|
2130
2146
|
/**
|
|
2131
|
-
*
|
|
2147
|
+
* 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.
|
|
2132
2148
|
* @summary Update general settings
|
|
2133
2149
|
* @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
2134
2150
|
* @param {*} [options] Override http request option.
|
|
@@ -2136,7 +2152,7 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2136
2152
|
* @memberof AdminSettingsApi
|
|
2137
2153
|
*/
|
|
2138
2154
|
patchAdminSettingsGeneralUpdate(requestParameters, options) {
|
|
2139
|
-
return AdminSettingsApiFp(this.configuration).patchAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2155
|
+
return AdminSettingsApiFp(this.configuration).patchAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2140
2156
|
}
|
|
2141
2157
|
/**
|
|
2142
2158
|
*
|
|
@@ -2205,7 +2221,7 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2205
2221
|
return AdminSettingsApiFp(this.configuration).putAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2206
2222
|
}
|
|
2207
2223
|
/**
|
|
2208
|
-
*
|
|
2224
|
+
* 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.
|
|
2209
2225
|
* @summary Update branding/login page settings
|
|
2210
2226
|
* @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
|
|
2211
2227
|
* @param {*} [options] Override http request option.
|
|
@@ -2216,7 +2232,7 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2216
2232
|
return AdminSettingsApiFp(this.configuration).putAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2217
2233
|
}
|
|
2218
2234
|
/**
|
|
2219
|
-
*
|
|
2235
|
+
* 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.
|
|
2220
2236
|
* @summary Update email settings
|
|
2221
2237
|
* @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
|
|
2222
2238
|
* @param {*} [options] Override http request option.
|
|
@@ -2224,10 +2240,10 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2224
2240
|
* @memberof AdminSettingsApi
|
|
2225
2241
|
*/
|
|
2226
2242
|
putAdminSettingsEmailUpdate(requestParameters, options) {
|
|
2227
|
-
return AdminSettingsApiFp(this.configuration).putAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2243
|
+
return AdminSettingsApiFp(this.configuration).putAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2228
2244
|
}
|
|
2229
2245
|
/**
|
|
2230
|
-
*
|
|
2246
|
+
* 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.
|
|
2231
2247
|
* @summary Update general settings
|
|
2232
2248
|
* @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
|
|
2233
2249
|
* @param {*} [options] Override http request option.
|
|
@@ -2235,7 +2251,7 @@ export class AdminSettingsApi extends BaseAPI {
|
|
|
2235
2251
|
* @memberof AdminSettingsApi
|
|
2236
2252
|
*/
|
|
2237
2253
|
putAdminSettingsGeneralUpdate(requestParameters, options) {
|
|
2238
|
-
return AdminSettingsApiFp(this.configuration).putAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2254
|
+
return AdminSettingsApiFp(this.configuration).putAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2239
2255
|
}
|
|
2240
2256
|
/**
|
|
2241
2257
|
*
|