@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.
Files changed (248) hide show
  1. package/.openapi-generator/FILES +12 -2
  2. package/README.md +10 -3
  3. package/api/admin-abac-api.ts +18 -5
  4. package/api/admin-agents-api.ts +50 -5
  5. package/api/admin-audit-logs-api.ts +15 -15
  6. package/api/admin-email-api.ts +15 -15
  7. package/api/admin-groups-api.ts +15 -15
  8. package/api/admin-mfa-api.ts +10 -10
  9. package/api/admin-oauth-clients-api.ts +15 -15
  10. package/api/admin-roles-api.ts +20 -20
  11. package/api/admin-settings-api.ts +112 -60
  12. package/api/admin-users-api.ts +320 -31
  13. package/api/agents-api.ts +5 -5
  14. package/api/authorization-api.ts +20 -20
  15. package/api/oauth-api.ts +116 -5
  16. package/api/ssf-api.ts +10 -10
  17. package/dist/api/admin-abac-api.d.ts +10 -2
  18. package/dist/api/admin-abac-api.js +10 -5
  19. package/dist/api/admin-agents-api.d.ts +37 -2
  20. package/dist/api/admin-agents-api.js +37 -6
  21. package/dist/api/admin-audit-logs-api.d.ts +15 -15
  22. package/dist/api/admin-audit-logs-api.js +12 -12
  23. package/dist/api/admin-email-api.d.ts +15 -15
  24. package/dist/api/admin-email-api.js +12 -12
  25. package/dist/api/admin-groups-api.d.ts +15 -15
  26. package/dist/api/admin-groups-api.js +12 -12
  27. package/dist/api/admin-mfa-api.d.ts +10 -10
  28. package/dist/api/admin-mfa-api.js +8 -8
  29. package/dist/api/admin-oauth-clients-api.d.ts +15 -15
  30. package/dist/api/admin-oauth-clients-api.js +12 -12
  31. package/dist/api/admin-roles-api.d.ts +20 -20
  32. package/dist/api/admin-roles-api.js +16 -16
  33. package/dist/api/admin-settings-api.d.ts +82 -48
  34. package/dist/api/admin-settings-api.js +68 -52
  35. package/dist/api/admin-users-api.d.ts +201 -22
  36. package/dist/api/admin-users-api.js +185 -28
  37. package/dist/api/agents-api.d.ts +5 -5
  38. package/dist/api/agents-api.js +4 -4
  39. package/dist/api/authorization-api.d.ts +20 -20
  40. package/dist/api/authorization-api.js +16 -16
  41. package/dist/api/oauth-api.d.ts +70 -5
  42. package/dist/api/oauth-api.js +76 -4
  43. package/dist/api/ssf-api.d.ts +10 -10
  44. package/dist/api/ssf-api.js +8 -8
  45. package/dist/esm/api/admin-abac-api.d.ts +10 -2
  46. package/dist/esm/api/admin-abac-api.js +10 -5
  47. package/dist/esm/api/admin-agents-api.d.ts +37 -2
  48. package/dist/esm/api/admin-agents-api.js +36 -5
  49. package/dist/esm/api/admin-audit-logs-api.d.ts +15 -15
  50. package/dist/esm/api/admin-audit-logs-api.js +12 -12
  51. package/dist/esm/api/admin-email-api.d.ts +15 -15
  52. package/dist/esm/api/admin-email-api.js +12 -12
  53. package/dist/esm/api/admin-groups-api.d.ts +15 -15
  54. package/dist/esm/api/admin-groups-api.js +12 -12
  55. package/dist/esm/api/admin-mfa-api.d.ts +10 -10
  56. package/dist/esm/api/admin-mfa-api.js +8 -8
  57. package/dist/esm/api/admin-oauth-clients-api.d.ts +15 -15
  58. package/dist/esm/api/admin-oauth-clients-api.js +12 -12
  59. package/dist/esm/api/admin-roles-api.d.ts +20 -20
  60. package/dist/esm/api/admin-roles-api.js +16 -16
  61. package/dist/esm/api/admin-settings-api.d.ts +82 -48
  62. package/dist/esm/api/admin-settings-api.js +69 -53
  63. package/dist/esm/api/admin-users-api.d.ts +201 -22
  64. package/dist/esm/api/admin-users-api.js +184 -27
  65. package/dist/esm/api/agents-api.d.ts +5 -5
  66. package/dist/esm/api/agents-api.js +4 -4
  67. package/dist/esm/api/authorization-api.d.ts +20 -20
  68. package/dist/esm/api/authorization-api.js +16 -16
  69. package/dist/esm/api/oauth-api.d.ts +70 -5
  70. package/dist/esm/api/oauth-api.js +76 -4
  71. package/dist/esm/api/ssf-api.d.ts +10 -10
  72. package/dist/esm/api/ssf-api.js +8 -8
  73. package/dist/esm/models/abac-attribute-definition.d.ts +6 -0
  74. package/dist/esm/models/abac-policy.d.ts +7 -1
  75. package/dist/esm/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
  76. package/dist/esm/models/admin-groups-list-response.d.ts +6 -0
  77. package/dist/esm/models/admin-mcp-servers-list-response.d.ts +8 -3
  78. package/dist/esm/models/admin-settings-all-response-data-general.d.ts +13 -1
  79. package/dist/esm/models/admin-settings-all-response-data.d.ts +4 -5
  80. package/dist/esm/models/admin-settings-email-get-response.d.ts +4 -5
  81. package/dist/esm/models/admin-settings-general-get-response-data.d.ts +4 -10
  82. package/dist/esm/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
  83. package/dist/esm/models/ask-response.d.ts +15 -0
  84. package/dist/esm/models/ask-response.js +10 -1
  85. package/dist/esm/models/attest-response.d.ts +2 -2
  86. package/dist/esm/models/authorization-server-metadata.d.ts +8 -2
  87. package/dist/esm/models/check-email-first-request.d.ts +30 -0
  88. package/dist/esm/models/check-email-first-request.js +14 -0
  89. package/dist/esm/models/check-email-first-response.d.ts +42 -0
  90. package/dist/esm/models/check-email-first-response.js +14 -0
  91. package/dist/esm/models/email-sender-settings.d.ts +62 -0
  92. package/dist/esm/models/email-sender-settings.js +22 -0
  93. package/dist/esm/models/get-me-response.d.ts +18 -0
  94. package/dist/esm/models/get-server-challenge-response.d.ts +3 -2
  95. package/dist/esm/models/get-server-challenge-response.js +1 -0
  96. package/dist/esm/models/index.d.ts +6 -1
  97. package/dist/esm/models/index.js +6 -1
  98. package/dist/esm/models/introspect-response.d.ts +6 -0
  99. package/dist/esm/models/issue-agent-token-request.d.ts +6 -0
  100. package/dist/esm/models/list-users-response.d.ts +6 -0
  101. package/dist/esm/models/oauth-scope.d.ts +1 -7
  102. package/dist/esm/models/open-id-configuration.d.ts +3 -3
  103. package/dist/esm/models/put-admin-settings-branding-update-response.d.ts +6 -0
  104. package/dist/esm/models/put-admin-settings-email-update-request.d.ts +36 -0
  105. package/dist/esm/models/put-admin-settings-email-update-request.js +14 -0
  106. package/dist/esm/models/put-admin-settings-email-update-response.d.ts +4 -5
  107. package/dist/esm/models/put-admin-settings-general-update-request.d.ts +30 -0
  108. package/dist/esm/models/put-admin-settings-general-update-request.js +14 -0
  109. package/dist/esm/models/put-admin-settings-general-update-response-data.d.ts +1 -7
  110. package/dist/esm/models/register-client-response.d.ts +0 -24
  111. package/dist/esm/models/registered-client-metadata.d.ts +0 -24
  112. package/dist/esm/models/social-login-provider.d.ts +2 -1
  113. package/dist/esm/models/user.d.ts +12 -0
  114. package/dist/esm/models/userinfo-response.d.ts +4 -12
  115. package/dist/esm/models/userinfo-response.js +0 -2
  116. package/dist/models/abac-attribute-definition.d.ts +6 -0
  117. package/dist/models/abac-policy.d.ts +7 -1
  118. package/dist/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
  119. package/dist/models/admin-groups-list-response.d.ts +6 -0
  120. package/dist/models/admin-mcp-servers-list-response.d.ts +8 -3
  121. package/dist/models/admin-settings-all-response-data-general.d.ts +13 -1
  122. package/dist/models/admin-settings-all-response-data.d.ts +4 -5
  123. package/dist/models/admin-settings-email-get-response.d.ts +4 -5
  124. package/dist/models/admin-settings-general-get-response-data.d.ts +4 -10
  125. package/dist/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
  126. package/dist/models/ask-response.d.ts +15 -0
  127. package/dist/models/ask-response.js +11 -0
  128. package/dist/models/attest-response.d.ts +2 -2
  129. package/dist/models/authorization-server-metadata.d.ts +8 -2
  130. package/dist/models/check-email-first-request.d.ts +30 -0
  131. package/dist/models/check-email-first-request.js +15 -0
  132. package/dist/models/check-email-first-response.d.ts +42 -0
  133. package/dist/models/check-email-first-response.js +15 -0
  134. package/dist/models/email-sender-settings.d.ts +62 -0
  135. package/dist/models/email-sender-settings.js +25 -0
  136. package/dist/models/get-me-response.d.ts +18 -0
  137. package/dist/models/get-server-challenge-response.d.ts +3 -2
  138. package/dist/models/get-server-challenge-response.js +1 -0
  139. package/dist/models/index.d.ts +6 -1
  140. package/dist/models/index.js +6 -1
  141. package/dist/models/introspect-response.d.ts +6 -0
  142. package/dist/models/issue-agent-token-request.d.ts +6 -0
  143. package/dist/models/list-users-response.d.ts +6 -0
  144. package/dist/models/oauth-scope.d.ts +1 -7
  145. package/dist/models/open-id-configuration.d.ts +3 -3
  146. package/dist/models/put-admin-settings-branding-update-response.d.ts +6 -0
  147. package/dist/models/put-admin-settings-email-update-request.d.ts +36 -0
  148. package/dist/models/put-admin-settings-email-update-request.js +15 -0
  149. package/dist/models/put-admin-settings-email-update-response.d.ts +4 -5
  150. package/dist/models/put-admin-settings-general-update-request.d.ts +30 -0
  151. package/dist/models/put-admin-settings-general-update-request.js +15 -0
  152. package/dist/models/put-admin-settings-general-update-response-data.d.ts +1 -7
  153. package/dist/models/register-client-response.d.ts +0 -24
  154. package/dist/models/registered-client-metadata.d.ts +0 -24
  155. package/dist/models/social-login-provider.d.ts +2 -1
  156. package/dist/models/user.d.ts +12 -0
  157. package/dist/models/userinfo-response.d.ts +4 -12
  158. package/dist/models/userinfo-response.js +0 -2
  159. package/docs/AbacAttributeDefinition.md +2 -0
  160. package/docs/AbacPolicy.md +3 -1
  161. package/docs/AdminAbacApi.md +14 -9
  162. package/docs/AdminAgentsApi.md +7 -1
  163. package/docs/AdminAnalyticsDashboardResponseDataAudit.md +1 -1
  164. package/docs/AdminAuditLogsApi.md +3 -0
  165. package/docs/AdminEmailApi.md +3 -0
  166. package/docs/AdminGroupsApi.md +3 -0
  167. package/docs/AdminGroupsListResponse.md +2 -0
  168. package/docs/AdminMcpServersListResponse.md +3 -1
  169. package/docs/AdminMfaApi.md +4 -2
  170. package/docs/AdminOAuthClientsApi.md +3 -1
  171. package/docs/AdminOrganizationsApi.md +13 -5
  172. package/docs/AdminRolesApi.md +10 -0
  173. package/docs/AdminSettingsAllResponseData.md +1 -1
  174. package/docs/AdminSettingsAllResponseDataGeneral.md +5 -1
  175. package/docs/AdminSettingsApi.md +54 -12
  176. package/docs/AdminSettingsEmailGetResponse.md +1 -1
  177. package/docs/AdminSettingsGeneralGetResponseData.md +4 -6
  178. package/docs/AdminUsersApi.md +104 -2
  179. package/docs/AdminUsersRestoreResponse.md +22 -0
  180. package/docs/AgentsApi.md +2 -2
  181. package/docs/AskResponse.md +2 -0
  182. package/docs/AttestResponse.md +1 -1
  183. package/docs/AuthorizationApi.md +4 -4
  184. package/docs/AuthorizationServerMetadata.md +4 -2
  185. package/docs/CheckEmailFirstRequest.md +22 -0
  186. package/docs/CheckEmailFirstResponse.md +26 -0
  187. package/docs/EmailSenderSettings.md +31 -0
  188. package/docs/GetMeResponse.md +6 -0
  189. package/docs/GetServerChallengeResponse.md +1 -1
  190. package/docs/IdentityApi.md +2 -2
  191. package/docs/IntrospectResponse.md +2 -0
  192. package/docs/IssueAgentTokenRequest.md +2 -0
  193. package/docs/ListUsersResponse.md +2 -0
  194. package/docs/McpApi.md +5 -6
  195. package/docs/OAuthApi.md +72 -12
  196. package/docs/OAuthScope.md +1 -3
  197. package/docs/OIDCApi.md +4 -4
  198. package/docs/OpenIdConfiguration.md +3 -3
  199. package/docs/PutAdminSettingsBrandingUpdateResponse.md +2 -0
  200. package/docs/PutAdminSettingsEmailUpdateRequest.md +24 -0
  201. package/docs/PutAdminSettingsEmailUpdateResponse.md +1 -1
  202. package/docs/PutAdminSettingsGeneralUpdateRequest.md +22 -0
  203. package/docs/PutAdminSettingsGeneralUpdateResponseData.md +1 -3
  204. package/docs/RegisterClientResponse.md +0 -8
  205. package/docs/RegisteredClientMetadata.md +0 -8
  206. package/docs/SocialLoginProvider.md +1 -1
  207. package/docs/SsfApi.md +2 -0
  208. package/docs/User.md +4 -0
  209. package/docs/UserinfoResponse.md +3 -5
  210. package/docs/WellKnownApi.md +2 -2
  211. package/models/abac-attribute-definition.ts +6 -0
  212. package/models/abac-policy.ts +7 -1
  213. package/models/admin-analytics-dashboard-response-data-audit.ts +1 -1
  214. package/models/admin-groups-list-response.ts +6 -0
  215. package/models/admin-mcp-servers-list-response.ts +8 -5
  216. package/models/admin-settings-all-response-data-general.ts +13 -1
  217. package/models/admin-settings-all-response-data.ts +6 -3
  218. package/models/admin-settings-email-get-response.ts +6 -3
  219. package/models/admin-settings-general-get-response-data.ts +4 -10
  220. package/models/{admin-mcp-servers-list-response-meta.ts → admin-users-restore-response.ts} +11 -14
  221. package/models/ask-response.ts +17 -0
  222. package/models/attest-response.ts +2 -2
  223. package/models/authorization-server-metadata.ts +8 -2
  224. package/models/check-email-first-request.ts +36 -0
  225. package/models/check-email-first-response.ts +48 -0
  226. package/models/email-sender-settings.ts +70 -0
  227. package/models/get-me-response.ts +18 -0
  228. package/models/get-server-challenge-response.ts +3 -2
  229. package/models/index.ts +6 -1
  230. package/models/introspect-response.ts +6 -0
  231. package/models/issue-agent-token-request.ts +6 -0
  232. package/models/list-users-response.ts +6 -0
  233. package/models/oauth-scope.ts +1 -7
  234. package/models/open-id-configuration.ts +3 -3
  235. package/models/put-admin-settings-branding-update-response.ts +6 -0
  236. package/models/put-admin-settings-email-update-request.ts +42 -0
  237. package/models/put-admin-settings-email-update-response.ts +6 -3
  238. package/models/put-admin-settings-general-update-request.ts +36 -0
  239. package/models/put-admin-settings-general-update-response-data.ts +1 -7
  240. package/models/register-client-response.ts +0 -24
  241. package/models/registered-client-metadata.ts +0 -24
  242. package/models/social-login-provider.ts +2 -1
  243. package/models/user.ts +12 -0
  244. package/models/userinfo-response.ts +4 -12
  245. package/package.json +1 -1
  246. package/docs/AdminMcpServersListResponseMeta.md +0 -24
  247. /package/dist/esm/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
  248. /package/dist/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
@@ -48,8 +48,12 @@ import type { PutAdminSettingsAuthenticationUpdateResponse } from '../models';
48
48
  // @ts-ignore
49
49
  import type { PutAdminSettingsBrandingUpdateResponse } from '../models';
50
50
  // @ts-ignore
51
+ import type { PutAdminSettingsEmailUpdateRequest } from '../models';
52
+ // @ts-ignore
51
53
  import type { PutAdminSettingsEmailUpdateResponse } from '../models';
52
54
  // @ts-ignore
55
+ import type { PutAdminSettingsGeneralUpdateRequest } from '../models';
56
+ // @ts-ignore
53
57
  import type { PutAdminSettingsGeneralUpdateResponse } from '../models';
54
58
  // @ts-ignore
55
59
  import type { PutAdminSettingsScimUpdateResponse } from '../models';
@@ -238,7 +242,7 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
238
242
  };
239
243
  },
240
244
  /**
241
- *
245
+ * 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.
242
246
  * @summary Get all settings (combined)
243
247
  * @param {string} orgId
244
248
  * @param {*} [options] Override http request option.
@@ -402,7 +406,7 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
402
406
  };
403
407
  },
404
408
  /**
405
- *
409
+ * 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.
406
410
  * @summary Get email settings
407
411
  * @param {string} orgId
408
412
  * @param {*} [options] Override http request option.
@@ -730,7 +734,7 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
730
734
  };
731
735
  },
732
736
  /**
733
- *
737
+ * 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.
734
738
  * @summary Update branding/login page settings
735
739
  * @param {string} orgId
736
740
  * @param {*} [options] Override http request option.
@@ -771,13 +775,14 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
771
775
  };
772
776
  },
773
777
  /**
774
- *
778
+ * 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.
775
779
  * @summary Update email settings
776
780
  * @param {string} orgId
781
+ * @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
777
782
  * @param {*} [options] Override http request option.
778
783
  * @throws {RequiredError}
779
784
  */
780
- patchAdminSettingsEmailUpdate: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
785
+ patchAdminSettingsEmailUpdate: async (orgId: string, putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
781
786
  // verify required parameter 'orgId' is not null or undefined
782
787
  assertParamExists('patchAdminSettingsEmailUpdate', 'orgId', orgId)
783
788
  const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/email`
@@ -802,9 +807,12 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
802
807
 
803
808
 
804
809
 
810
+ localVarHeaderParameter['Content-Type'] = 'application/json';
811
+
805
812
  setSearchParams(localVarUrlObj, localVarQueryParameter);
806
813
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
807
814
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
815
+ localVarRequestOptions.data = serializeDataIfNeeded(putAdminSettingsEmailUpdateRequest, localVarRequestOptions, configuration)
808
816
 
809
817
  return {
810
818
  url: toPathString(localVarUrlObj),
@@ -812,13 +820,14 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
812
820
  };
813
821
  },
814
822
  /**
815
- *
823
+ * 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.
816
824
  * @summary Update general settings
817
825
  * @param {string} orgId
826
+ * @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
818
827
  * @param {*} [options] Override http request option.
819
828
  * @throws {RequiredError}
820
829
  */
821
- patchAdminSettingsGeneralUpdate: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
830
+ patchAdminSettingsGeneralUpdate: async (orgId: string, putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
822
831
  // verify required parameter 'orgId' is not null or undefined
823
832
  assertParamExists('patchAdminSettingsGeneralUpdate', 'orgId', orgId)
824
833
  const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/general`
@@ -843,9 +852,12 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
843
852
 
844
853
 
845
854
 
855
+ localVarHeaderParameter['Content-Type'] = 'application/json';
856
+
846
857
  setSearchParams(localVarUrlObj, localVarQueryParameter);
847
858
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
848
859
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
860
+ localVarRequestOptions.data = serializeDataIfNeeded(putAdminSettingsGeneralUpdateRequest, localVarRequestOptions, configuration)
849
861
 
850
862
  return {
851
863
  url: toPathString(localVarUrlObj),
@@ -1099,7 +1111,7 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
1099
1111
  };
1100
1112
  },
1101
1113
  /**
1102
- *
1114
+ * 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.
1103
1115
  * @summary Update branding/login page settings
1104
1116
  * @param {string} orgId
1105
1117
  * @param {*} [options] Override http request option.
@@ -1140,13 +1152,14 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
1140
1152
  };
1141
1153
  },
1142
1154
  /**
1143
- *
1155
+ * 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.
1144
1156
  * @summary Update email settings
1145
1157
  * @param {string} orgId
1158
+ * @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
1146
1159
  * @param {*} [options] Override http request option.
1147
1160
  * @throws {RequiredError}
1148
1161
  */
1149
- putAdminSettingsEmailUpdate: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1162
+ putAdminSettingsEmailUpdate: async (orgId: string, putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1150
1163
  // verify required parameter 'orgId' is not null or undefined
1151
1164
  assertParamExists('putAdminSettingsEmailUpdate', 'orgId', orgId)
1152
1165
  const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/email`
@@ -1171,9 +1184,12 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
1171
1184
 
1172
1185
 
1173
1186
 
1187
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1188
+
1174
1189
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1175
1190
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1176
1191
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1192
+ localVarRequestOptions.data = serializeDataIfNeeded(putAdminSettingsEmailUpdateRequest, localVarRequestOptions, configuration)
1177
1193
 
1178
1194
  return {
1179
1195
  url: toPathString(localVarUrlObj),
@@ -1181,13 +1197,14 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
1181
1197
  };
1182
1198
  },
1183
1199
  /**
1184
- *
1200
+ * 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.
1185
1201
  * @summary Update general settings
1186
1202
  * @param {string} orgId
1203
+ * @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
1187
1204
  * @param {*} [options] Override http request option.
1188
1205
  * @throws {RequiredError}
1189
1206
  */
1190
- putAdminSettingsGeneralUpdate: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1207
+ putAdminSettingsGeneralUpdate: async (orgId: string, putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1191
1208
  // verify required parameter 'orgId' is not null or undefined
1192
1209
  assertParamExists('putAdminSettingsGeneralUpdate', 'orgId', orgId)
1193
1210
  const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/general`
@@ -1212,9 +1229,12 @@ export const AdminSettingsApiAxiosParamCreator = function (configuration?: Confi
1212
1229
 
1213
1230
 
1214
1231
 
1232
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1233
+
1215
1234
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1216
1235
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1217
1236
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1237
+ localVarRequestOptions.data = serializeDataIfNeeded(putAdminSettingsGeneralUpdateRequest, localVarRequestOptions, configuration)
1218
1238
 
1219
1239
  return {
1220
1240
  url: toPathString(localVarUrlObj),
@@ -1409,7 +1429,7 @@ export const AdminSettingsApiFp = function(configuration?: Configuration) {
1409
1429
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1410
1430
  },
1411
1431
  /**
1412
- *
1432
+ * 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.
1413
1433
  * @summary Get all settings (combined)
1414
1434
  * @param {string} orgId
1415
1435
  * @param {*} [options] Override http request option.
@@ -1461,7 +1481,7 @@ export const AdminSettingsApiFp = function(configuration?: Configuration) {
1461
1481
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1462
1482
  },
1463
1483
  /**
1464
- *
1484
+ * 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.
1465
1485
  * @summary Get email settings
1466
1486
  * @param {string} orgId
1467
1487
  * @param {*} [options] Override http request option.
@@ -1565,7 +1585,7 @@ export const AdminSettingsApiFp = function(configuration?: Configuration) {
1565
1585
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1566
1586
  },
1567
1587
  /**
1568
- *
1588
+ * 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.
1569
1589
  * @summary Update branding/login page settings
1570
1590
  * @param {string} orgId
1571
1591
  * @param {*} [options] Override http request option.
@@ -1578,27 +1598,29 @@ export const AdminSettingsApiFp = function(configuration?: Configuration) {
1578
1598
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1579
1599
  },
1580
1600
  /**
1581
- *
1601
+ * 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.
1582
1602
  * @summary Update email settings
1583
1603
  * @param {string} orgId
1604
+ * @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
1584
1605
  * @param {*} [options] Override http request option.
1585
1606
  * @throws {RequiredError}
1586
1607
  */
1587
- async patchAdminSettingsEmailUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsEmailUpdateResponse>> {
1588
- const localVarAxiosArgs = await localVarAxiosParamCreator.patchAdminSettingsEmailUpdate(orgId, options);
1608
+ async patchAdminSettingsEmailUpdate(orgId: string, putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsEmailUpdateResponse>> {
1609
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options);
1589
1610
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1590
1611
  const localVarOperationServerBasePath = operationServerMap['AdminSettingsApi.patchAdminSettingsEmailUpdate']?.[localVarOperationServerIndex]?.url;
1591
1612
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1592
1613
  },
1593
1614
  /**
1594
- *
1615
+ * 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.
1595
1616
  * @summary Update general settings
1596
1617
  * @param {string} orgId
1618
+ * @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
1597
1619
  * @param {*} [options] Override http request option.
1598
1620
  * @throws {RequiredError}
1599
1621
  */
1600
- async patchAdminSettingsGeneralUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsGeneralUpdateResponse>> {
1601
- const localVarAxiosArgs = await localVarAxiosParamCreator.patchAdminSettingsGeneralUpdate(orgId, options);
1622
+ async patchAdminSettingsGeneralUpdate(orgId: string, putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsGeneralUpdateResponse>> {
1623
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options);
1602
1624
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1603
1625
  const localVarOperationServerBasePath = operationServerMap['AdminSettingsApi.patchAdminSettingsGeneralUpdate']?.[localVarOperationServerIndex]?.url;
1604
1626
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1682,7 +1704,7 @@ export const AdminSettingsApiFp = function(configuration?: Configuration) {
1682
1704
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1683
1705
  },
1684
1706
  /**
1685
- *
1707
+ * 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.
1686
1708
  * @summary Update branding/login page settings
1687
1709
  * @param {string} orgId
1688
1710
  * @param {*} [options] Override http request option.
@@ -1695,27 +1717,29 @@ export const AdminSettingsApiFp = function(configuration?: Configuration) {
1695
1717
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1696
1718
  },
1697
1719
  /**
1698
- *
1720
+ * 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.
1699
1721
  * @summary Update email settings
1700
1722
  * @param {string} orgId
1723
+ * @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
1701
1724
  * @param {*} [options] Override http request option.
1702
1725
  * @throws {RequiredError}
1703
1726
  */
1704
- async putAdminSettingsEmailUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsEmailUpdateResponse>> {
1705
- const localVarAxiosArgs = await localVarAxiosParamCreator.putAdminSettingsEmailUpdate(orgId, options);
1727
+ async putAdminSettingsEmailUpdate(orgId: string, putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsEmailUpdateResponse>> {
1728
+ const localVarAxiosArgs = await localVarAxiosParamCreator.putAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options);
1706
1729
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1707
1730
  const localVarOperationServerBasePath = operationServerMap['AdminSettingsApi.putAdminSettingsEmailUpdate']?.[localVarOperationServerIndex]?.url;
1708
1731
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1709
1732
  },
1710
1733
  /**
1711
- *
1734
+ * 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.
1712
1735
  * @summary Update general settings
1713
1736
  * @param {string} orgId
1737
+ * @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
1714
1738
  * @param {*} [options] Override http request option.
1715
1739
  * @throws {RequiredError}
1716
1740
  */
1717
- async putAdminSettingsGeneralUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsGeneralUpdateResponse>> {
1718
- const localVarAxiosArgs = await localVarAxiosParamCreator.putAdminSettingsGeneralUpdate(orgId, options);
1741
+ async putAdminSettingsGeneralUpdate(orgId: string, putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminSettingsGeneralUpdateResponse>> {
1742
+ const localVarAxiosArgs = await localVarAxiosParamCreator.putAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options);
1719
1743
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1720
1744
  const localVarOperationServerBasePath = operationServerMap['AdminSettingsApi.putAdminSettingsGeneralUpdate']?.[localVarOperationServerIndex]?.url;
1721
1745
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1810,7 +1834,7 @@ export const AdminSettingsApiFactory = function (configuration?: Configuration,
1810
1834
  return localVarFp.adminOrganizationGet(requestParameters.orgId, options).then((request) => request(axios, basePath));
1811
1835
  },
1812
1836
  /**
1813
- *
1837
+ * 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.
1814
1838
  * @summary Get all settings (combined)
1815
1839
  * @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
1816
1840
  * @param {*} [options] Override http request option.
@@ -1850,7 +1874,7 @@ export const AdminSettingsApiFactory = function (configuration?: Configuration,
1850
1874
  return localVarFp.adminSettingsBrandingGet(requestParameters.orgId, options).then((request) => request(axios, basePath));
1851
1875
  },
1852
1876
  /**
1853
- *
1877
+ * 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.
1854
1878
  * @summary Get email settings
1855
1879
  * @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
1856
1880
  * @param {*} [options] Override http request option.
@@ -1930,7 +1954,7 @@ export const AdminSettingsApiFactory = function (configuration?: Configuration,
1930
1954
  return localVarFp.patchAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1931
1955
  },
1932
1956
  /**
1933
- *
1957
+ * 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.
1934
1958
  * @summary Update branding/login page settings
1935
1959
  * @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
1936
1960
  * @param {*} [options] Override http request option.
@@ -1940,24 +1964,24 @@ export const AdminSettingsApiFactory = function (configuration?: Configuration,
1940
1964
  return localVarFp.patchAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1941
1965
  },
1942
1966
  /**
1943
- *
1967
+ * 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.
1944
1968
  * @summary Update email settings
1945
1969
  * @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
1946
1970
  * @param {*} [options] Override http request option.
1947
1971
  * @throws {RequiredError}
1948
1972
  */
1949
1973
  patchAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsEmailUpdateResponse> {
1950
- return localVarFp.patchAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1974
+ return localVarFp.patchAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(axios, basePath));
1951
1975
  },
1952
1976
  /**
1953
- *
1977
+ * 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.
1954
1978
  * @summary Update general settings
1955
1979
  * @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
1956
1980
  * @param {*} [options] Override http request option.
1957
1981
  * @throws {RequiredError}
1958
1982
  */
1959
1983
  patchAdminSettingsGeneralUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsGeneralUpdateResponse> {
1960
- return localVarFp.patchAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1984
+ return localVarFp.patchAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(axios, basePath));
1961
1985
  },
1962
1986
  /**
1963
1987
  *
@@ -2020,7 +2044,7 @@ export const AdminSettingsApiFactory = function (configuration?: Configuration,
2020
2044
  return localVarFp.putAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
2021
2045
  },
2022
2046
  /**
2023
- *
2047
+ * 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.
2024
2048
  * @summary Update branding/login page settings
2025
2049
  * @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
2026
2050
  * @param {*} [options] Override http request option.
@@ -2030,24 +2054,24 @@ export const AdminSettingsApiFactory = function (configuration?: Configuration,
2030
2054
  return localVarFp.putAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
2031
2055
  },
2032
2056
  /**
2033
- *
2057
+ * 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.
2034
2058
  * @summary Update email settings
2035
2059
  * @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
2036
2060
  * @param {*} [options] Override http request option.
2037
2061
  * @throws {RequiredError}
2038
2062
  */
2039
2063
  putAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsEmailUpdateResponse> {
2040
- return localVarFp.putAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
2064
+ return localVarFp.putAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(axios, basePath));
2041
2065
  },
2042
2066
  /**
2043
- *
2067
+ * 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.
2044
2068
  * @summary Update general settings
2045
2069
  * @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
2046
2070
  * @param {*} [options] Override http request option.
2047
2071
  * @throws {RequiredError}
2048
2072
  */
2049
2073
  putAdminSettingsGeneralUpdate(requestParameters: AdminSettingsApiPutAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsGeneralUpdateResponse> {
2050
- return localVarFp.putAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
2074
+ return localVarFp.putAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(axios, basePath));
2051
2075
  },
2052
2076
  /**
2053
2077
  *
@@ -2129,7 +2153,7 @@ export interface AdminSettingsApiInterface {
2129
2153
  adminOrganizationGet(requestParameters: AdminSettingsApiAdminOrganizationGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminTenantGetResponse>;
2130
2154
 
2131
2155
  /**
2132
- *
2156
+ * 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.
2133
2157
  * @summary Get all settings (combined)
2134
2158
  * @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
2135
2159
  * @param {*} [options] Override http request option.
@@ -2169,7 +2193,7 @@ export interface AdminSettingsApiInterface {
2169
2193
  adminSettingsBrandingGet(requestParameters: AdminSettingsApiAdminSettingsBrandingGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminSettingsBrandingGetResponse>;
2170
2194
 
2171
2195
  /**
2172
- *
2196
+ * 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.
2173
2197
  * @summary Get email settings
2174
2198
  * @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
2175
2199
  * @param {*} [options] Override http request option.
@@ -2249,7 +2273,7 @@ export interface AdminSettingsApiInterface {
2249
2273
  patchAdminSettingsAuthenticationUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsAuthenticationUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsAuthenticationUpdateResponse>;
2250
2274
 
2251
2275
  /**
2252
- *
2276
+ * 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.
2253
2277
  * @summary Update branding/login page settings
2254
2278
  * @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
2255
2279
  * @param {*} [options] Override http request option.
@@ -2259,7 +2283,7 @@ export interface AdminSettingsApiInterface {
2259
2283
  patchAdminSettingsBrandingUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsBrandingUpdateResponse>;
2260
2284
 
2261
2285
  /**
2262
- *
2286
+ * 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.
2263
2287
  * @summary Update email settings
2264
2288
  * @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
2265
2289
  * @param {*} [options] Override http request option.
@@ -2269,7 +2293,7 @@ export interface AdminSettingsApiInterface {
2269
2293
  patchAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsEmailUpdateResponse>;
2270
2294
 
2271
2295
  /**
2272
- *
2296
+ * 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.
2273
2297
  * @summary Update general settings
2274
2298
  * @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
2275
2299
  * @param {*} [options] Override http request option.
@@ -2339,7 +2363,7 @@ export interface AdminSettingsApiInterface {
2339
2363
  putAdminSettingsAuthenticationUpdate(requestParameters: AdminSettingsApiPutAdminSettingsAuthenticationUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsAuthenticationUpdateResponse>;
2340
2364
 
2341
2365
  /**
2342
- *
2366
+ * 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.
2343
2367
  * @summary Update branding/login page settings
2344
2368
  * @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
2345
2369
  * @param {*} [options] Override http request option.
@@ -2349,7 +2373,7 @@ export interface AdminSettingsApiInterface {
2349
2373
  putAdminSettingsBrandingUpdate(requestParameters: AdminSettingsApiPutAdminSettingsBrandingUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsBrandingUpdateResponse>;
2350
2374
 
2351
2375
  /**
2352
- *
2376
+ * 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.
2353
2377
  * @summary Update email settings
2354
2378
  * @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
2355
2379
  * @param {*} [options] Override http request option.
@@ -2359,7 +2383,7 @@ export interface AdminSettingsApiInterface {
2359
2383
  putAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminSettingsEmailUpdateResponse>;
2360
2384
 
2361
2385
  /**
2362
- *
2386
+ * 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.
2363
2387
  * @summary Update general settings
2364
2388
  * @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
2365
2389
  * @param {*} [options] Override http request option.
@@ -2664,6 +2688,13 @@ export interface AdminSettingsApiPatchAdminSettingsEmailUpdateRequest {
2664
2688
  * @memberof AdminSettingsApiPatchAdminSettingsEmailUpdate
2665
2689
  */
2666
2690
  readonly orgId: string
2691
+
2692
+ /**
2693
+ *
2694
+ * @type {PutAdminSettingsEmailUpdateRequest}
2695
+ * @memberof AdminSettingsApiPatchAdminSettingsEmailUpdate
2696
+ */
2697
+ readonly putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest
2667
2698
  }
2668
2699
 
2669
2700
  /**
@@ -2678,6 +2709,13 @@ export interface AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest {
2678
2709
  * @memberof AdminSettingsApiPatchAdminSettingsGeneralUpdate
2679
2710
  */
2680
2711
  readonly orgId: string
2712
+
2713
+ /**
2714
+ *
2715
+ * @type {PutAdminSettingsGeneralUpdateRequest}
2716
+ * @memberof AdminSettingsApiPatchAdminSettingsGeneralUpdate
2717
+ */
2718
+ readonly putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest
2681
2719
  }
2682
2720
 
2683
2721
  /**
@@ -2790,6 +2828,13 @@ export interface AdminSettingsApiPutAdminSettingsEmailUpdateRequest {
2790
2828
  * @memberof AdminSettingsApiPutAdminSettingsEmailUpdate
2791
2829
  */
2792
2830
  readonly orgId: string
2831
+
2832
+ /**
2833
+ *
2834
+ * @type {PutAdminSettingsEmailUpdateRequest}
2835
+ * @memberof AdminSettingsApiPutAdminSettingsEmailUpdate
2836
+ */
2837
+ readonly putAdminSettingsEmailUpdateRequest?: PutAdminSettingsEmailUpdateRequest
2793
2838
  }
2794
2839
 
2795
2840
  /**
@@ -2804,6 +2849,13 @@ export interface AdminSettingsApiPutAdminSettingsGeneralUpdateRequest {
2804
2849
  * @memberof AdminSettingsApiPutAdminSettingsGeneralUpdate
2805
2850
  */
2806
2851
  readonly orgId: string
2852
+
2853
+ /**
2854
+ *
2855
+ * @type {PutAdminSettingsGeneralUpdateRequest}
2856
+ * @memberof AdminSettingsApiPutAdminSettingsGeneralUpdate
2857
+ */
2858
+ readonly putAdminSettingsGeneralUpdateRequest?: PutAdminSettingsGeneralUpdateRequest
2807
2859
  }
2808
2860
 
2809
2861
  /**
@@ -2904,7 +2956,7 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
2904
2956
  }
2905
2957
 
2906
2958
  /**
2907
- *
2959
+ * 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.
2908
2960
  * @summary Get all settings (combined)
2909
2961
  * @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
2910
2962
  * @param {*} [options] Override http request option.
@@ -2952,7 +3004,7 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
2952
3004
  }
2953
3005
 
2954
3006
  /**
2955
- *
3007
+ * 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.
2956
3008
  * @summary Get email settings
2957
3009
  * @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
2958
3010
  * @param {*} [options] Override http request option.
@@ -3048,7 +3100,7 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
3048
3100
  }
3049
3101
 
3050
3102
  /**
3051
- *
3103
+ * 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.
3052
3104
  * @summary Update branding/login page settings
3053
3105
  * @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
3054
3106
  * @param {*} [options] Override http request option.
@@ -3060,7 +3112,7 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
3060
3112
  }
3061
3113
 
3062
3114
  /**
3063
- *
3115
+ * 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.
3064
3116
  * @summary Update email settings
3065
3117
  * @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
3066
3118
  * @param {*} [options] Override http request option.
@@ -3068,11 +3120,11 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
3068
3120
  * @memberof AdminSettingsApi
3069
3121
  */
3070
3122
  public patchAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig) {
3071
- return AdminSettingsApiFp(this.configuration).patchAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
3123
+ return AdminSettingsApiFp(this.configuration).patchAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3072
3124
  }
3073
3125
 
3074
3126
  /**
3075
- *
3127
+ * 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.
3076
3128
  * @summary Update general settings
3077
3129
  * @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
3078
3130
  * @param {*} [options] Override http request option.
@@ -3080,7 +3132,7 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
3080
3132
  * @memberof AdminSettingsApi
3081
3133
  */
3082
3134
  public patchAdminSettingsGeneralUpdate(requestParameters: AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig) {
3083
- return AdminSettingsApiFp(this.configuration).patchAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
3135
+ return AdminSettingsApiFp(this.configuration).patchAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3084
3136
  }
3085
3137
 
3086
3138
  /**
@@ -3156,7 +3208,7 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
3156
3208
  }
3157
3209
 
3158
3210
  /**
3159
- *
3211
+ * 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.
3160
3212
  * @summary Update branding/login page settings
3161
3213
  * @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
3162
3214
  * @param {*} [options] Override http request option.
@@ -3168,7 +3220,7 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
3168
3220
  }
3169
3221
 
3170
3222
  /**
3171
- *
3223
+ * 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.
3172
3224
  * @summary Update email settings
3173
3225
  * @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
3174
3226
  * @param {*} [options] Override http request option.
@@ -3176,11 +3228,11 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
3176
3228
  * @memberof AdminSettingsApi
3177
3229
  */
3178
3230
  public putAdminSettingsEmailUpdate(requestParameters: AdminSettingsApiPutAdminSettingsEmailUpdateRequest, options?: RawAxiosRequestConfig) {
3179
- return AdminSettingsApiFp(this.configuration).putAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
3231
+ return AdminSettingsApiFp(this.configuration).putAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3180
3232
  }
3181
3233
 
3182
3234
  /**
3183
- *
3235
+ * 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.
3184
3236
  * @summary Update general settings
3185
3237
  * @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
3186
3238
  * @param {*} [options] Override http request option.
@@ -3188,7 +3240,7 @@ export class AdminSettingsApi extends BaseAPI implements AdminSettingsApiInterfa
3188
3240
  * @memberof AdminSettingsApi
3189
3241
  */
3190
3242
  public putAdminSettingsGeneralUpdate(requestParameters: AdminSettingsApiPutAdminSettingsGeneralUpdateRequest, options?: RawAxiosRequestConfig) {
3191
- return AdminSettingsApiFp(this.configuration).putAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
3243
+ return AdminSettingsApiFp(this.configuration).putAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3192
3244
  }
3193
3245
 
3194
3246
  /**