@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
@@ -23,6 +23,7 @@ import type { AdminIdentitiesLegacySamlReportResponse } from '../models';
23
23
  import type { AdminIdentitiesLinkRequest } from '../models';
24
24
  import type { AdminIdentitiesListResponse } from '../models';
25
25
  import type { AdminRolesGetPermissionsResponse } from '../models';
26
+ import type { AdminUsersRestoreResponse } from '../models';
26
27
  import type { BlockUserResponse } from '../models';
27
28
  import type { CreateUserResponse } from '../models';
28
29
  import type { DeleteUserResponse } from '../models';
@@ -54,7 +55,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
54
55
  */
55
56
  addUserGroup: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
56
57
  /**
57
- *
58
+ * Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
58
59
  * @summary Assign a permission to a user
59
60
  * @param {string} orgId
60
61
  * @param {string} userId
@@ -72,7 +73,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
72
73
  */
73
74
  addUserRole: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
74
75
  /**
75
- * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
76
+ * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
76
77
  * @summary Relink legacy SAML users to an IdP
77
78
  * @param {string} orgId
78
79
  * @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
@@ -118,6 +119,15 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
118
119
  * @throws {RequiredError}
119
120
  */
120
121
  adminIdentitiesUnlink: (type: AdminIdentitiesUnlinkType, orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
122
+ /**
123
+ * Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
124
+ * @summary Restore a deleted user
125
+ * @param {string} orgId
126
+ * @param {string} userId
127
+ * @param {*} [options] Override http request option.
128
+ * @throws {RequiredError}
129
+ */
130
+ adminUsersRestore: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
121
131
  /**
122
132
  *
123
133
  * @summary Block a user
@@ -184,10 +194,22 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
184
194
  *
185
195
  * @summary List users
186
196
  * @param {string} orgId
197
+ * @param {number} [page] Page number.
198
+ * @param {number} [limit] Users per page (1 to 100).
199
+ * @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
200
+ * @param {boolean} [active] Only active (&#x60;true&#x60;) or inactive (&#x60;false&#x60;) users.
201
+ * @param {boolean} [blocked] Only blocked (&#x60;true&#x60;) or not blocked (&#x60;false&#x60;) users.
202
+ * @param {boolean} [deleted] &#x60;true&#x60; lists only the users that SCIM deleted (soft-deleted). Without it, or with &#x60;false&#x60;, the list leaves them out.
203
+ * @param {boolean} [emailVerified] Only users whose email address is verified (&#x60;true&#x60;) or not (&#x60;false&#x60;).
204
+ * @param {boolean} [mfaEnabled] Only users with (&#x60;true&#x60;) or without (&#x60;false&#x60;) multi-factor authentication.
205
+ * @param {string} [role] Only users who hold the role with this slug.
206
+ * @param {string} [group] Only members of the group with this slug.
207
+ * @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
208
+ * @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
187
209
  * @param {*} [options] Override http request option.
188
210
  * @throws {RequiredError}
189
211
  */
190
- listUsers: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
212
+ listUsers: (orgId: string, page?: number, limit?: number, search?: string, active?: boolean, blocked?: boolean, deleted?: boolean, emailVerified?: boolean, mfaEnabled?: boolean, role?: string, group?: string, sortBy?: ListUsersSortBy, sortDir?: ListUsersSortDir, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
191
213
  /**
192
214
  *
193
215
  * @summary Mark a user\'s email as verified
@@ -256,7 +278,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
256
278
  */
257
279
  sendUserVerificationEmail: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
258
280
  /**
259
- *
281
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
260
282
  * @summary Set a user\'s password
261
283
  * @param {string} orgId
262
284
  * @param {string} userId
@@ -265,7 +287,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
265
287
  */
266
288
  setUserPassword: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
267
289
  /**
268
- *
290
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
269
291
  * @summary Set a user\'s password
270
292
  * @param {string} orgId
271
293
  * @param {string} userId
@@ -334,7 +356,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
334
356
  */
335
357
  addUserGroup(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddUserGroupResponse>>;
336
358
  /**
337
- *
359
+ * Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
338
360
  * @summary Assign a permission to a user
339
361
  * @param {string} orgId
340
362
  * @param {string} userId
@@ -352,7 +374,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
352
374
  */
353
375
  addUserRole(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddUserRoleResponse>>;
354
376
  /**
355
- * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
377
+ * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
356
378
  * @summary Relink legacy SAML users to an IdP
357
379
  * @param {string} orgId
358
380
  * @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
@@ -398,6 +420,15 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
398
420
  * @throws {RequiredError}
399
421
  */
400
422
  adminIdentitiesUnlink(type: AdminIdentitiesUnlinkType, orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsGetResponse>>;
423
+ /**
424
+ * Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
425
+ * @summary Restore a deleted user
426
+ * @param {string} orgId
427
+ * @param {string} userId
428
+ * @param {*} [options] Override http request option.
429
+ * @throws {RequiredError}
430
+ */
431
+ adminUsersRestore(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminUsersRestoreResponse>>;
401
432
  /**
402
433
  *
403
434
  * @summary Block a user
@@ -464,10 +495,22 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
464
495
  *
465
496
  * @summary List users
466
497
  * @param {string} orgId
498
+ * @param {number} [page] Page number.
499
+ * @param {number} [limit] Users per page (1 to 100).
500
+ * @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
501
+ * @param {boolean} [active] Only active (&#x60;true&#x60;) or inactive (&#x60;false&#x60;) users.
502
+ * @param {boolean} [blocked] Only blocked (&#x60;true&#x60;) or not blocked (&#x60;false&#x60;) users.
503
+ * @param {boolean} [deleted] &#x60;true&#x60; lists only the users that SCIM deleted (soft-deleted). Without it, or with &#x60;false&#x60;, the list leaves them out.
504
+ * @param {boolean} [emailVerified] Only users whose email address is verified (&#x60;true&#x60;) or not (&#x60;false&#x60;).
505
+ * @param {boolean} [mfaEnabled] Only users with (&#x60;true&#x60;) or without (&#x60;false&#x60;) multi-factor authentication.
506
+ * @param {string} [role] Only users who hold the role with this slug.
507
+ * @param {string} [group] Only members of the group with this slug.
508
+ * @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
509
+ * @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
467
510
  * @param {*} [options] Override http request option.
468
511
  * @throws {RequiredError}
469
512
  */
470
- listUsers(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
513
+ listUsers(orgId: string, page?: number, limit?: number, search?: string, active?: boolean, blocked?: boolean, deleted?: boolean, emailVerified?: boolean, mfaEnabled?: boolean, role?: string, group?: string, sortBy?: ListUsersSortBy, sortDir?: ListUsersSortDir, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
471
514
  /**
472
515
  *
473
516
  * @summary Mark a user\'s email as verified
@@ -536,7 +579,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
536
579
  */
537
580
  sendUserVerificationEmail(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendUserVerificationEmailResponse>>;
538
581
  /**
539
- *
582
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
540
583
  * @summary Set a user\'s password
541
584
  * @param {string} orgId
542
585
  * @param {string} userId
@@ -545,7 +588,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
545
588
  */
546
589
  setUserPassword(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetUserPasswordPostResponse>>;
547
590
  /**
548
- *
591
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
549
592
  * @summary Set a user\'s password
550
593
  * @param {string} orgId
551
594
  * @param {string} userId
@@ -613,7 +656,7 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
613
656
  */
614
657
  addUserGroup(requestParameters: AdminUsersApiAddUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserGroupResponse>;
615
658
  /**
616
- *
659
+ * Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
617
660
  * @summary Assign a permission to a user
618
661
  * @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
619
662
  * @param {*} [options] Override http request option.
@@ -629,7 +672,7 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
629
672
  */
630
673
  addUserRole(requestParameters: AdminUsersApiAddUserRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserRoleResponse>;
631
674
  /**
632
- * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
675
+ * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
633
676
  * @summary Relink legacy SAML users to an IdP
634
677
  * @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
635
678
  * @param {*} [options] Override http request option.
@@ -668,6 +711,14 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
668
711
  * @throws {RequiredError}
669
712
  */
670
713
  adminIdentitiesUnlink(requestParameters: AdminUsersApiAdminIdentitiesUnlinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
714
+ /**
715
+ * Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
716
+ * @summary Restore a deleted user
717
+ * @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
718
+ * @param {*} [options] Override http request option.
719
+ * @throws {RequiredError}
720
+ */
721
+ adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminUsersRestoreResponse>;
671
722
  /**
672
723
  *
673
724
  * @summary Block a user
@@ -790,7 +841,7 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
790
841
  */
791
842
  sendUserVerificationEmail(requestParameters: AdminUsersApiSendUserVerificationEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<SendUserVerificationEmailResponse>;
792
843
  /**
793
- *
844
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
794
845
  * @summary Set a user\'s password
795
846
  * @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
796
847
  * @param {*} [options] Override http request option.
@@ -798,7 +849,7 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
798
849
  */
799
850
  setUserPassword(requestParameters: AdminUsersApiSetUserPasswordRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetUserPasswordPostResponse>;
800
851
  /**
801
- *
852
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
802
853
  * @summary Set a user\'s password
803
854
  * @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
804
855
  * @param {*} [options] Override http request option.
@@ -862,7 +913,7 @@ export interface AdminUsersApiInterface {
862
913
  */
863
914
  addUserGroup(requestParameters: AdminUsersApiAddUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserGroupResponse>;
864
915
  /**
865
- *
916
+ * Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
866
917
  * @summary Assign a permission to a user
867
918
  * @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
868
919
  * @param {*} [options] Override http request option.
@@ -880,7 +931,7 @@ export interface AdminUsersApiInterface {
880
931
  */
881
932
  addUserRole(requestParameters: AdminUsersApiAddUserRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserRoleResponse>;
882
933
  /**
883
- * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
934
+ * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
884
935
  * @summary Relink legacy SAML users to an IdP
885
936
  * @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
886
937
  * @param {*} [options] Override http request option.
@@ -924,6 +975,15 @@ export interface AdminUsersApiInterface {
924
975
  * @memberof AdminUsersApiInterface
925
976
  */
926
977
  adminIdentitiesUnlink(requestParameters: AdminUsersApiAdminIdentitiesUnlinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
978
+ /**
979
+ * Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
980
+ * @summary Restore a deleted user
981
+ * @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
982
+ * @param {*} [options] Override http request option.
983
+ * @throws {RequiredError}
984
+ * @memberof AdminUsersApiInterface
985
+ */
986
+ adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminUsersRestoreResponse>;
927
987
  /**
928
988
  *
929
989
  * @summary Block a user
@@ -1061,7 +1121,7 @@ export interface AdminUsersApiInterface {
1061
1121
  */
1062
1122
  sendUserVerificationEmail(requestParameters: AdminUsersApiSendUserVerificationEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<SendUserVerificationEmailResponse>;
1063
1123
  /**
1064
- *
1124
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
1065
1125
  * @summary Set a user\'s password
1066
1126
  * @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
1067
1127
  * @param {*} [options] Override http request option.
@@ -1070,7 +1130,7 @@ export interface AdminUsersApiInterface {
1070
1130
  */
1071
1131
  setUserPassword(requestParameters: AdminUsersApiSetUserPasswordRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetUserPasswordPostResponse>;
1072
1132
  /**
1073
- *
1133
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
1074
1134
  * @summary Set a user\'s password
1075
1135
  * @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
1076
1136
  * @param {*} [options] Override http request option.
@@ -1288,6 +1348,25 @@ export interface AdminUsersApiAdminIdentitiesUnlinkRequest {
1288
1348
  */
1289
1349
  readonly userId: string;
1290
1350
  }
1351
+ /**
1352
+ * Request parameters for adminUsersRestore operation in AdminUsersApi.
1353
+ * @export
1354
+ * @interface AdminUsersApiAdminUsersRestoreRequest
1355
+ */
1356
+ export interface AdminUsersApiAdminUsersRestoreRequest {
1357
+ /**
1358
+ *
1359
+ * @type {string}
1360
+ * @memberof AdminUsersApiAdminUsersRestore
1361
+ */
1362
+ readonly orgId: string;
1363
+ /**
1364
+ *
1365
+ * @type {string}
1366
+ * @memberof AdminUsersApiAdminUsersRestore
1367
+ */
1368
+ readonly userId: string;
1369
+ }
1291
1370
  /**
1292
1371
  * Request parameters for blockUser operation in AdminUsersApi.
1293
1372
  * @export
@@ -1427,6 +1506,78 @@ export interface AdminUsersApiListUsersRequest {
1427
1506
  * @memberof AdminUsersApiListUsers
1428
1507
  */
1429
1508
  readonly orgId: string;
1509
+ /**
1510
+ * Page number.
1511
+ * @type {number}
1512
+ * @memberof AdminUsersApiListUsers
1513
+ */
1514
+ readonly page?: number;
1515
+ /**
1516
+ * Users per page (1 to 100).
1517
+ * @type {number}
1518
+ * @memberof AdminUsersApiListUsers
1519
+ */
1520
+ readonly limit?: number;
1521
+ /**
1522
+ * Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
1523
+ * @type {string}
1524
+ * @memberof AdminUsersApiListUsers
1525
+ */
1526
+ readonly search?: string;
1527
+ /**
1528
+ * Only active (&#x60;true&#x60;) or inactive (&#x60;false&#x60;) users.
1529
+ * @type {boolean}
1530
+ * @memberof AdminUsersApiListUsers
1531
+ */
1532
+ readonly active?: boolean;
1533
+ /**
1534
+ * Only blocked (&#x60;true&#x60;) or not blocked (&#x60;false&#x60;) users.
1535
+ * @type {boolean}
1536
+ * @memberof AdminUsersApiListUsers
1537
+ */
1538
+ readonly blocked?: boolean;
1539
+ /**
1540
+ * &#x60;true&#x60; lists only the users that SCIM deleted (soft-deleted). Without it, or with &#x60;false&#x60;, the list leaves them out.
1541
+ * @type {boolean}
1542
+ * @memberof AdminUsersApiListUsers
1543
+ */
1544
+ readonly deleted?: boolean;
1545
+ /**
1546
+ * Only users whose email address is verified (&#x60;true&#x60;) or not (&#x60;false&#x60;).
1547
+ * @type {boolean}
1548
+ * @memberof AdminUsersApiListUsers
1549
+ */
1550
+ readonly emailVerified?: boolean;
1551
+ /**
1552
+ * Only users with (&#x60;true&#x60;) or without (&#x60;false&#x60;) multi-factor authentication.
1553
+ * @type {boolean}
1554
+ * @memberof AdminUsersApiListUsers
1555
+ */
1556
+ readonly mfaEnabled?: boolean;
1557
+ /**
1558
+ * Only users who hold the role with this slug.
1559
+ * @type {string}
1560
+ * @memberof AdminUsersApiListUsers
1561
+ */
1562
+ readonly role?: string;
1563
+ /**
1564
+ * Only members of the group with this slug.
1565
+ * @type {string}
1566
+ * @memberof AdminUsersApiListUsers
1567
+ */
1568
+ readonly group?: string;
1569
+ /**
1570
+ * Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
1571
+ * @type {'email' | 'name' | 'username' | 'createdAt' | 'lastLoginAt'}
1572
+ * @memberof AdminUsersApiListUsers
1573
+ */
1574
+ readonly sortBy?: ListUsersSortBy;
1575
+ /**
1576
+ * Sort direction. Used only together with sortBy.
1577
+ * @type {'ASC' | 'DESC'}
1578
+ * @memberof AdminUsersApiListUsers
1579
+ */
1580
+ readonly sortDir?: ListUsersSortDir;
1430
1581
  }
1431
1582
  /**
1432
1583
  * Request parameters for markUserVerified operation in AdminUsersApi.
@@ -1729,7 +1880,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
1729
1880
  */
1730
1881
  addUserGroup(requestParameters: AdminUsersApiAddUserGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddUserGroupResponse, any, {}>>;
1731
1882
  /**
1732
- *
1883
+ * Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
1733
1884
  * @summary Assign a permission to a user
1734
1885
  * @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
1735
1886
  * @param {*} [options] Override http request option.
@@ -1747,7 +1898,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
1747
1898
  */
1748
1899
  addUserRole(requestParameters: AdminUsersApiAddUserRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddUserRoleResponse, any, {}>>;
1749
1900
  /**
1750
- * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
1901
+ * Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
1751
1902
  * @summary Relink legacy SAML users to an IdP
1752
1903
  * @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
1753
1904
  * @param {*} [options] Override http request option.
@@ -1791,6 +1942,15 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
1791
1942
  * @memberof AdminUsersApi
1792
1943
  */
1793
1944
  adminIdentitiesUnlink(requestParameters: AdminUsersApiAdminIdentitiesUnlinkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAgentsGetResponse, any, {}>>;
1945
+ /**
1946
+ * Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
1947
+ * @summary Restore a deleted user
1948
+ * @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
1949
+ * @param {*} [options] Override http request option.
1950
+ * @throws {RequiredError}
1951
+ * @memberof AdminUsersApi
1952
+ */
1953
+ adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminUsersRestoreResponse, any, {}>>;
1794
1954
  /**
1795
1955
  *
1796
1956
  * @summary Block a user
@@ -1928,7 +2088,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
1928
2088
  */
1929
2089
  sendUserVerificationEmail(requestParameters: AdminUsersApiSendUserVerificationEmailRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SendUserVerificationEmailResponse, any, {}>>;
1930
2090
  /**
1931
- *
2091
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
1932
2092
  * @summary Set a user\'s password
1933
2093
  * @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
1934
2094
  * @param {*} [options] Override http request option.
@@ -1937,7 +2097,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
1937
2097
  */
1938
2098
  setUserPassword(requestParameters: AdminUsersApiSetUserPasswordRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SetUserPasswordPostResponse, any, {}>>;
1939
2099
  /**
1940
- *
2100
+ * Needs `users.edit`, and the caller must hold every permission of the user. 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.
1941
2101
  * @summary Set a user\'s password
1942
2102
  * @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
1943
2103
  * @param {*} [options] Override http request option.
@@ -2001,3 +2161,22 @@ export declare enum AdminIdentitiesUnlinkType {
2001
2161
  LDAP = "ldap",
2002
2162
  SOCIAL = "social"
2003
2163
  }
2164
+ /**
2165
+ * @export
2166
+ * @enum {string}
2167
+ */
2168
+ export declare enum ListUsersSortBy {
2169
+ EMAIL = "email",
2170
+ NAME = "name",
2171
+ USERNAME = "username",
2172
+ CREATED_AT = "createdAt",
2173
+ LAST_LOGIN_AT = "lastLoginAt"
2174
+ }
2175
+ /**
2176
+ * @export
2177
+ * @enum {string}
2178
+ */
2179
+ export declare enum ListUsersSortDir {
2180
+ ASC = "ASC",
2181
+ DESC = "DESC"
2182
+ }