@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
@@ -85,7 +85,7 @@ export const AdminGroupsApiAxiosParamCreator = function (configuration?: Configu
85
85
  };
86
86
  },
87
87
  /**
88
- *
88
+ * 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).
89
89
  * @summary Add a single role to a group
90
90
  * @param {string} orgId
91
91
  * @param {string} groupId
@@ -130,7 +130,7 @@ export const AdminGroupsApiAxiosParamCreator = function (configuration?: Configu
130
130
  };
131
131
  },
132
132
  /**
133
- *
133
+ * 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).
134
134
  * @summary Create a new group
135
135
  * @param {string} orgId
136
136
  * @param {*} [options] Override http request option.
@@ -490,7 +490,7 @@ export const AdminGroupsApiAxiosParamCreator = function (configuration?: Configu
490
490
  };
491
491
  },
492
492
  /**
493
- *
493
+ * `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.
494
494
  * @summary Update group roles (replaces all existing roles)
495
495
  * @param {string} orgId
496
496
  * @param {string} groupId
@@ -649,7 +649,7 @@ export const AdminGroupsApiFp = function(configuration?: Configuration) {
649
649
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
650
650
  },
651
651
  /**
652
- *
652
+ * 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).
653
653
  * @summary Add a single role to a group
654
654
  * @param {string} orgId
655
655
  * @param {string} groupId
@@ -663,7 +663,7 @@ export const AdminGroupsApiFp = function(configuration?: Configuration) {
663
663
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
664
664
  },
665
665
  /**
666
- *
666
+ * 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).
667
667
  * @summary Create a new group
668
668
  * @param {string} orgId
669
669
  * @param {*} [options] Override http request option.
@@ -775,7 +775,7 @@ export const AdminGroupsApiFp = function(configuration?: Configuration) {
775
775
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
776
776
  },
777
777
  /**
778
- *
778
+ * `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.
779
779
  * @summary Update group roles (replaces all existing roles)
780
780
  * @param {string} orgId
781
781
  * @param {string} groupId
@@ -837,7 +837,7 @@ export const AdminGroupsApiFactory = function (configuration?: Configuration, ba
837
837
  return localVarFp.adminGroupsAddMembers(requestParameters.orgId, requestParameters.groupId, options).then((request) => request(axios, basePath));
838
838
  },
839
839
  /**
840
- *
840
+ * 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).
841
841
  * @summary Add a single role to a group
842
842
  * @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
843
843
  * @param {*} [options] Override http request option.
@@ -847,7 +847,7 @@ export const AdminGroupsApiFactory = function (configuration?: Configuration, ba
847
847
  return localVarFp.adminGroupsAddRole(requestParameters.orgId, requestParameters.groupId, options).then((request) => request(axios, basePath));
848
848
  },
849
849
  /**
850
- *
850
+ * 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).
851
851
  * @summary Create a new group
852
852
  * @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
853
853
  * @param {*} [options] Override http request option.
@@ -927,7 +927,7 @@ export const AdminGroupsApiFactory = function (configuration?: Configuration, ba
927
927
  return localVarFp.adminGroupsRemoveRole(requestParameters.orgId, requestParameters.groupId, requestParameters.roleId, options).then((request) => request(axios, basePath));
928
928
  },
929
929
  /**
930
- *
930
+ * `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.
931
931
  * @summary Update group roles (replaces all existing roles)
932
932
  * @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
933
933
  * @param {*} [options] Override http request option.
@@ -976,7 +976,7 @@ export interface AdminGroupsApiInterface {
976
976
  adminGroupsAddMembers(requestParameters: AdminGroupsApiAdminGroupsAddMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminGroupsCreateResponse>;
977
977
 
978
978
  /**
979
- *
979
+ * 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).
980
980
  * @summary Add a single role to a group
981
981
  * @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
982
982
  * @param {*} [options] Override http request option.
@@ -986,7 +986,7 @@ export interface AdminGroupsApiInterface {
986
986
  adminGroupsAddRole(requestParameters: AdminGroupsApiAdminGroupsAddRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
987
987
 
988
988
  /**
989
- *
989
+ * 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).
990
990
  * @summary Create a new group
991
991
  * @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
992
992
  * @param {*} [options] Override http request option.
@@ -1066,7 +1066,7 @@ export interface AdminGroupsApiInterface {
1066
1066
  adminGroupsRemoveRole(requestParameters: AdminGroupsApiAdminGroupsRemoveRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
1067
1067
 
1068
1068
  /**
1069
- *
1069
+ * `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.
1070
1070
  * @summary Update group roles (replaces all existing roles)
1071
1071
  * @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
1072
1072
  * @param {*} [options] Override http request option.
@@ -1390,7 +1390,7 @@ export class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInterface {
1390
1390
  }
1391
1391
 
1392
1392
  /**
1393
- *
1393
+ * 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).
1394
1394
  * @summary Add a single role to a group
1395
1395
  * @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
1396
1396
  * @param {*} [options] Override http request option.
@@ -1402,7 +1402,7 @@ export class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInterface {
1402
1402
  }
1403
1403
 
1404
1404
  /**
1405
- *
1405
+ * 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).
1406
1406
  * @summary Create a new group
1407
1407
  * @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
1408
1408
  * @param {*} [options] Override http request option.
@@ -1498,7 +1498,7 @@ export class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInterface {
1498
1498
  }
1499
1499
 
1500
1500
  /**
1501
- *
1501
+ * `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.
1502
1502
  * @summary Update group roles (replaces all existing roles)
1503
1503
  * @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
1504
1504
  * @param {*} [options] Override http request option.
@@ -44,7 +44,7 @@ import type { UpdateMfaPolicyResponse } from '../models';
44
44
  export const AdminMfaApiAxiosParamCreator = function (configuration?: Configuration) {
45
45
  return {
46
46
  /**
47
- * 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.
47
+ * 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.
48
48
  * @summary Remove one of a user\'s authenticators
49
49
  * @param {string} orgId
50
50
  * @param {string} userId
@@ -93,7 +93,7 @@ export const AdminMfaApiAxiosParamCreator = function (configuration?: Configurat
93
93
  };
94
94
  },
95
95
  /**
96
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
96
+ * 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.
97
97
  * @summary MFA enrollment coverage
98
98
  * @param {string} orgId
99
99
  * @param {*} [options] Override http request option.
@@ -328,7 +328,7 @@ export const AdminMfaApiFp = function(configuration?: Configuration) {
328
328
  const localVarAxiosParamCreator = AdminMfaApiAxiosParamCreator(configuration)
329
329
  return {
330
330
  /**
331
- * 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.
331
+ * 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.
332
332
  * @summary Remove one of a user\'s authenticators
333
333
  * @param {string} orgId
334
334
  * @param {string} userId
@@ -343,7 +343,7 @@ export const AdminMfaApiFp = function(configuration?: Configuration) {
343
343
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
344
344
  },
345
345
  /**
346
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
346
+ * 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.
347
347
  * @summary MFA enrollment coverage
348
348
  * @param {string} orgId
349
349
  * @param {*} [options] Override http request option.
@@ -422,7 +422,7 @@ export const AdminMfaApiFactory = function (configuration?: Configuration, baseP
422
422
  const localVarFp = AdminMfaApiFp(configuration)
423
423
  return {
424
424
  /**
425
- * 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.
425
+ * 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.
426
426
  * @summary Remove one of a user\'s authenticators
427
427
  * @param {AdminMfaApiDeleteUserAuthenticatorRequest} requestParameters Request parameters.
428
428
  * @param {*} [options] Override http request option.
@@ -432,7 +432,7 @@ export const AdminMfaApiFactory = function (configuration?: Configuration, baseP
432
432
  return localVarFp.deleteUserAuthenticator(requestParameters.orgId, requestParameters.userId, requestParameters.authenticatorId, options).then((request) => request(axios, basePath));
433
433
  },
434
434
  /**
435
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
435
+ * 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.
436
436
  * @summary MFA enrollment coverage
437
437
  * @param {AdminMfaApiGetMfaCoverageReportRequest} requestParameters Request parameters.
438
438
  * @param {*} [options] Override http request option.
@@ -491,7 +491,7 @@ export const AdminMfaApiFactory = function (configuration?: Configuration, baseP
491
491
  */
492
492
  export interface AdminMfaApiInterface {
493
493
  /**
494
- * 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.
494
+ * 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.
495
495
  * @summary Remove one of a user\'s authenticators
496
496
  * @param {AdminMfaApiDeleteUserAuthenticatorRequest} requestParameters Request parameters.
497
497
  * @param {*} [options] Override http request option.
@@ -501,7 +501,7 @@ export interface AdminMfaApiInterface {
501
501
  deleteUserAuthenticator(requestParameters: AdminMfaApiDeleteUserAuthenticatorRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteUserAuthenticatorResponse>;
502
502
 
503
503
  /**
504
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
504
+ * 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.
505
505
  * @summary MFA enrollment coverage
506
506
  * @param {AdminMfaApiGetMfaCoverageReportRequest} requestParameters Request parameters.
507
507
  * @param {*} [options] Override http request option.
@@ -686,7 +686,7 @@ export interface AdminMfaApiUpdateMfaPolicyRequest {
686
686
  */
687
687
  export class AdminMfaApi extends BaseAPI implements AdminMfaApiInterface {
688
688
  /**
689
- * 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.
689
+ * 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.
690
690
  * @summary Remove one of a user\'s authenticators
691
691
  * @param {AdminMfaApiDeleteUserAuthenticatorRequest} requestParameters Request parameters.
692
692
  * @param {*} [options] Override http request option.
@@ -698,7 +698,7 @@ export class AdminMfaApi extends BaseAPI implements AdminMfaApiInterface {
698
698
  }
699
699
 
700
700
  /**
701
- * Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
701
+ * 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.
702
702
  * @summary MFA enrollment coverage
703
703
  * @param {AdminMfaApiGetMfaCoverageReportRequest} requestParameters Request parameters.
704
704
  * @param {*} [options] Override http request option.
@@ -105,7 +105,7 @@ export const AdminOAuthClientsApiAxiosParamCreator = function (configuration?: C
105
105
  };
106
106
  },
107
107
  /**
108
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
108
+ * 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\".
109
109
  * @summary Get an OAuth client\'s login and consent page branding
110
110
  * @param {string} orgId
111
111
  * @param {string} clientId
@@ -457,7 +457,7 @@ export const AdminOAuthClientsApiAxiosParamCreator = function (configuration?: C
457
457
  };
458
458
  },
459
459
  /**
460
- *
460
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
461
461
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
462
462
  * @param {string} orgId
463
463
  * @param {string} clientId
@@ -551,7 +551,7 @@ export const AdminOAuthClientsApiAxiosParamCreator = function (configuration?: C
551
551
  };
552
552
  },
553
553
  /**
554
- *
554
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
555
555
  * @summary Replace an OAuth client\'s login and/or consent page branding
556
556
  * @param {string} orgId
557
557
  * @param {string} clientId
@@ -759,7 +759,7 @@ export const AdminOAuthClientsApiFp = function(configuration?: Configuration) {
759
759
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
760
760
  },
761
761
  /**
762
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
762
+ * 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\".
763
763
  * @summary Get an OAuth client\'s login and consent page branding
764
764
  * @param {string} orgId
765
765
  * @param {string} clientId
@@ -869,7 +869,7 @@ export const AdminOAuthClientsApiFp = function(configuration?: Configuration) {
869
869
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
870
870
  },
871
871
  /**
872
- *
872
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
873
873
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
874
874
  * @param {string} orgId
875
875
  * @param {string} clientId
@@ -898,7 +898,7 @@ export const AdminOAuthClientsApiFp = function(configuration?: Configuration) {
898
898
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
899
899
  },
900
900
  /**
901
- *
901
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
902
902
  * @summary Replace an OAuth client\'s login and/or consent page branding
903
903
  * @param {string} orgId
904
904
  * @param {string} clientId
@@ -975,7 +975,7 @@ export const AdminOAuthClientsApiFactory = function (configuration?: Configurati
975
975
  return localVarFp.adminClientsCimdCheck(requestParameters.orgId, requestParameters.adminClientsCimdCheckRequest, options).then((request) => request(axios, basePath));
976
976
  },
977
977
  /**
978
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
978
+ * 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\".
979
979
  * @summary Get an OAuth client\'s login and consent page branding
980
980
  * @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
981
981
  * @param {*} [options] Override http request option.
@@ -1055,7 +1055,7 @@ export const AdminOAuthClientsApiFactory = function (configuration?: Configurati
1055
1055
  return localVarFp.listClients(requestParameters.orgId, options).then((request) => request(axios, basePath));
1056
1056
  },
1057
1057
  /**
1058
- *
1058
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
1059
1059
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
1060
1060
  * @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
1061
1061
  * @param {*} [options] Override http request option.
@@ -1075,7 +1075,7 @@ export const AdminOAuthClientsApiFactory = function (configuration?: Configurati
1075
1075
  return localVarFp.patchClient(requestParameters.orgId, requestParameters.clientId, options).then((request) => request(axios, basePath));
1076
1076
  },
1077
1077
  /**
1078
- *
1078
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
1079
1079
  * @summary Replace an OAuth client\'s login and/or consent page branding
1080
1080
  * @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
1081
1081
  * @param {*} [options] Override http request option.
@@ -1134,7 +1134,7 @@ export interface AdminOAuthClientsApiInterface {
1134
1134
  adminClientsCimdCheck(requestParameters: AdminOAuthClientsApiAdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminClientsCimdCheckResponse>;
1135
1135
 
1136
1136
  /**
1137
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
1137
+ * 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\".
1138
1138
  * @summary Get an OAuth client\'s login and consent page branding
1139
1139
  * @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
1140
1140
  * @param {*} [options] Override http request option.
@@ -1214,7 +1214,7 @@ export interface AdminOAuthClientsApiInterface {
1214
1214
  listClients(requestParameters: AdminOAuthClientsApiListClientsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListClientsResponse>;
1215
1215
 
1216
1216
  /**
1217
- *
1217
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
1218
1218
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
1219
1219
  * @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
1220
1220
  * @param {*} [options] Override http request option.
@@ -1234,7 +1234,7 @@ export interface AdminOAuthClientsApiInterface {
1234
1234
  patchClient(requestParameters: AdminOAuthClientsApiPatchClientRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateClientResponse>;
1235
1235
 
1236
1236
  /**
1237
- *
1237
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
1238
1238
  * @summary Replace an OAuth client\'s login and/or consent page branding
1239
1239
  * @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
1240
1240
  * @param {*} [options] Override http request option.
@@ -1610,7 +1610,7 @@ export class AdminOAuthClientsApi extends BaseAPI implements AdminOAuthClientsAp
1610
1610
  }
1611
1611
 
1612
1612
  /**
1613
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
1613
+ * 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\".
1614
1614
  * @summary Get an OAuth client\'s login and consent page branding
1615
1615
  * @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
1616
1616
  * @param {*} [options] Override http request option.
@@ -1706,7 +1706,7 @@ export class AdminOAuthClientsApi extends BaseAPI implements AdminOAuthClientsAp
1706
1706
  }
1707
1707
 
1708
1708
  /**
1709
- *
1709
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
1710
1710
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
1711
1711
  * @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
1712
1712
  * @param {*} [options] Override http request option.
@@ -1730,7 +1730,7 @@ export class AdminOAuthClientsApi extends BaseAPI implements AdminOAuthClientsAp
1730
1730
  }
1731
1731
 
1732
1732
  /**
1733
- *
1733
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
1734
1734
  * @summary Replace an OAuth client\'s login and/or consent page branding
1735
1735
  * @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
1736
1736
  * @param {*} [options] Override http request option.
@@ -40,7 +40,7 @@ import type { MessageResponse } from '../models';
40
40
  export const AdminRolesApiAxiosParamCreator = function (configuration?: Configuration) {
41
41
  return {
42
42
  /**
43
- *
43
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
44
44
  * @summary Add permission(s) to a role
45
45
  * @param {string} orgId
46
46
  * @param {string} roleId
@@ -130,7 +130,7 @@ export const AdminRolesApiAxiosParamCreator = function (configuration?: Configur
130
130
  };
131
131
  },
132
132
  /**
133
- *
133
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
134
134
  * @summary Create a new role
135
135
  * @param {string} orgId
136
136
  * @param {*} [options] Override http request option.
@@ -392,7 +392,7 @@ export const AdminRolesApiAxiosParamCreator = function (configuration?: Configur
392
392
  };
393
393
  },
394
394
  /**
395
- *
395
+ * Needs `roles.assign-permissions` and `roles.edit`.
396
396
  * @summary Remove a permission from a role
397
397
  * @param {string} orgId
398
398
  * @param {string} roleId
@@ -490,7 +490,7 @@ export const AdminRolesApiAxiosParamCreator = function (configuration?: Configur
490
490
  };
491
491
  },
492
492
  /**
493
- *
493
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
494
494
  * @summary Update role permissions (replaces all)
495
495
  * @param {string} orgId
496
496
  * @param {string} roleId
@@ -635,7 +635,7 @@ export const AdminRolesApiFp = function(configuration?: Configuration) {
635
635
  const localVarAxiosParamCreator = AdminRolesApiAxiosParamCreator(configuration)
636
636
  return {
637
637
  /**
638
- *
638
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
639
639
  * @summary Add permission(s) to a role
640
640
  * @param {string} orgId
641
641
  * @param {string} roleId
@@ -663,7 +663,7 @@ export const AdminRolesApiFp = function(configuration?: Configuration) {
663
663
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
664
664
  },
665
665
  /**
666
- *
666
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
667
667
  * @summary Create a new role
668
668
  * @param {string} orgId
669
669
  * @param {*} [options] Override http request option.
@@ -745,7 +745,7 @@ export const AdminRolesApiFp = function(configuration?: Configuration) {
745
745
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
746
746
  },
747
747
  /**
748
- *
748
+ * Needs `roles.assign-permissions` and `roles.edit`.
749
749
  * @summary Remove a permission from a role
750
750
  * @param {string} orgId
751
751
  * @param {string} roleId
@@ -775,7 +775,7 @@ export const AdminRolesApiFp = function(configuration?: Configuration) {
775
775
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
776
776
  },
777
777
  /**
778
- *
778
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
779
779
  * @summary Update role permissions (replaces all)
780
780
  * @param {string} orgId
781
781
  * @param {string} roleId
@@ -827,7 +827,7 @@ export const AdminRolesApiFactory = function (configuration?: Configuration, bas
827
827
  const localVarFp = AdminRolesApiFp(configuration)
828
828
  return {
829
829
  /**
830
- *
830
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
831
831
  * @summary Add permission(s) to a role
832
832
  * @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
833
833
  * @param {*} [options] Override http request option.
@@ -847,7 +847,7 @@ export const AdminRolesApiFactory = function (configuration?: Configuration, bas
847
847
  return localVarFp.adminRolesAddUser(requestParameters.orgId, requestParameters.roleId, options).then((request) => request(axios, basePath));
848
848
  },
849
849
  /**
850
- *
850
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
851
851
  * @summary Create a new role
852
852
  * @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
853
853
  * @param {*} [options] Override http request option.
@@ -907,7 +907,7 @@ export const AdminRolesApiFactory = function (configuration?: Configuration, bas
907
907
  return localVarFp.adminRolesList(requestParameters.orgId, options).then((request) => request(axios, basePath));
908
908
  },
909
909
  /**
910
- *
910
+ * Needs `roles.assign-permissions` and `roles.edit`.
911
911
  * @summary Remove a permission from a role
912
912
  * @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
913
913
  * @param {*} [options] Override http request option.
@@ -927,7 +927,7 @@ export const AdminRolesApiFactory = function (configuration?: Configuration, bas
927
927
  return localVarFp.adminRolesRemoveUser(requestParameters.orgId, requestParameters.roleId, requestParameters.userId, options).then((request) => request(axios, basePath));
928
928
  },
929
929
  /**
930
- *
930
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
931
931
  * @summary Update role permissions (replaces all)
932
932
  * @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
933
933
  * @param {*} [options] Override http request option.
@@ -966,7 +966,7 @@ export const AdminRolesApiFactory = function (configuration?: Configuration, bas
966
966
  */
967
967
  export interface AdminRolesApiInterface {
968
968
  /**
969
- *
969
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
970
970
  * @summary Add permission(s) to a role
971
971
  * @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
972
972
  * @param {*} [options] Override http request option.
@@ -986,7 +986,7 @@ export interface AdminRolesApiInterface {
986
986
  adminRolesAddUser(requestParameters: AdminRolesApiAdminRolesAddUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
987
987
 
988
988
  /**
989
- *
989
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
990
990
  * @summary Create a new role
991
991
  * @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
992
992
  * @param {*} [options] Override http request option.
@@ -1046,7 +1046,7 @@ export interface AdminRolesApiInterface {
1046
1046
  adminRolesList(requestParameters: AdminRolesApiAdminRolesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminRolesListResponse>;
1047
1047
 
1048
1048
  /**
1049
- *
1049
+ * Needs `roles.assign-permissions` and `roles.edit`.
1050
1050
  * @summary Remove a permission from a role
1051
1051
  * @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
1052
1052
  * @param {*} [options] Override http request option.
@@ -1066,7 +1066,7 @@ export interface AdminRolesApiInterface {
1066
1066
  adminRolesRemoveUser(requestParameters: AdminRolesApiAdminRolesRemoveUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
1067
1067
 
1068
1068
  /**
1069
- *
1069
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
1070
1070
  * @summary Update role permissions (replaces all)
1071
1071
  * @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
1072
1072
  * @param {*} [options] Override http request option.
@@ -1378,7 +1378,7 @@ export interface AdminRolesApiPutAdminRolesUpdateRequest {
1378
1378
  */
1379
1379
  export class AdminRolesApi extends BaseAPI implements AdminRolesApiInterface {
1380
1380
  /**
1381
- *
1381
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
1382
1382
  * @summary Add permission(s) to a role
1383
1383
  * @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
1384
1384
  * @param {*} [options] Override http request option.
@@ -1402,7 +1402,7 @@ export class AdminRolesApi extends BaseAPI implements AdminRolesApiInterface {
1402
1402
  }
1403
1403
 
1404
1404
  /**
1405
- *
1405
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
1406
1406
  * @summary Create a new role
1407
1407
  * @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
1408
1408
  * @param {*} [options] Override http request option.
@@ -1474,7 +1474,7 @@ export class AdminRolesApi extends BaseAPI implements AdminRolesApiInterface {
1474
1474
  }
1475
1475
 
1476
1476
  /**
1477
- *
1477
+ * Needs `roles.assign-permissions` and `roles.edit`.
1478
1478
  * @summary Remove a permission from a role
1479
1479
  * @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
1480
1480
  * @param {*} [options] Override http request option.
@@ -1498,7 +1498,7 @@ export class AdminRolesApi extends BaseAPI implements AdminRolesApiInterface {
1498
1498
  }
1499
1499
 
1500
1500
  /**
1501
- *
1501
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
1502
1502
  * @summary Update role permissions (replaces all)
1503
1503
  * @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
1504
1504
  * @param {*} [options] Override http request option.