auth0 5.10.0 → 5.12.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 (462) hide show
  1. package/dist/cjs/lib/retry.d.ts +7 -2
  2. package/dist/cjs/lib/retry.js +35 -5
  3. package/dist/cjs/management/BaseClient.d.ts +3 -0
  4. package/dist/cjs/management/BaseClient.js +15 -0
  5. package/dist/cjs/management/Client.d.ts +3 -0
  6. package/dist/cjs/management/Client.js +41 -36
  7. package/dist/cjs/management/api/requests/requests.d.ts +271 -2
  8. package/dist/cjs/management/api/resources/actions/client/Client.d.ts +1 -1
  9. package/dist/cjs/management/api/resources/actions/client/Client.js +1 -1
  10. package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.d.ts +6 -6
  11. package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.js +6 -6
  12. package/dist/cjs/management/api/resources/branding/resources/templates/client/Client.d.ts +16 -16
  13. package/dist/cjs/management/api/resources/branding/resources/templates/client/Client.js +16 -16
  14. package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +4 -4
  15. package/dist/cjs/management/api/resources/clientGrants/client/Client.js +4 -4
  16. package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.d.ts +1 -0
  17. package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js +3 -0
  18. package/dist/cjs/management/api/resources/clients/client/Client.d.ts +72 -80
  19. package/dist/cjs/management/api/resources/clients/client/Client.js +72 -80
  20. package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.d.ts +4 -9
  21. package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.js +4 -9
  22. package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.d.ts +38 -14
  23. package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.js +38 -14
  24. package/dist/cjs/management/api/resources/connectionProfiles/client/Client.d.ts +1 -0
  25. package/dist/cjs/management/api/resources/connectionProfiles/client/Client.js +3 -0
  26. package/dist/cjs/management/api/resources/connections/client/Client.d.ts +17 -19
  27. package/dist/cjs/management/api/resources/connections/client/Client.js +17 -19
  28. package/dist/cjs/management/api/resources/connections/resources/clients/client/Client.d.ts +2 -2
  29. package/dist/cjs/management/api/resources/connections/resources/clients/client/Client.js +2 -2
  30. package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/client/Client.d.ts +4 -4
  31. package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/client/Client.js +4 -4
  32. package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.d.ts +2 -2
  33. package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.js +2 -2
  34. package/dist/cjs/management/api/resources/connections/resources/users/client/Client.d.ts +1 -0
  35. package/dist/cjs/management/api/resources/connections/resources/users/client/Client.js +3 -0
  36. package/dist/cjs/management/api/resources/customDomains/client/Client.d.ts +20 -12
  37. package/dist/cjs/management/api/resources/customDomains/client/Client.js +22 -12
  38. package/dist/cjs/management/api/resources/deviceCredentials/client/Client.d.ts +3 -3
  39. package/dist/cjs/management/api/resources/deviceCredentials/client/Client.js +3 -3
  40. package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.d.ts +50 -81
  41. package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.js +50 -81
  42. package/dist/cjs/management/api/resources/groups/client/Client.d.ts +3 -0
  43. package/dist/cjs/management/api/resources/groups/client/Client.js +5 -0
  44. package/dist/cjs/management/api/resources/groups/resources/index.d.ts +1 -0
  45. package/dist/cjs/management/api/resources/groups/resources/index.js +2 -1
  46. package/dist/cjs/management/api/resources/groups/resources/members/client/Client.d.ts +1 -0
  47. package/dist/cjs/management/api/resources/groups/resources/members/client/Client.js +3 -0
  48. package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.d.ts +73 -0
  49. package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.js +276 -0
  50. package/dist/cjs/management/api/resources/groups/resources/roles/client/index.d.ts +1 -0
  51. package/dist/cjs/management/api/resources/groups/resources/roles/client/index.js +2 -0
  52. package/dist/cjs/management/api/resources/groups/resources/roles/index.d.ts +1 -0
  53. package/dist/cjs/management/api/resources/groups/resources/roles/index.js +17 -0
  54. package/dist/cjs/management/api/resources/guardian/resources/enrollments/client/Client.d.ts +2 -5
  55. package/dist/cjs/management/api/resources/guardian/resources/enrollments/client/Client.js +2 -5
  56. package/dist/cjs/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.d.ts +3 -3
  57. package/dist/cjs/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.js +3 -3
  58. package/dist/cjs/management/api/resources/guardian/resources/policies/client/Client.d.ts +10 -12
  59. package/dist/cjs/management/api/resources/guardian/resources/policies/client/Client.js +10 -12
  60. package/dist/cjs/management/api/resources/hooks/client/Client.d.ts +2 -2
  61. package/dist/cjs/management/api/resources/hooks/client/Client.js +2 -2
  62. package/dist/cjs/management/api/resources/index.d.ts +1 -0
  63. package/dist/cjs/management/api/resources/index.js +2 -1
  64. package/dist/cjs/management/api/resources/jobs/resources/verificationEmail/client/Client.d.ts +1 -1
  65. package/dist/cjs/management/api/resources/jobs/resources/verificationEmail/client/Client.js +1 -1
  66. package/dist/cjs/management/api/resources/logs/client/Client.d.ts +17 -20
  67. package/dist/cjs/management/api/resources/logs/client/Client.js +17 -20
  68. package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +16 -13
  69. package/dist/cjs/management/api/resources/organizations/client/Client.js +26 -17
  70. package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.d.ts +1 -0
  71. package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +3 -0
  72. package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.ts +1 -1
  73. package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.js +1 -1
  74. package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.d.ts +7 -2
  75. package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +17 -2
  76. package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.d.ts +36 -0
  77. package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.js +149 -0
  78. package/dist/cjs/management/api/resources/organizations/resources/groups/client/index.d.ts +1 -0
  79. package/dist/cjs/management/api/resources/organizations/resources/groups/client/index.js +2 -0
  80. package/dist/cjs/management/api/resources/organizations/resources/groups/index.d.ts +2 -0
  81. package/dist/cjs/management/api/resources/organizations/resources/groups/index.js +18 -0
  82. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/index.d.ts +1 -0
  83. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/index.js +37 -0
  84. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.ts +77 -0
  85. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.js +282 -0
  86. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/index.d.ts +1 -0
  87. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/index.js +2 -0
  88. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/index.d.ts +1 -0
  89. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/index.js +17 -0
  90. package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +1 -0
  91. package/dist/cjs/management/api/resources/organizations/resources/index.js +2 -1
  92. package/dist/cjs/management/api/resources/organizations/resources/invitations/client/Client.d.ts +2 -2
  93. package/dist/cjs/management/api/resources/organizations/resources/invitations/client/Client.js +2 -2
  94. package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.d.ts +10 -12
  95. package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +16 -14
  96. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.ts +37 -0
  97. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.js +150 -0
  98. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/index.d.ts +1 -0
  99. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/index.js +2 -0
  100. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/index.d.ts +2 -0
  101. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/index.js +18 -0
  102. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/index.d.ts +1 -0
  103. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/index.js +37 -0
  104. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/Client.d.ts +12 -0
  105. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/Client.js +16 -0
  106. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/index.d.ts +1 -0
  107. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/index.js +2 -0
  108. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/index.d.ts +2 -0
  109. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/index.js +18 -0
  110. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +35 -0
  111. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +147 -0
  112. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/index.d.ts +1 -0
  113. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/index.js +2 -0
  114. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/index.d.ts +1 -0
  115. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/index.js +17 -0
  116. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/index.d.ts +1 -0
  117. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/index.js +37 -0
  118. package/dist/cjs/management/api/resources/organizations/resources/members/resources/index.d.ts +1 -0
  119. package/dist/cjs/management/api/resources/organizations/resources/members/resources/index.js +2 -1
  120. package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.ts +3 -2
  121. package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +5 -2
  122. package/dist/cjs/management/api/resources/prompts/resources/rendering/client/Client.d.ts +2 -2
  123. package/dist/cjs/management/api/resources/prompts/resources/rendering/client/Client.js +2 -2
  124. package/dist/cjs/management/api/resources/rateLimitPolicies/client/Client.d.ts +102 -0
  125. package/dist/cjs/management/api/resources/rateLimitPolicies/client/Client.js +397 -0
  126. package/dist/cjs/management/api/resources/rateLimitPolicies/client/index.d.ts +1 -0
  127. package/dist/cjs/management/api/resources/rateLimitPolicies/client/index.js +2 -0
  128. package/dist/cjs/management/api/resources/rateLimitPolicies/index.d.ts +1 -0
  129. package/dist/cjs/management/api/resources/rateLimitPolicies/index.js +17 -0
  130. package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +1 -1
  131. package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +1 -1
  132. package/dist/cjs/management/api/resources/roles/client/Client.d.ts +9 -6
  133. package/dist/cjs/management/api/resources/roles/client/Client.js +15 -10
  134. package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.d.ts +73 -0
  135. package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.js +276 -0
  136. package/dist/cjs/management/api/resources/roles/resources/groups/client/index.d.ts +1 -0
  137. package/dist/cjs/management/api/resources/roles/resources/groups/client/index.js +2 -0
  138. package/dist/cjs/management/api/resources/roles/resources/groups/index.d.ts +1 -0
  139. package/dist/cjs/management/api/resources/roles/resources/groups/index.js +17 -0
  140. package/dist/cjs/management/api/resources/roles/resources/index.d.ts +1 -0
  141. package/dist/cjs/management/api/resources/roles/resources/index.js +2 -1
  142. package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.d.ts +3 -2
  143. package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.js +5 -2
  144. package/dist/cjs/management/api/resources/roles/resources/users/client/Client.d.ts +11 -13
  145. package/dist/cjs/management/api/resources/roles/resources/users/client/Client.js +11 -13
  146. package/dist/cjs/management/api/resources/rules/client/Client.d.ts +4 -4
  147. package/dist/cjs/management/api/resources/rules/client/Client.js +4 -4
  148. package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.ts +1 -0
  149. package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.js +3 -0
  150. package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.d.ts +10 -12
  151. package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.js +12 -12
  152. package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts +2 -1
  153. package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.js +4 -1
  154. package/dist/cjs/management/api/resources/userBlocks/client/Client.d.ts +6 -6
  155. package/dist/cjs/management/api/resources/userBlocks/client/Client.js +6 -6
  156. package/dist/cjs/management/api/resources/userGrants/client/Client.d.ts +1 -1
  157. package/dist/cjs/management/api/resources/userGrants/client/Client.js +1 -1
  158. package/dist/cjs/management/api/resources/users/client/Client.d.ts +82 -51
  159. package/dist/cjs/management/api/resources/users/client/Client.js +110 -75
  160. package/dist/cjs/management/api/resources/users/resources/authenticators/client/Client.d.ts +1 -1
  161. package/dist/cjs/management/api/resources/users/resources/authenticators/client/Client.js +1 -1
  162. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/Client.d.ts +37 -0
  163. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/Client.js +151 -0
  164. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/index.d.ts +1 -0
  165. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/index.js +2 -0
  166. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/index.d.ts +2 -0
  167. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/index.js +18 -0
  168. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/index.d.ts +1 -0
  169. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/index.js +37 -0
  170. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.d.ts +12 -0
  171. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.js +16 -0
  172. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.d.ts +1 -0
  173. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.js +2 -0
  174. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/index.d.ts +2 -0
  175. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/index.js +18 -0
  176. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.d.ts +1 -0
  177. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.js +37 -0
  178. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.d.ts +35 -0
  179. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.js +148 -0
  180. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.d.ts +1 -0
  181. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.js +2 -0
  182. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/index.d.ts +1 -0
  183. package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/index.js +17 -0
  184. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.d.ts +36 -0
  185. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.js +149 -0
  186. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/index.d.ts +1 -0
  187. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/index.js +2 -0
  188. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/index.d.ts +2 -0
  189. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/index.js +18 -0
  190. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/index.d.ts +1 -0
  191. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/index.js +37 -0
  192. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/client/Client.d.ts +12 -0
  193. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/client/Client.js +16 -0
  194. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/client/index.d.ts +1 -0
  195. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/client/index.js +2 -0
  196. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/index.d.ts +2 -0
  197. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/index.js +18 -0
  198. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +34 -0
  199. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +146 -0
  200. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/index.d.ts +1 -0
  201. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/index.js +2 -0
  202. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/index.d.ts +1 -0
  203. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/index.js +17 -0
  204. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/index.d.ts +1 -0
  205. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/index.js +37 -0
  206. package/dist/cjs/management/api/resources/users/resources/enrollments/client/Client.d.ts +1 -1
  207. package/dist/cjs/management/api/resources/users/resources/enrollments/client/Client.js +1 -1
  208. package/dist/cjs/management/api/resources/users/resources/groups/client/Client.d.ts +1 -0
  209. package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +3 -0
  210. package/dist/cjs/management/api/resources/users/resources/identities/client/Client.d.ts +26 -25
  211. package/dist/cjs/management/api/resources/users/resources/identities/client/Client.js +26 -25
  212. package/dist/cjs/management/api/resources/users/resources/index.d.ts +2 -0
  213. package/dist/cjs/management/api/resources/users/resources/index.js +3 -1
  214. package/dist/cjs/management/api/resources/users/resources/multifactor/client/Client.d.ts +2 -2
  215. package/dist/cjs/management/api/resources/users/resources/multifactor/client/Client.js +2 -2
  216. package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.d.ts +2 -1
  217. package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.js +4 -1
  218. package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.d.ts +2 -0
  219. package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.js +6 -0
  220. package/dist/cjs/management/api/resources/users/resources/roles/client/Client.d.ts +6 -4
  221. package/dist/cjs/management/api/resources/users/resources/roles/client/Client.js +10 -4
  222. package/dist/cjs/management/api/types/types.d.ts +543 -128
  223. package/dist/cjs/management/api/types/types.js +120 -46
  224. package/dist/cjs/management/core/auth/AuthProvider.d.ts +1 -0
  225. package/dist/cjs/management/core/auth/AuthProvider.js +7 -0
  226. package/dist/cjs/management/core/auth/index.d.ts +1 -1
  227. package/dist/cjs/management/core/auth/index.js +3 -1
  228. package/dist/cjs/management/core/fetcher/requestWithRetries.js +4 -1
  229. package/dist/cjs/management/version.d.ts +1 -1
  230. package/dist/cjs/management/version.js +1 -1
  231. package/dist/esm/lib/retry.d.mts +7 -2
  232. package/dist/esm/lib/retry.mjs +35 -5
  233. package/dist/esm/management/BaseClient.d.mts +3 -0
  234. package/dist/esm/management/BaseClient.mjs +15 -0
  235. package/dist/esm/management/Client.d.mts +3 -0
  236. package/dist/esm/management/Client.mjs +5 -0
  237. package/dist/esm/management/api/requests/requests.d.mts +271 -2
  238. package/dist/esm/management/api/resources/actions/client/Client.d.mts +1 -1
  239. package/dist/esm/management/api/resources/actions/client/Client.mjs +1 -1
  240. package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.d.mts +6 -6
  241. package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.mjs +6 -6
  242. package/dist/esm/management/api/resources/branding/resources/templates/client/Client.d.mts +16 -16
  243. package/dist/esm/management/api/resources/branding/resources/templates/client/Client.mjs +16 -16
  244. package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +4 -4
  245. package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +4 -4
  246. package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.d.mts +1 -0
  247. package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.mjs +3 -0
  248. package/dist/esm/management/api/resources/clients/client/Client.d.mts +72 -80
  249. package/dist/esm/management/api/resources/clients/client/Client.mjs +72 -80
  250. package/dist/esm/management/api/resources/clients/resources/connections/client/Client.d.mts +4 -9
  251. package/dist/esm/management/api/resources/clients/resources/connections/client/Client.mjs +4 -9
  252. package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.d.mts +38 -14
  253. package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.mjs +38 -14
  254. package/dist/esm/management/api/resources/connectionProfiles/client/Client.d.mts +1 -0
  255. package/dist/esm/management/api/resources/connectionProfiles/client/Client.mjs +3 -0
  256. package/dist/esm/management/api/resources/connections/client/Client.d.mts +17 -19
  257. package/dist/esm/management/api/resources/connections/client/Client.mjs +17 -19
  258. package/dist/esm/management/api/resources/connections/resources/clients/client/Client.d.mts +2 -2
  259. package/dist/esm/management/api/resources/connections/resources/clients/client/Client.mjs +2 -2
  260. package/dist/esm/management/api/resources/connections/resources/scimConfiguration/client/Client.d.mts +4 -4
  261. package/dist/esm/management/api/resources/connections/resources/scimConfiguration/client/Client.mjs +4 -4
  262. package/dist/esm/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.d.mts +2 -2
  263. package/dist/esm/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.mjs +2 -2
  264. package/dist/esm/management/api/resources/connections/resources/users/client/Client.d.mts +1 -0
  265. package/dist/esm/management/api/resources/connections/resources/users/client/Client.mjs +3 -0
  266. package/dist/esm/management/api/resources/customDomains/client/Client.d.mts +20 -12
  267. package/dist/esm/management/api/resources/customDomains/client/Client.mjs +22 -12
  268. package/dist/esm/management/api/resources/deviceCredentials/client/Client.d.mts +3 -3
  269. package/dist/esm/management/api/resources/deviceCredentials/client/Client.mjs +3 -3
  270. package/dist/esm/management/api/resources/emails/resources/provider/client/Client.d.mts +50 -81
  271. package/dist/esm/management/api/resources/emails/resources/provider/client/Client.mjs +50 -81
  272. package/dist/esm/management/api/resources/groups/client/Client.d.mts +3 -0
  273. package/dist/esm/management/api/resources/groups/client/Client.mjs +5 -0
  274. package/dist/esm/management/api/resources/groups/resources/index.d.mts +1 -0
  275. package/dist/esm/management/api/resources/groups/resources/index.mjs +1 -0
  276. package/dist/esm/management/api/resources/groups/resources/members/client/Client.d.mts +1 -0
  277. package/dist/esm/management/api/resources/groups/resources/members/client/Client.mjs +3 -0
  278. package/dist/esm/management/api/resources/groups/resources/roles/client/Client.d.mts +73 -0
  279. package/dist/esm/management/api/resources/groups/resources/roles/client/Client.mjs +239 -0
  280. package/dist/esm/management/api/resources/groups/resources/roles/client/index.d.mts +1 -0
  281. package/dist/esm/management/api/resources/groups/resources/roles/client/index.mjs +1 -0
  282. package/dist/esm/management/api/resources/groups/resources/roles/index.d.mts +1 -0
  283. package/dist/esm/management/api/resources/groups/resources/roles/index.mjs +1 -0
  284. package/dist/esm/management/api/resources/guardian/resources/enrollments/client/Client.d.mts +2 -5
  285. package/dist/esm/management/api/resources/guardian/resources/enrollments/client/Client.mjs +2 -5
  286. package/dist/esm/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.d.mts +3 -3
  287. package/dist/esm/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.mjs +3 -3
  288. package/dist/esm/management/api/resources/guardian/resources/policies/client/Client.d.mts +10 -12
  289. package/dist/esm/management/api/resources/guardian/resources/policies/client/Client.mjs +10 -12
  290. package/dist/esm/management/api/resources/hooks/client/Client.d.mts +2 -2
  291. package/dist/esm/management/api/resources/hooks/client/Client.mjs +2 -2
  292. package/dist/esm/management/api/resources/index.d.mts +1 -0
  293. package/dist/esm/management/api/resources/index.mjs +1 -0
  294. package/dist/esm/management/api/resources/jobs/resources/verificationEmail/client/Client.d.mts +1 -1
  295. package/dist/esm/management/api/resources/jobs/resources/verificationEmail/client/Client.mjs +1 -1
  296. package/dist/esm/management/api/resources/logs/client/Client.d.mts +17 -20
  297. package/dist/esm/management/api/resources/logs/client/Client.mjs +17 -20
  298. package/dist/esm/management/api/resources/organizations/client/Client.d.mts +16 -13
  299. package/dist/esm/management/api/resources/organizations/client/Client.mjs +22 -13
  300. package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.d.mts +1 -0
  301. package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +3 -0
  302. package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.mts +1 -1
  303. package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.mjs +1 -1
  304. package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.d.mts +7 -2
  305. package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +17 -2
  306. package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.d.mts +36 -0
  307. package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.mjs +112 -0
  308. package/dist/esm/management/api/resources/organizations/resources/groups/client/index.d.mts +1 -0
  309. package/dist/esm/management/api/resources/organizations/resources/groups/client/index.mjs +1 -0
  310. package/dist/esm/management/api/resources/organizations/resources/groups/index.d.mts +2 -0
  311. package/dist/esm/management/api/resources/organizations/resources/groups/index.mjs +2 -0
  312. package/dist/esm/management/api/resources/organizations/resources/groups/resources/index.d.mts +1 -0
  313. package/dist/esm/management/api/resources/organizations/resources/groups/resources/index.mjs +1 -0
  314. package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.mts +77 -0
  315. package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.mjs +245 -0
  316. package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/index.d.mts +1 -0
  317. package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/index.mjs +1 -0
  318. package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/index.d.mts +1 -0
  319. package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/index.mjs +1 -0
  320. package/dist/esm/management/api/resources/organizations/resources/index.d.mts +1 -0
  321. package/dist/esm/management/api/resources/organizations/resources/index.mjs +1 -0
  322. package/dist/esm/management/api/resources/organizations/resources/invitations/client/Client.d.mts +2 -2
  323. package/dist/esm/management/api/resources/organizations/resources/invitations/client/Client.mjs +2 -2
  324. package/dist/esm/management/api/resources/organizations/resources/members/client/Client.d.mts +10 -12
  325. package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +14 -12
  326. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.mts +37 -0
  327. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.mjs +113 -0
  328. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/index.d.mts +1 -0
  329. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/index.mjs +1 -0
  330. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/index.d.mts +2 -0
  331. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/index.mjs +2 -0
  332. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/index.d.mts +1 -0
  333. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/index.mjs +1 -0
  334. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/Client.d.mts +12 -0
  335. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/Client.mjs +12 -0
  336. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/index.d.mts +1 -0
  337. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/index.mjs +1 -0
  338. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/index.d.mts +2 -0
  339. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/index.mjs +2 -0
  340. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +35 -0
  341. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +110 -0
  342. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/index.d.mts +1 -0
  343. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/index.mjs +1 -0
  344. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/index.d.mts +1 -0
  345. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/index.mjs +1 -0
  346. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/index.d.mts +1 -0
  347. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/index.mjs +1 -0
  348. package/dist/esm/management/api/resources/organizations/resources/members/resources/index.d.mts +1 -0
  349. package/dist/esm/management/api/resources/organizations/resources/members/resources/index.mjs +1 -0
  350. package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.mts +3 -2
  351. package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +5 -2
  352. package/dist/esm/management/api/resources/prompts/resources/rendering/client/Client.d.mts +2 -2
  353. package/dist/esm/management/api/resources/prompts/resources/rendering/client/Client.mjs +2 -2
  354. package/dist/esm/management/api/resources/rateLimitPolicies/client/Client.d.mts +102 -0
  355. package/dist/esm/management/api/resources/rateLimitPolicies/client/Client.mjs +360 -0
  356. package/dist/esm/management/api/resources/rateLimitPolicies/client/index.d.mts +1 -0
  357. package/dist/esm/management/api/resources/rateLimitPolicies/client/index.mjs +1 -0
  358. package/dist/esm/management/api/resources/rateLimitPolicies/index.d.mts +1 -0
  359. package/dist/esm/management/api/resources/rateLimitPolicies/index.mjs +1 -0
  360. package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +1 -1
  361. package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +1 -1
  362. package/dist/esm/management/api/resources/roles/client/Client.d.mts +9 -6
  363. package/dist/esm/management/api/resources/roles/client/Client.mjs +11 -6
  364. package/dist/esm/management/api/resources/roles/resources/groups/client/Client.d.mts +73 -0
  365. package/dist/esm/management/api/resources/roles/resources/groups/client/Client.mjs +239 -0
  366. package/dist/esm/management/api/resources/roles/resources/groups/client/index.d.mts +1 -0
  367. package/dist/esm/management/api/resources/roles/resources/groups/client/index.mjs +1 -0
  368. package/dist/esm/management/api/resources/roles/resources/groups/index.d.mts +1 -0
  369. package/dist/esm/management/api/resources/roles/resources/groups/index.mjs +1 -0
  370. package/dist/esm/management/api/resources/roles/resources/index.d.mts +1 -0
  371. package/dist/esm/management/api/resources/roles/resources/index.mjs +1 -0
  372. package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.d.mts +3 -2
  373. package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.mjs +5 -2
  374. package/dist/esm/management/api/resources/roles/resources/users/client/Client.d.mts +11 -13
  375. package/dist/esm/management/api/resources/roles/resources/users/client/Client.mjs +11 -13
  376. package/dist/esm/management/api/resources/rules/client/Client.d.mts +4 -4
  377. package/dist/esm/management/api/resources/rules/client/Client.mjs +4 -4
  378. package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.mts +1 -0
  379. package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.mjs +3 -0
  380. package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.d.mts +10 -12
  381. package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.mjs +12 -12
  382. package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.d.mts +2 -1
  383. package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.mjs +4 -1
  384. package/dist/esm/management/api/resources/userBlocks/client/Client.d.mts +6 -6
  385. package/dist/esm/management/api/resources/userBlocks/client/Client.mjs +6 -6
  386. package/dist/esm/management/api/resources/userGrants/client/Client.d.mts +1 -1
  387. package/dist/esm/management/api/resources/userGrants/client/Client.mjs +1 -1
  388. package/dist/esm/management/api/resources/users/client/Client.d.mts +82 -51
  389. package/dist/esm/management/api/resources/users/client/Client.mjs +86 -51
  390. package/dist/esm/management/api/resources/users/resources/authenticators/client/Client.d.mts +1 -1
  391. package/dist/esm/management/api/resources/users/resources/authenticators/client/Client.mjs +1 -1
  392. package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/Client.d.mts +37 -0
  393. package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/Client.mjs +114 -0
  394. package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/index.d.mts +1 -0
  395. package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/index.mjs +1 -0
  396. package/dist/esm/management/api/resources/users/resources/effectivePermissions/index.d.mts +2 -0
  397. package/dist/esm/management/api/resources/users/resources/effectivePermissions/index.mjs +2 -0
  398. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/index.d.mts +1 -0
  399. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/index.mjs +1 -0
  400. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.d.mts +12 -0
  401. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.mjs +12 -0
  402. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.d.mts +1 -0
  403. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.mjs +1 -0
  404. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/index.d.mts +2 -0
  405. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/index.mjs +2 -0
  406. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.d.mts +1 -0
  407. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.mjs +1 -0
  408. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.d.mts +35 -0
  409. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.mjs +111 -0
  410. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.d.mts +1 -0
  411. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.mjs +1 -0
  412. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/index.d.mts +1 -0
  413. package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/index.mjs +1 -0
  414. package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.d.mts +36 -0
  415. package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.mjs +112 -0
  416. package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/index.d.mts +1 -0
  417. package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/index.mjs +1 -0
  418. package/dist/esm/management/api/resources/users/resources/effectiveRoles/index.d.mts +2 -0
  419. package/dist/esm/management/api/resources/users/resources/effectiveRoles/index.mjs +2 -0
  420. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/index.d.mts +1 -0
  421. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/index.mjs +1 -0
  422. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/client/Client.d.mts +12 -0
  423. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/client/Client.mjs +12 -0
  424. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/client/index.d.mts +1 -0
  425. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/client/index.mjs +1 -0
  426. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/index.d.mts +2 -0
  427. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/index.mjs +2 -0
  428. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +34 -0
  429. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +109 -0
  430. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/index.d.mts +1 -0
  431. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/index.mjs +1 -0
  432. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/index.d.mts +1 -0
  433. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/index.mjs +1 -0
  434. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/index.d.mts +1 -0
  435. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/index.mjs +1 -0
  436. package/dist/esm/management/api/resources/users/resources/enrollments/client/Client.d.mts +1 -1
  437. package/dist/esm/management/api/resources/users/resources/enrollments/client/Client.mjs +1 -1
  438. package/dist/esm/management/api/resources/users/resources/groups/client/Client.d.mts +1 -0
  439. package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +3 -0
  440. package/dist/esm/management/api/resources/users/resources/identities/client/Client.d.mts +26 -25
  441. package/dist/esm/management/api/resources/users/resources/identities/client/Client.mjs +26 -25
  442. package/dist/esm/management/api/resources/users/resources/index.d.mts +2 -0
  443. package/dist/esm/management/api/resources/users/resources/index.mjs +2 -0
  444. package/dist/esm/management/api/resources/users/resources/multifactor/client/Client.d.mts +2 -2
  445. package/dist/esm/management/api/resources/users/resources/multifactor/client/Client.mjs +2 -2
  446. package/dist/esm/management/api/resources/users/resources/organizations/client/Client.d.mts +2 -1
  447. package/dist/esm/management/api/resources/users/resources/organizations/client/Client.mjs +4 -1
  448. package/dist/esm/management/api/resources/users/resources/permissions/client/Client.d.mts +2 -0
  449. package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs +6 -0
  450. package/dist/esm/management/api/resources/users/resources/roles/client/Client.d.mts +6 -4
  451. package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs +10 -4
  452. package/dist/esm/management/api/types/types.d.mts +543 -128
  453. package/dist/esm/management/api/types/types.mjs +107 -33
  454. package/dist/esm/management/core/auth/AuthProvider.d.mts +1 -0
  455. package/dist/esm/management/core/auth/AuthProvider.mjs +6 -1
  456. package/dist/esm/management/core/auth/index.d.mts +1 -1
  457. package/dist/esm/management/core/auth/index.mjs +1 -0
  458. package/dist/esm/management/core/fetcher/requestWithRetries.mjs +4 -1
  459. package/dist/esm/management/version.d.mts +1 -1
  460. package/dist/esm/management/version.mjs +1 -1
  461. package/package.json +3 -3
  462. package/reference.md +3500 -1842
@@ -13,15 +13,14 @@ export declare class TokenExchangeProfilesClient {
13
13
  /**
14
14
  * Retrieve a list of all Token Exchange Profiles available in your tenant.
15
15
  *
16
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
16
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
17
17
  *
18
18
  * This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:
19
- * <ul>
20
- * <li><code>from</code>: Optional id from which to start selection.</li>
21
- * <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li>
22
- * </ul>
23
19
  *
24
- * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
20
+ * - `from`: Optional id from which to start selection.
21
+ * - `take`: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
22
+ *
23
+ * **Note**: The first time you call this endpoint using checkpoint pagination, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no pages are remaining.
25
24
  *
26
25
  * @param {Management.TokenExchangeProfilesListRequest} request
27
26
  * @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -41,7 +40,7 @@ export declare class TokenExchangeProfilesClient {
41
40
  /**
42
41
  * Create a new Token Exchange Profile within your tenant.
43
42
  *
44
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
43
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
45
44
  *
46
45
  * @param {Management.CreateTokenExchangeProfileRequestContent} request
47
46
  * @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -65,7 +64,7 @@ export declare class TokenExchangeProfilesClient {
65
64
  /**
66
65
  * Retrieve details about a single Token Exchange Profile specified by ID.
67
66
  *
68
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
67
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
69
68
  *
70
69
  * @param {string} id - ID of the Token Exchange Profile to retrieve.
71
70
  * @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -84,8 +83,7 @@ export declare class TokenExchangeProfilesClient {
84
83
  /**
85
84
  * Delete a Token Exchange Profile within your tenant.
86
85
  *
87
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta's Master Subscription Agreement</a>. It is your responsibility to securely validate the user's subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
88
- *
86
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
89
87
  *
90
88
  * @param {string} id - ID of the Token Exchange Profile to delete.
91
89
  * @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -102,8 +100,7 @@ export declare class TokenExchangeProfilesClient {
102
100
  /**
103
101
  * Update a Token Exchange Profile within your tenant.
104
102
  *
105
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta's Master Subscription Agreement</a>. It is your responsibility to securely validate the user's subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
106
- *
103
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
107
104
  *
108
105
  * @param {string} id - ID of the Token Exchange Profile to update.
109
106
  * @param {Management.UpdateTokenExchangeProfileRequestContent} request
@@ -113,6 +110,7 @@ export declare class TokenExchangeProfilesClient {
113
110
  * @throws {@link Management.UnauthorizedError}
114
111
  * @throws {@link Management.ForbiddenError}
115
112
  * @throws {@link Management.NotFoundError}
113
+ * @throws {@link Management.ConflictError}
116
114
  * @throws {@link Management.TooManyRequestsError}
117
115
  *
118
116
  * @example
@@ -58,15 +58,14 @@ class TokenExchangeProfilesClient {
58
58
  /**
59
59
  * Retrieve a list of all Token Exchange Profiles available in your tenant.
60
60
  *
61
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
61
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
62
62
  *
63
63
  * This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:
64
- * <ul>
65
- * <li><code>from</code>: Optional id from which to start selection.</li>
66
- * <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li>
67
- * </ul>
68
64
  *
69
- * <b>Note</b>: The first time you call this endpoint using checkpoint pagination, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no pages are remaining.
65
+ * - `from`: Optional id from which to start selection.
66
+ * - `take`: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
67
+ *
68
+ * **Note**: The first time you call this endpoint using checkpoint pagination, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no pages are remaining.
70
69
  *
71
70
  * @param {Management.TokenExchangeProfilesListRequest} request
72
71
  * @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -149,7 +148,7 @@ class TokenExchangeProfilesClient {
149
148
  /**
150
149
  * Create a new Token Exchange Profile within your tenant.
151
150
  *
152
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
151
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
153
152
  *
154
153
  * @param {Management.CreateTokenExchangeProfileRequestContent} request
155
154
  * @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -222,7 +221,7 @@ class TokenExchangeProfilesClient {
222
221
  /**
223
222
  * Retrieve details about a single Token Exchange Profile specified by ID.
224
223
  *
225
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
224
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
226
225
  *
227
226
  * @param {string} id - ID of the Token Exchange Profile to retrieve.
228
227
  * @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -287,8 +286,7 @@ class TokenExchangeProfilesClient {
287
286
  /**
288
287
  * Delete a Token Exchange Profile within your tenant.
289
288
  *
290
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta's Master Subscription Agreement</a>. It is your responsibility to securely validate the user's subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
291
- *
289
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
292
290
  *
293
291
  * @param {string} id - ID of the Token Exchange Profile to delete.
294
292
  * @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -344,8 +342,7 @@ class TokenExchangeProfilesClient {
344
342
  /**
345
343
  * Update a Token Exchange Profile within your tenant.
346
344
  *
347
- * By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta's Master Subscription Agreement</a>. It is your responsibility to securely validate the user's subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
348
- *
345
+ * By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
349
346
  *
350
347
  * @param {string} id - ID of the Token Exchange Profile to update.
351
348
  * @param {Management.UpdateTokenExchangeProfileRequestContent} request
@@ -355,6 +352,7 @@ class TokenExchangeProfilesClient {
355
352
  * @throws {@link Management.UnauthorizedError}
356
353
  * @throws {@link Management.ForbiddenError}
357
354
  * @throws {@link Management.NotFoundError}
355
+ * @throws {@link Management.ConflictError}
358
356
  * @throws {@link Management.TooManyRequestsError}
359
357
  *
360
358
  * @example
@@ -395,6 +393,8 @@ class TokenExchangeProfilesClient {
395
393
  throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
396
394
  case 404:
397
395
  throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
396
+ case 409:
397
+ throw new Management.ConflictError(_response.error.body, _response.rawResponse);
398
398
  case 429:
399
399
  throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
400
400
  default:
@@ -29,7 +29,7 @@ export declare class UserAttributeProfilesClient {
29
29
  */
30
30
  list(request?: Management.ListUserAttributeProfileRequestParameters, requestOptions?: UserAttributeProfilesClient.RequestOptions): Promise<core.Page<Management.UserAttributeProfile, Management.ListUserAttributeProfilesPaginatedResponseContent>>;
31
31
  /**
32
- * Create a User Attribute Profile
32
+ * Create a User Attribute Profile.
33
33
  *
34
34
  * @param {Management.CreateUserAttributeProfileRequestContent} request
35
35
  * @param {UserAttributeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -126,6 +126,7 @@ export declare class UserAttributeProfilesClient {
126
126
  * @throws {@link Management.BadRequestError}
127
127
  * @throws {@link Management.UnauthorizedError}
128
128
  * @throws {@link Management.ForbiddenError}
129
+ * @throws {@link Management.NotFoundError}
129
130
  * @throws {@link Management.TooManyRequestsError}
130
131
  *
131
132
  * @example
@@ -137,7 +137,7 @@ class UserAttributeProfilesClient {
137
137
  });
138
138
  }
139
139
  /**
140
- * Create a User Attribute Profile
140
+ * Create a User Attribute Profile.
141
141
  *
142
142
  * @param {Management.CreateUserAttributeProfileRequestContent} request
143
143
  * @param {UserAttributeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -452,6 +452,7 @@ class UserAttributeProfilesClient {
452
452
  * @throws {@link Management.BadRequestError}
453
453
  * @throws {@link Management.UnauthorizedError}
454
454
  * @throws {@link Management.ForbiddenError}
455
+ * @throws {@link Management.NotFoundError}
455
456
  * @throws {@link Management.TooManyRequestsError}
456
457
  *
457
458
  * @example
@@ -493,6 +494,8 @@ class UserAttributeProfilesClient {
493
494
  throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
494
495
  case 403:
495
496
  throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
497
+ case 404:
498
+ throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
496
499
  case 429:
497
500
  throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
498
501
  default:
@@ -11,7 +11,7 @@ export declare class UserBlocksClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<UserBlocksClient.Options>;
12
12
  constructor(options: UserBlocksClient.Options);
13
13
  /**
14
- * Retrieve details of all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for a user with the given identifier (username, phone number, or email).
14
+ * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
15
15
  *
16
16
  * @param {Management.ListUserBlocksByIdentifierRequestParameters} request
17
17
  * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -30,9 +30,9 @@ export declare class UserBlocksClient {
30
30
  listByIdentifier(request: Management.ListUserBlocksByIdentifierRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<Management.ListUserBlocksByIdentifierResponseContent>;
31
31
  private __listByIdentifier;
32
32
  /**
33
- * Remove all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given identifier (username, phone number, or email).
33
+ * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email).
34
34
  *
35
- * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by a tenant administrator</a>.
35
+ * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
36
36
  *
37
37
  * @param {Management.DeleteUserBlocksByIdentifierRequestParameters} request
38
38
  * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,7 +50,7 @@ export declare class UserBlocksClient {
50
50
  deleteByIdentifier(request: Management.DeleteUserBlocksByIdentifierRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<void>;
51
51
  private __deleteByIdentifier;
52
52
  /**
53
- * Retrieve details of all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given ID.
53
+ * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
54
54
  *
55
55
  * @param {string} id - user_id of the user blocks to retrieve.
56
56
  * @param {Management.ListUserBlocksRequestParameters} request
@@ -70,9 +70,9 @@ export declare class UserBlocksClient {
70
70
  list(id: string, request?: Management.ListUserBlocksRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<Management.ListUserBlocksResponseContent>;
71
71
  private __list;
72
72
  /**
73
- * Remove all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given ID.
73
+ * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
74
74
  *
75
- * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by a tenant administrator</a>.
75
+ * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
76
76
  *
77
77
  * @param {string} id - The user_id of the user to update.
78
78
  * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,7 @@ class UserBlocksClient {
56
56
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
57
57
  }
58
58
  /**
59
- * Retrieve details of all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for a user with the given identifier (username, phone number, or email).
59
+ * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
60
60
  *
61
61
  * @param {Management.ListUserBlocksByIdentifierRequestParameters} request
62
62
  * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -128,9 +128,9 @@ class UserBlocksClient {
128
128
  });
129
129
  }
130
130
  /**
131
- * Remove all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given identifier (username, phone number, or email).
131
+ * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email).
132
132
  *
133
- * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by a tenant administrator</a>.
133
+ * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
134
134
  *
135
135
  * @param {Management.DeleteUserBlocksByIdentifierRequestParameters} request
136
136
  * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -197,7 +197,7 @@ class UserBlocksClient {
197
197
  });
198
198
  }
199
199
  /**
200
- * Retrieve details of all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given ID.
200
+ * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
201
201
  *
202
202
  * @param {string} id - user_id of the user blocks to retrieve.
203
203
  * @param {Management.ListUserBlocksRequestParameters} request
@@ -271,9 +271,9 @@ class UserBlocksClient {
271
271
  });
272
272
  }
273
273
  /**
274
- * Remove all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given ID.
274
+ * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
275
275
  *
276
- * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by a tenant administrator</a>.
276
+ * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
277
277
  *
278
278
  * @param {string} id - The user_id of the user to update.
279
279
  * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -11,7 +11,7 @@ export declare class UserGrantsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<UserGrantsClient.Options>;
12
12
  constructor(options: UserGrantsClient.Options);
13
13
  /**
14
- * Retrieve the <a href="https://auth0.com/docs/api-auth/which-oauth-flow-to-use">grants</a> associated with your account.
14
+ * Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) associated with your account.
15
15
  *
16
16
  * @param {Management.ListUserGrantsRequestParameters} request
17
17
  * @param {UserGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,7 @@ class UserGrantsClient {
56
56
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
57
57
  }
58
58
  /**
59
- * Retrieve the <a href="https://auth0.com/docs/api-auth/which-oauth-flow-to-use">grants</a> associated with your account.
59
+ * Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) associated with your account.
60
60
  *
61
61
  * @param {Management.ListUserGrantsRequestParameters} request
62
62
  * @param {UserGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -5,6 +5,8 @@ import * as Management from "../../../index.js";
5
5
  import { AuthenticationMethodsClient } from "../resources/authenticationMethods/client/Client.js";
6
6
  import { AuthenticatorsClient } from "../resources/authenticators/client/Client.js";
7
7
  import { ConnectedAccountsClient } from "../resources/connectedAccounts/client/Client.js";
8
+ import { EffectivePermissionsClient } from "../resources/effectivePermissions/client/Client.js";
9
+ import { EffectiveRolesClient } from "../resources/effectiveRoles/client/Client.js";
8
10
  import { EnrollmentsClient } from "../resources/enrollments/client/Client.js";
9
11
  import { FederatedConnectionsTokensetsClient } from "../resources/federatedConnectionsTokensets/client/Client.js";
10
12
  import { GroupsClient } from "../resources/groups/client/Client.js";
@@ -27,6 +29,8 @@ export declare class UsersClient {
27
29
  protected _authenticationMethods: AuthenticationMethodsClient | undefined;
28
30
  protected _authenticators: AuthenticatorsClient | undefined;
29
31
  protected _connectedAccounts: ConnectedAccountsClient | undefined;
32
+ protected _effectivePermissions: EffectivePermissionsClient | undefined;
33
+ protected _effectiveRoles: EffectiveRolesClient | undefined;
30
34
  protected _enrollments: EnrollmentsClient | undefined;
31
35
  protected _federatedConnectionsTokensets: FederatedConnectionsTokensetsClient | undefined;
32
36
  protected _groups: GroupsClient | undefined;
@@ -43,6 +47,8 @@ export declare class UsersClient {
43
47
  get authenticationMethods(): AuthenticationMethodsClient;
44
48
  get authenticators(): AuthenticatorsClient;
45
49
  get connectedAccounts(): ConnectedAccountsClient;
50
+ get effectivePermissions(): EffectivePermissionsClient;
51
+ get effectiveRoles(): EffectiveRolesClient;
46
52
  get enrollments(): EnrollmentsClient;
47
53
  get federatedConnectionsTokensets(): FederatedConnectionsTokensetsClient;
48
54
  get groups(): GroupsClient;
@@ -62,14 +68,18 @@ export declare class UsersClient {
62
68
  * - Sort the users to be returned
63
69
  * - Select the fields to be returned
64
70
  * - Specify the number of users to retrieve per page and the page index
65
- * <!-- only v3 is available -->
66
- * The <code>q</code> query parameter can be used to get users that match the specified criteria <a href="https://auth0.com/docs/users/search/v3/query-syntax">using query string syntax.</a>
67
71
  *
68
- * <a href="https://auth0.com/docs/users/search/v3">Learn more about searching for users.</a>
69
72
  *
70
- * Read about <a href="https://auth0.com/docs/users/search/best-practices">best practices</a> when working with the API endpoints for retrieving users.
71
73
  *
72
- * Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the <a href="https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports">export job</a>, or the <a href="https://auth0.com/docs/extensions/user-import-export">User Import / Export</a> extension.
74
+ * The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax)
75
+ *
76
+ * [Learn more about searching for users.](https://auth0.com/docs/users/search/v3)
77
+ *
78
+ * Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users.
79
+ *
80
+ *
81
+ *
82
+ * Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
73
83
  *
74
84
  * @param {Management.ListUsersRequestParameters} request
75
85
  * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -96,9 +106,9 @@ export declare class UsersClient {
96
106
  */
97
107
  list(request?: Management.ListUsersRequestParameters, requestOptions?: UsersClient.RequestOptions): Promise<core.Page<Management.UserResponseSchema, Management.ListUsersOffsetPaginatedResponseContent>>;
98
108
  /**
99
- * Create a new user for a given <a href="https://auth0.com/docs/connections/database">database</a> or <a href="https://auth0.com/docs/connections/passwordless">passwordless</a> connection.
109
+ * Create a new user for a given [database](https://auth0.com/docs/connections/database) or [passwordless](https://auth0.com/docs/connections/passwordless) connection.
100
110
  *
101
- * Note: <code>connection</code> is required but other parameters such as <code>email</code> and <code>password</code> are dependent upon the type of connection.
111
+ * Note: `connection` is required but other parameters such as `email` and `password` are dependent upon the type of connection.
102
112
  *
103
113
  * @param {Management.CreateUserRequestContent} request
104
114
  * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -141,7 +151,7 @@ export declare class UsersClient {
141
151
  listUsersByEmail(request: Management.ListUsersByEmailRequestParameters, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.UserResponseSchema[]>;
142
152
  private __listUsersByEmail;
143
153
  /**
144
- * Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see <a href="https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint">Retrieve Users with the Get Users Endpoint</a>.
154
+ * Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see [Retrieve Users with the Get Users Endpoint](https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint).
145
155
  *
146
156
  * @param {string} id - ID of the user to retrieve.
147
157
  * @param {Management.GetUserRequestParameters} request
@@ -162,7 +172,7 @@ export declare class UsersClient {
162
172
  get(id: string, request?: Management.GetUserRequestParameters, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.GetUserResponseContent>;
163
173
  private __get;
164
174
  /**
165
- * Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see <a href="https://auth0.com/docs/manage-users/user-accounts/delete-users">Delete Users</a>.
175
+ * Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see [Delete Users](https://auth0.com/docs/manage-users/user-accounts/delete-users).
166
176
  *
167
177
  * @param {string} id - ID of the user to delete.
168
178
  * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -182,64 +192,84 @@ export declare class UsersClient {
182
192
  *
183
193
  * These are the attributes that can be updated at the root level:
184
194
  *
185
- * <ul>
186
- * <li>app_metadata</li>
187
- * <li>blocked</li>
188
- * <li>email</li>
189
- * <li>email_verified</li>
190
- * <li>family_name</li>
191
- * <li>given_name</li>
192
- * <li>name</li>
193
- * <li>nickname</li>
194
- * <li>password</li>
195
- * <li>phone_number</li>
196
- * <li>phone_verified</li>
197
- * <li>picture</li>
198
- * <li>username</li>
199
- * <li>user_metadata</li>
200
- * <li>verify_email</li>
201
- * </ul>
195
+ * - app_metadata
196
+ * - blocked
197
+ * - email
198
+ * - email_verified
199
+ * - family_name
200
+ * - given_name
201
+ * - name
202
+ * - nickname
203
+ * - password
204
+ * - phone_number
205
+ * - phone_verified
206
+ * - picture
207
+ * - username
208
+ * - user_metadata
209
+ * - verify_email
202
210
  *
203
211
  * Some considerations:
204
- * <ul>
205
- * <li>The properties of the new object will replace the old ones.</li>
206
- * <li>The metadata fields are an exception to this rule (<code>user_metadata</code> and <code>app_metadata</code>). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.</li>
207
- * <li>If you are updating <code>email</code>, <code>email_verified</code>, <code>phone_number</code>, <code>phone_verified</code>, <code>username</code> or <code>password</code> of a secondary identity, you need to specify the <code>connection</code> property too.</li>
208
- * <li>If you are updating <code>email</code> or <code>phone_number</code> you can specify, optionally, the <code>client_id</code> property.</li>
209
- * <li>Updating <code>email_verified</code> is not supported for enterprise and passwordless sms connections.</li>
210
- * <li>Updating the <code>blocked</code> to <code>false</code> does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.</li>
211
- * <li>Supported attributes can be unset by supplying <code>null</code> as the value.</li>
212
- * </ul>
213
- *
214
- * <h5>Updating a field (non-metadata property)</h5>
212
+ *
213
+ * - The properties of the new object will replace the old ones.
214
+ * - The metadata fields are an exception to this rule (`user_metadata` and `app_metadata`). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
215
+ * - If you are updating `email`, `email_verified`, `phone_number`, `phone_verified`, `username` or `password` of a secondary identity, you need to specify the `connection` property too.
216
+ * - If you are updating `email` or `phone_number` you can specify, optionally, the `client_id` property.
217
+ * - Updating `email_verified` is not supported for enterprise and passwordless sms connections.
218
+ * - Updating the `blocked` to `false` does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.
219
+ * - Supported attributes can be unset by supplying `null` as the value.
220
+ *
221
+ * **Updating a field (non-metadata property)**
222
+ *
215
223
  * To mark the email address of a user as verified, the body to send should be:
216
- * <pre><code>{ "email_verified": true }</code></pre>
217
224
  *
218
- * <h5>Updating a user metadata root property</h5>Let's assume that our test user has the following <code>user_metadata</code>:
219
- * <pre><code>{ "user_metadata" : { "profileCode": 1479 } }</code></pre>
225
+ * ```json
226
+ * { "email_verified": true }
227
+ * ```
220
228
  *
221
- * To add the field <code>addresses</code> the body to send should be:
222
- * <pre><code>{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}</code></pre>
229
+ * **Updating a user metadata root property**
223
230
  *
224
- * The modified object ends up with the following <code>user_metadata</code> property:<pre><code>{
231
+ * Let's assume that our test user has the following `user_metadata`:
232
+ *
233
+ * ```json
234
+ * { "user_metadata" : { "profileCode": 1479 } }
235
+ * ```
236
+ *
237
+ * To add the field `addresses` the body to send should be:
238
+ *
239
+ * ```json
240
+ * { "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
241
+ * ```
242
+ *
243
+ * The modified object ends up with the following `user_metadata` property:
244
+ *
245
+ * ```json
246
+ * {
225
247
  * "user_metadata": {
226
248
  * "profileCode": 1479,
227
249
  * "addresses": { "work_address": "100 Industrial Way" }
228
250
  * }
229
- * }</code></pre>
251
+ * }
252
+ * ```
253
+ *
254
+ * **Updating an inner user metadata property**
230
255
  *
231
- * <h5>Updating an inner user metadata property</h5>If there's existing user metadata to which we want to add <code>"home_address": "742 Evergreen Terrace"</code> (using the <code>addresses</code> property) we should send the whole <code>addresses</code> object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
232
- * <pre><code>{
256
+ * If there's existing user metadata to which we want to add `"home_address": "742 Evergreen Terrace"` (using the `addresses` property) we should send the whole `addresses` object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
257
+ *
258
+ * ```json
259
+ * {
233
260
  * "user_metadata": {
234
261
  * "addresses": {
235
262
  * "work_address": "100 Industrial Way",
236
263
  * "home_address": "742 Evergreen Terrace"
237
264
  * }
238
265
  * }
239
- * }</code></pre>
266
+ * }
267
+ * ```
268
+ *
269
+ * The modified object ends up with the following `user_metadata` property:
240
270
  *
241
- * The modified object ends up with the following <code>user_metadata</code> property:
242
- * <pre><code>{
271
+ * ```json
272
+ * {
243
273
  * "user_metadata": {
244
274
  * "profileCode": 1479,
245
275
  * "addresses": {
@@ -247,7 +277,8 @@ export declare class UsersClient {
247
277
  * "home_address": "742 Evergreen Terrace"
248
278
  * }
249
279
  * }
250
- * }</code></pre>
280
+ * }
281
+ * ```
251
282
  *
252
283
  * @param {string} id - ID of the user to update.
253
284
  * @param {Management.UpdateUserRequestContent} request
@@ -265,7 +296,7 @@ export declare class UsersClient {
265
296
  update(id: string, request?: Management.UpdateUserRequestContent, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.UpdateUserResponseContent>;
266
297
  private __update;
267
298
  /**
268
- * Remove an existing multi-factor authentication (MFA) <a href="https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa">recovery code</a> and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
299
+ * Remove an existing multi-factor authentication (MFA) [recovery code](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa) and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
269
300
  *
270
301
  * @param {string} id - ID of the user to regenerate a multi-factor authentication recovery code for.
271
302
  * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.