@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
@@ -33,7 +33,7 @@ export declare const AdminGroupsApiAxiosParamCreator: (configuration?: Configura
33
33
  */
34
34
  adminGroupsAddMembers: (orgId: string, groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
35
35
  /**
36
- *
36
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
37
37
  * @summary Add a single role to a group
38
38
  * @param {string} orgId
39
39
  * @param {string} groupId
@@ -42,7 +42,7 @@ export declare const AdminGroupsApiAxiosParamCreator: (configuration?: Configura
42
42
  */
43
43
  adminGroupsAddRole: (orgId: string, groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
44
  /**
45
- *
45
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
46
46
  * @summary Create a new group
47
47
  * @param {string} orgId
48
48
  * @param {*} [options] Override http request option.
@@ -114,7 +114,7 @@ export declare const AdminGroupsApiAxiosParamCreator: (configuration?: Configura
114
114
  */
115
115
  adminGroupsRemoveRole: (orgId: string, groupId: string, roleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
116
116
  /**
117
- *
117
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
118
118
  * @summary Update group roles (replaces all existing roles)
119
119
  * @param {string} orgId
120
120
  * @param {string} groupId
@@ -156,7 +156,7 @@ export declare const AdminGroupsApiFp: (configuration?: Configuration) => {
156
156
  */
157
157
  adminGroupsAddMembers(orgId: string, groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminGroupsCreateResponse>>;
158
158
  /**
159
- *
159
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
160
160
  * @summary Add a single role to a group
161
161
  * @param {string} orgId
162
162
  * @param {string} groupId
@@ -165,7 +165,7 @@ export declare const AdminGroupsApiFp: (configuration?: Configuration) => {
165
165
  */
166
166
  adminGroupsAddRole(orgId: string, groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
167
167
  /**
168
- *
168
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
169
169
  * @summary Create a new group
170
170
  * @param {string} orgId
171
171
  * @param {*} [options] Override http request option.
@@ -237,7 +237,7 @@ export declare const AdminGroupsApiFp: (configuration?: Configuration) => {
237
237
  */
238
238
  adminGroupsRemoveRole(orgId: string, groupId: string, roleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
239
239
  /**
240
- *
240
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
241
241
  * @summary Update group roles (replaces all existing roles)
242
242
  * @param {string} orgId
243
243
  * @param {string} groupId
@@ -278,7 +278,7 @@ export declare const AdminGroupsApiFactory: (configuration?: Configuration, base
278
278
  */
279
279
  adminGroupsAddMembers(requestParameters: AdminGroupsApiAdminGroupsAddMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminGroupsCreateResponse>;
280
280
  /**
281
- *
281
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
282
282
  * @summary Add a single role to a group
283
283
  * @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
284
284
  * @param {*} [options] Override http request option.
@@ -286,7 +286,7 @@ export declare const AdminGroupsApiFactory: (configuration?: Configuration, base
286
286
  */
287
287
  adminGroupsAddRole(requestParameters: AdminGroupsApiAdminGroupsAddRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
288
288
  /**
289
- *
289
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
290
290
  * @summary Create a new group
291
291
  * @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
292
292
  * @param {*} [options] Override http request option.
@@ -350,7 +350,7 @@ export declare const AdminGroupsApiFactory: (configuration?: Configuration, base
350
350
  */
351
351
  adminGroupsRemoveRole(requestParameters: AdminGroupsApiAdminGroupsRemoveRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
352
352
  /**
353
- *
353
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
354
354
  * @summary Update group roles (replaces all existing roles)
355
355
  * @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
356
356
  * @param {*} [options] Override http request option.
@@ -390,7 +390,7 @@ export interface AdminGroupsApiInterface {
390
390
  */
391
391
  adminGroupsAddMembers(requestParameters: AdminGroupsApiAdminGroupsAddMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminGroupsCreateResponse>;
392
392
  /**
393
- *
393
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
394
394
  * @summary Add a single role to a group
395
395
  * @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
396
396
  * @param {*} [options] Override http request option.
@@ -399,7 +399,7 @@ export interface AdminGroupsApiInterface {
399
399
  */
400
400
  adminGroupsAddRole(requestParameters: AdminGroupsApiAdminGroupsAddRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
401
401
  /**
402
- *
402
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
403
403
  * @summary Create a new group
404
404
  * @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
405
405
  * @param {*} [options] Override http request option.
@@ -471,7 +471,7 @@ export interface AdminGroupsApiInterface {
471
471
  */
472
472
  adminGroupsRemoveRole(requestParameters: AdminGroupsApiAdminGroupsRemoveRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
473
473
  /**
474
- *
474
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
475
475
  * @summary Update group roles (replaces all existing roles)
476
476
  * @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
477
477
  * @param {*} [options] Override http request option.
@@ -762,7 +762,7 @@ export declare class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInt
762
762
  */
763
763
  adminGroupsAddMembers(requestParameters: AdminGroupsApiAdminGroupsAddMembersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminGroupsCreateResponse, any, {}>>;
764
764
  /**
765
- *
765
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
766
766
  * @summary Add a single role to a group
767
767
  * @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
768
768
  * @param {*} [options] Override http request option.
@@ -771,7 +771,7 @@ export declare class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInt
771
771
  */
772
772
  adminGroupsAddRole(requestParameters: AdminGroupsApiAdminGroupsAddRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
773
773
  /**
774
- *
774
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
775
775
  * @summary Create a new group
776
776
  * @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
777
777
  * @param {*} [options] Override http request option.
@@ -843,7 +843,7 @@ export declare class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInt
843
843
  */
844
844
  adminGroupsRemoveRole(requestParameters: AdminGroupsApiAdminGroupsRemoveRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
845
845
  /**
846
- *
846
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
847
847
  * @summary Update group roles (replaces all existing roles)
848
848
  * @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
849
849
  * @param {*} [options] Override http request option.
@@ -74,7 +74,7 @@ const AdminGroupsApiAxiosParamCreator = function (configuration) {
74
74
  };
75
75
  }),
76
76
  /**
77
- *
77
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
78
78
  * @summary Add a single role to a group
79
79
  * @param {string} orgId
80
80
  * @param {string} groupId
@@ -112,7 +112,7 @@ const AdminGroupsApiAxiosParamCreator = function (configuration) {
112
112
  };
113
113
  }),
114
114
  /**
115
- *
115
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
116
116
  * @summary Create a new group
117
117
  * @param {string} orgId
118
118
  * @param {*} [options] Override http request option.
@@ -416,7 +416,7 @@ const AdminGroupsApiAxiosParamCreator = function (configuration) {
416
416
  };
417
417
  }),
418
418
  /**
419
- *
419
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
420
420
  * @summary Update group roles (replaces all existing roles)
421
421
  * @param {string} orgId
422
422
  * @param {string} groupId
@@ -557,7 +557,7 @@ const AdminGroupsApiFp = function (configuration) {
557
557
  });
558
558
  },
559
559
  /**
560
- *
560
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
561
561
  * @summary Add a single role to a group
562
562
  * @param {string} orgId
563
563
  * @param {string} groupId
@@ -574,7 +574,7 @@ const AdminGroupsApiFp = function (configuration) {
574
574
  });
575
575
  },
576
576
  /**
577
- *
577
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
578
578
  * @summary Create a new group
579
579
  * @param {string} orgId
580
580
  * @param {*} [options] Override http request option.
@@ -710,7 +710,7 @@ const AdminGroupsApiFp = function (configuration) {
710
710
  });
711
711
  },
712
712
  /**
713
- *
713
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
714
714
  * @summary Update group roles (replaces all existing roles)
715
715
  * @param {string} orgId
716
716
  * @param {string} groupId
@@ -781,7 +781,7 @@ const AdminGroupsApiFactory = function (configuration, basePath, axios) {
781
781
  return localVarFp.adminGroupsAddMembers(requestParameters.orgId, requestParameters.groupId, options).then((request) => request(axios, basePath));
782
782
  },
783
783
  /**
784
- *
784
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
785
785
  * @summary Add a single role to a group
786
786
  * @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
787
787
  * @param {*} [options] Override http request option.
@@ -791,7 +791,7 @@ const AdminGroupsApiFactory = function (configuration, basePath, axios) {
791
791
  return localVarFp.adminGroupsAddRole(requestParameters.orgId, requestParameters.groupId, options).then((request) => request(axios, basePath));
792
792
  },
793
793
  /**
794
- *
794
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
795
795
  * @summary Create a new group
796
796
  * @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
797
797
  * @param {*} [options] Override http request option.
@@ -871,7 +871,7 @@ const AdminGroupsApiFactory = function (configuration, basePath, axios) {
871
871
  return localVarFp.adminGroupsRemoveRole(requestParameters.orgId, requestParameters.groupId, requestParameters.roleId, options).then((request) => request(axios, basePath));
872
872
  },
873
873
  /**
874
- *
874
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
875
875
  * @summary Update group roles (replaces all existing roles)
876
876
  * @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
877
877
  * @param {*} [options] Override http request option.
@@ -922,7 +922,7 @@ class AdminGroupsApi extends base_1.BaseAPI {
922
922
  return (0, exports.AdminGroupsApiFp)(this.configuration).adminGroupsAddMembers(requestParameters.orgId, requestParameters.groupId, options).then((request) => request(this.axios, this.basePath));
923
923
  }
924
924
  /**
925
- *
925
+ * A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
926
926
  * @summary Add a single role to a group
927
927
  * @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
928
928
  * @param {*} [options] Override http request option.
@@ -933,7 +933,7 @@ class AdminGroupsApi extends base_1.BaseAPI {
933
933
  return (0, exports.AdminGroupsApiFp)(this.configuration).adminGroupsAddRole(requestParameters.orgId, requestParameters.groupId, options).then((request) => request(this.axios, this.basePath));
934
934
  }
935
935
  /**
936
- *
936
+ * Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
937
937
  * @summary Create a new group
938
938
  * @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
939
939
  * @param {*} [options] Override http request option.
@@ -1021,7 +1021,7 @@ class AdminGroupsApi extends base_1.BaseAPI {
1021
1021
  return (0, exports.AdminGroupsApiFp)(this.configuration).adminGroupsRemoveRole(requestParameters.orgId, requestParameters.groupId, requestParameters.roleId, options).then((request) => request(this.axios, this.basePath));
1022
1022
  }
1023
1023
  /**
1024
- *
1024
+ * `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
1025
1025
  * @summary Update group roles (replaces all existing roles)
1026
1026
  * @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
1027
1027
  * @param {*} [options] Override http request option.
@@ -26,7 +26,7 @@ import type { UpdateMfaPolicyResponse } from '../models';
26
26
  */
27
27
  export declare const AdminMfaApiAxiosParamCreator: (configuration?: Configuration) => {
28
28
  /**
29
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
29
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
30
30
  * @summary Remove one of a user\'s authenticators
31
31
  * @param {string} orgId
32
32
  * @param {string} userId
@@ -36,7 +36,7 @@ export declare const AdminMfaApiAxiosParamCreator: (configuration?: Configuratio
36
36
  */
37
37
  deleteUserAuthenticator: (orgId: string, userId: string, authenticatorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
38
  /**
39
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
39
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
40
40
  * @summary MFA enrollment coverage
41
41
  * @param {string} orgId
42
42
  * @param {*} [options] Override http request option.
@@ -86,7 +86,7 @@ export declare const AdminMfaApiAxiosParamCreator: (configuration?: Configuratio
86
86
  */
87
87
  export declare const AdminMfaApiFp: (configuration?: Configuration) => {
88
88
  /**
89
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
89
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
90
90
  * @summary Remove one of a user\'s authenticators
91
91
  * @param {string} orgId
92
92
  * @param {string} userId
@@ -96,7 +96,7 @@ export declare const AdminMfaApiFp: (configuration?: Configuration) => {
96
96
  */
97
97
  deleteUserAuthenticator(orgId: string, userId: string, authenticatorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserAuthenticatorResponse>>;
98
98
  /**
99
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
99
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
100
100
  * @summary MFA enrollment coverage
101
101
  * @param {string} orgId
102
102
  * @param {*} [options] Override http request option.
@@ -146,7 +146,7 @@ export declare const AdminMfaApiFp: (configuration?: Configuration) => {
146
146
  */
147
147
  export declare const AdminMfaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
148
148
  /**
149
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
149
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
150
150
  * @summary Remove one of a user\'s authenticators
151
151
  * @param {AdminMfaApiDeleteUserAuthenticatorRequest} requestParameters Request parameters.
152
152
  * @param {*} [options] Override http request option.
@@ -154,7 +154,7 @@ export declare const AdminMfaApiFactory: (configuration?: Configuration, basePat
154
154
  */
155
155
  deleteUserAuthenticator(requestParameters: AdminMfaApiDeleteUserAuthenticatorRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteUserAuthenticatorResponse>;
156
156
  /**
157
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
157
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
158
158
  * @summary MFA enrollment coverage
159
159
  * @param {AdminMfaApiGetMfaCoverageReportRequest} requestParameters Request parameters.
160
160
  * @param {*} [options] Override http request option.
@@ -201,7 +201,7 @@ export declare const AdminMfaApiFactory: (configuration?: Configuration, basePat
201
201
  */
202
202
  export interface AdminMfaApiInterface {
203
203
  /**
204
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
204
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
205
205
  * @summary Remove one of a user\'s authenticators
206
206
  * @param {AdminMfaApiDeleteUserAuthenticatorRequest} requestParameters Request parameters.
207
207
  * @param {*} [options] Override http request option.
@@ -210,7 +210,7 @@ export interface AdminMfaApiInterface {
210
210
  */
211
211
  deleteUserAuthenticator(requestParameters: AdminMfaApiDeleteUserAuthenticatorRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteUserAuthenticatorResponse>;
212
212
  /**
213
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
213
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
214
214
  * @summary MFA enrollment coverage
215
215
  * @param {AdminMfaApiGetMfaCoverageReportRequest} requestParameters Request parameters.
216
216
  * @param {*} [options] Override http request option.
@@ -377,7 +377,7 @@ export interface AdminMfaApiUpdateMfaPolicyRequest {
377
377
  */
378
378
  export declare class AdminMfaApi extends BaseAPI implements AdminMfaApiInterface {
379
379
  /**
380
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
380
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
381
381
  * @summary Remove one of a user\'s authenticators
382
382
  * @param {AdminMfaApiDeleteUserAuthenticatorRequest} requestParameters Request parameters.
383
383
  * @param {*} [options] Override http request option.
@@ -386,7 +386,7 @@ export declare class AdminMfaApi extends BaseAPI implements AdminMfaApiInterface
386
386
  */
387
387
  deleteUserAuthenticator(requestParameters: AdminMfaApiDeleteUserAuthenticatorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteUserAuthenticatorResponse, any, {}>>;
388
388
  /**
389
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
389
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
390
390
  * @summary MFA enrollment coverage
391
391
  * @param {AdminMfaApiGetMfaCoverageReportRequest} requestParameters Request parameters.
392
392
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ const base_1 = require("../base");
36
36
  const AdminMfaApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
39
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
40
40
  * @summary Remove one of a user\'s authenticators
41
41
  * @param {string} orgId
42
42
  * @param {string} userId
@@ -78,7 +78,7 @@ const AdminMfaApiAxiosParamCreator = function (configuration) {
78
78
  };
79
79
  }),
80
80
  /**
81
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
81
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
82
82
  * @summary MFA enrollment coverage
83
83
  * @param {string} orgId
84
84
  * @param {*} [options] Override http request option.
@@ -276,7 +276,7 @@ const AdminMfaApiFp = function (configuration) {
276
276
  const localVarAxiosParamCreator = (0, exports.AdminMfaApiAxiosParamCreator)(configuration);
277
277
  return {
278
278
  /**
279
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
279
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
280
280
  * @summary Remove one of a user\'s authenticators
281
281
  * @param {string} orgId
282
282
  * @param {string} userId
@@ -294,7 +294,7 @@ const AdminMfaApiFp = function (configuration) {
294
294
  });
295
295
  },
296
296
  /**
297
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
297
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
298
298
  * @summary MFA enrollment coverage
299
299
  * @param {string} orgId
300
300
  * @param {*} [options] Override http request option.
@@ -388,7 +388,7 @@ const AdminMfaApiFactory = function (configuration, basePath, axios) {
388
388
  const localVarFp = (0, exports.AdminMfaApiFp)(configuration);
389
389
  return {
390
390
  /**
391
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
391
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
392
392
  * @summary Remove one of a user\'s authenticators
393
393
  * @param {AdminMfaApiDeleteUserAuthenticatorRequest} requestParameters Request parameters.
394
394
  * @param {*} [options] Override http request option.
@@ -398,7 +398,7 @@ const AdminMfaApiFactory = function (configuration, basePath, axios) {
398
398
  return localVarFp.deleteUserAuthenticator(requestParameters.orgId, requestParameters.userId, requestParameters.authenticatorId, options).then((request) => request(axios, basePath));
399
399
  },
400
400
  /**
401
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
401
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
402
402
  * @summary MFA enrollment coverage
403
403
  * @param {AdminMfaApiGetMfaCoverageReportRequest} requestParameters Request parameters.
404
404
  * @param {*} [options] Override http request option.
@@ -458,7 +458,7 @@ exports.AdminMfaApiFactory = AdminMfaApiFactory;
458
458
  */
459
459
  class AdminMfaApi extends base_1.BaseAPI {
460
460
  /**
461
- * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
461
+ * Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
462
462
  * @summary Remove one of a user\'s authenticators
463
463
  * @param {AdminMfaApiDeleteUserAuthenticatorRequest} requestParameters Request parameters.
464
464
  * @param {*} [options] Override http request option.
@@ -469,7 +469,7 @@ class AdminMfaApi extends base_1.BaseAPI {
469
469
  return (0, exports.AdminMfaApiFp)(this.configuration).deleteUserAuthenticator(requestParameters.orgId, requestParameters.userId, requestParameters.authenticatorId, options).then((request) => request(this.axios, this.basePath));
470
470
  }
471
471
  /**
472
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
472
+ * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
473
473
  * @summary MFA enrollment coverage
474
474
  * @param {AdminMfaApiGetMfaCoverageReportRequest} requestParameters Request parameters.
475
475
  * @param {*} [options] Override http request option.
@@ -42,7 +42,7 @@ export declare const AdminOAuthClientsApiAxiosParamCreator: (configuration?: Con
42
42
  */
43
43
  adminClientsCimdCheck: (orgId: string, adminClientsCimdCheckRequest: AdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
44
  /**
45
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
45
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
46
46
  * @summary Get an OAuth client\'s login and consent page branding
47
47
  * @param {string} orgId
48
48
  * @param {string} clientId
@@ -112,7 +112,7 @@ export declare const AdminOAuthClientsApiAxiosParamCreator: (configuration?: Con
112
112
  */
113
113
  listClients: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
114
114
  /**
115
- *
115
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
116
116
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
117
117
  * @param {string} orgId
118
118
  * @param {string} clientId
@@ -131,7 +131,7 @@ export declare const AdminOAuthClientsApiAxiosParamCreator: (configuration?: Con
131
131
  */
132
132
  patchClient: (orgId: string, clientId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
133
133
  /**
134
- *
134
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
135
135
  * @summary Replace an OAuth client\'s login and/or consent page branding
136
136
  * @param {string} orgId
137
137
  * @param {string} clientId
@@ -183,7 +183,7 @@ export declare const AdminOAuthClientsApiFp: (configuration?: Configuration) =>
183
183
  */
184
184
  adminClientsCimdCheck(orgId: string, adminClientsCimdCheckRequest: AdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminClientsCimdCheckResponse>>;
185
185
  /**
186
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
186
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
187
187
  * @summary Get an OAuth client\'s login and consent page branding
188
188
  * @param {string} orgId
189
189
  * @param {string} clientId
@@ -253,7 +253,7 @@ export declare const AdminOAuthClientsApiFp: (configuration?: Configuration) =>
253
253
  */
254
254
  listClients(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListClientsResponse>>;
255
255
  /**
256
- *
256
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
257
257
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
258
258
  * @param {string} orgId
259
259
  * @param {string} clientId
@@ -272,7 +272,7 @@ export declare const AdminOAuthClientsApiFp: (configuration?: Configuration) =>
272
272
  */
273
273
  patchClient(orgId: string, clientId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateClientResponse>>;
274
274
  /**
275
- *
275
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
276
276
  * @summary Replace an OAuth client\'s login and/or consent page branding
277
277
  * @param {string} orgId
278
278
  * @param {string} clientId
@@ -323,7 +323,7 @@ export declare const AdminOAuthClientsApiFactory: (configuration?: Configuration
323
323
  */
324
324
  adminClientsCimdCheck(requestParameters: AdminOAuthClientsApiAdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminClientsCimdCheckResponse>;
325
325
  /**
326
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
326
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
327
327
  * @summary Get an OAuth client\'s login and consent page branding
328
328
  * @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
329
329
  * @param {*} [options] Override http request option.
@@ -387,7 +387,7 @@ export declare const AdminOAuthClientsApiFactory: (configuration?: Configuration
387
387
  */
388
388
  listClients(requestParameters: AdminOAuthClientsApiListClientsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListClientsResponse>;
389
389
  /**
390
- *
390
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
391
391
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
392
392
  * @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
393
393
  * @param {*} [options] Override http request option.
@@ -403,7 +403,7 @@ export declare const AdminOAuthClientsApiFactory: (configuration?: Configuration
403
403
  */
404
404
  patchClient(requestParameters: AdminOAuthClientsApiPatchClientRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateClientResponse>;
405
405
  /**
406
- *
406
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
407
407
  * @summary Replace an OAuth client\'s login and/or consent page branding
408
408
  * @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
409
409
  * @param {*} [options] Override http request option.
@@ -451,7 +451,7 @@ export interface AdminOAuthClientsApiInterface {
451
451
  */
452
452
  adminClientsCimdCheck(requestParameters: AdminOAuthClientsApiAdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminClientsCimdCheckResponse>;
453
453
  /**
454
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
454
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
455
455
  * @summary Get an OAuth client\'s login and consent page branding
456
456
  * @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
457
457
  * @param {*} [options] Override http request option.
@@ -523,7 +523,7 @@ export interface AdminOAuthClientsApiInterface {
523
523
  */
524
524
  listClients(requestParameters: AdminOAuthClientsApiListClientsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListClientsResponse>;
525
525
  /**
526
- *
526
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
527
527
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
528
528
  * @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
529
529
  * @param {*} [options] Override http request option.
@@ -541,7 +541,7 @@ export interface AdminOAuthClientsApiInterface {
541
541
  */
542
542
  patchClient(requestParameters: AdminOAuthClientsApiPatchClientRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateClientResponse>;
543
543
  /**
544
- *
544
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
545
545
  * @summary Replace an OAuth client\'s login and/or consent page branding
546
546
  * @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
547
547
  * @param {*} [options] Override http request option.
@@ -879,7 +879,7 @@ export declare class AdminOAuthClientsApi extends BaseAPI implements AdminOAuthC
879
879
  */
880
880
  adminClientsCimdCheck(requestParameters: AdminOAuthClientsApiAdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminClientsCimdCheckResponse, any, {}>>;
881
881
  /**
882
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
882
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
883
883
  * @summary Get an OAuth client\'s login and consent page branding
884
884
  * @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
885
885
  * @param {*} [options] Override http request option.
@@ -951,7 +951,7 @@ export declare class AdminOAuthClientsApi extends BaseAPI implements AdminOAuthC
951
951
  */
952
952
  listClients(requestParameters: AdminOAuthClientsApiListClientsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListClientsResponse, any, {}>>;
953
953
  /**
954
- *
954
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
955
955
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
956
956
  * @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
957
957
  * @param {*} [options] Override http request option.
@@ -969,7 +969,7 @@ export declare class AdminOAuthClientsApi extends BaseAPI implements AdminOAuthC
969
969
  */
970
970
  patchClient(requestParameters: AdminOAuthClientsApiPatchClientRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateClientResponse, any, {}>>;
971
971
  /**
972
- *
972
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
973
973
  * @summary Replace an OAuth client\'s login and/or consent page branding
974
974
  * @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
975
975
  * @param {*} [options] Override http request option.