auth0 3.4.0 → 4.0.0-beta.1

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 (327) hide show
  1. package/README.md +19 -15
  2. package/dist/cjs/auth/base-auth-api.js +60 -0
  3. package/dist/cjs/auth/base-auth-api.js.map +1 -0
  4. package/dist/cjs/auth/client-authentication.js +64 -0
  5. package/dist/cjs/auth/client-authentication.js.map +1 -0
  6. package/dist/cjs/auth/database.js +73 -0
  7. package/dist/cjs/auth/database.js.map +1 -0
  8. package/dist/cjs/auth/id-token-validator.js +135 -0
  9. package/dist/cjs/auth/id-token-validator.js.map +1 -0
  10. package/dist/cjs/auth/index.js +40 -0
  11. package/dist/cjs/auth/index.js.map +1 -0
  12. package/dist/cjs/auth/oauth.js +199 -0
  13. package/dist/cjs/auth/oauth.js.map +1 -0
  14. package/dist/cjs/auth/passwordless.js +154 -0
  15. package/dist/cjs/auth/passwordless.js.map +1 -0
  16. package/dist/cjs/index.js +19 -0
  17. package/dist/cjs/index.js.map +1 -0
  18. package/dist/cjs/lib/errors.js +49 -0
  19. package/dist/cjs/lib/errors.js.map +1 -0
  20. package/dist/cjs/lib/index.js +19 -0
  21. package/dist/cjs/lib/index.js.map +1 -0
  22. package/dist/cjs/lib/middleware/telemetry-middleware.js +27 -0
  23. package/dist/cjs/lib/middleware/telemetry-middleware.js.map +1 -0
  24. package/dist/cjs/lib/models.js +41 -0
  25. package/dist/cjs/lib/models.js.map +1 -0
  26. package/dist/cjs/lib/retry.js +55 -0
  27. package/dist/cjs/lib/retry.js.map +1 -0
  28. package/dist/cjs/lib/runtime.js +250 -0
  29. package/dist/cjs/lib/runtime.js.map +1 -0
  30. package/dist/cjs/management/__generated/index.js +58 -0
  31. package/dist/cjs/management/__generated/index.js.map +1 -0
  32. package/dist/cjs/management/__generated/managers/actions-manager.js +336 -0
  33. package/dist/cjs/management/__generated/managers/actions-manager.js.map +1 -0
  34. package/dist/cjs/management/__generated/managers/anomaly-manager.js +63 -0
  35. package/dist/cjs/management/__generated/managers/anomaly-manager.js.map +1 -0
  36. package/dist/cjs/management/__generated/managers/attack-protection-manager.js +131 -0
  37. package/dist/cjs/management/__generated/managers/attack-protection-manager.js.map +1 -0
  38. package/dist/cjs/management/__generated/managers/blacklists-manager.js +76 -0
  39. package/dist/cjs/management/__generated/managers/blacklists-manager.js.map +1 -0
  40. package/dist/cjs/management/__generated/managers/branding-manager.js +207 -0
  41. package/dist/cjs/management/__generated/managers/branding-manager.js.map +1 -0
  42. package/dist/cjs/management/__generated/managers/client-grants-manager.js +114 -0
  43. package/dist/cjs/management/__generated/managers/client-grants-manager.js.map +1 -0
  44. package/dist/cjs/management/__generated/managers/clients-manager.js +238 -0
  45. package/dist/cjs/management/__generated/managers/clients-manager.js.map +1 -0
  46. package/dist/cjs/management/__generated/managers/connections-manager.js +193 -0
  47. package/dist/cjs/management/__generated/managers/connections-manager.js.map +1 -0
  48. package/dist/cjs/management/__generated/managers/custom-domains-manager.js +179 -0
  49. package/dist/cjs/management/__generated/managers/custom-domains-manager.js.map +1 -0
  50. package/dist/cjs/management/__generated/managers/device-credentials-manager.js +112 -0
  51. package/dist/cjs/management/__generated/managers/device-credentials-manager.js.map +1 -0
  52. package/dist/cjs/management/__generated/managers/email-templates-manager.js +102 -0
  53. package/dist/cjs/management/__generated/managers/email-templates-manager.js.map +1 -0
  54. package/dist/cjs/management/__generated/managers/emails-manager.js +102 -0
  55. package/dist/cjs/management/__generated/managers/emails-manager.js.map +1 -0
  56. package/dist/cjs/management/__generated/managers/grants-manager.js +103 -0
  57. package/dist/cjs/management/__generated/managers/grants-manager.js.map +1 -0
  58. package/dist/cjs/management/__generated/managers/guardian-manager.js +518 -0
  59. package/dist/cjs/management/__generated/managers/guardian-manager.js.map +1 -0
  60. package/dist/cjs/management/__generated/managers/hooks-manager.js +214 -0
  61. package/dist/cjs/management/__generated/managers/hooks-manager.js.map +1 -0
  62. package/dist/cjs/management/__generated/managers/index.js +48 -0
  63. package/dist/cjs/management/__generated/managers/index.js.map +1 -0
  64. package/dist/cjs/management/__generated/managers/jobs-manager.js +139 -0
  65. package/dist/cjs/management/__generated/managers/jobs-manager.js.map +1 -0
  66. package/dist/cjs/management/__generated/managers/keys-manager.js +85 -0
  67. package/dist/cjs/management/__generated/managers/keys-manager.js.map +1 -0
  68. package/dist/cjs/management/__generated/managers/log-streams-manager.js +392 -0
  69. package/dist/cjs/management/__generated/managers/log-streams-manager.js.map +1 -0
  70. package/dist/cjs/management/__generated/managers/logs-manager.js +95 -0
  71. package/dist/cjs/management/__generated/managers/logs-manager.js.map +1 -0
  72. package/dist/cjs/management/__generated/managers/organizations-manager.js +463 -0
  73. package/dist/cjs/management/__generated/managers/organizations-manager.js.map +1 -0
  74. package/dist/cjs/management/__generated/managers/prompts-manager.js +101 -0
  75. package/dist/cjs/management/__generated/managers/prompts-manager.js.map +1 -0
  76. package/dist/cjs/management/__generated/managers/resource-servers-manager.js +131 -0
  77. package/dist/cjs/management/__generated/managers/resource-servers-manager.js.map +1 -0
  78. package/dist/cjs/management/__generated/managers/roles-manager.js +238 -0
  79. package/dist/cjs/management/__generated/managers/roles-manager.js.map +1 -0
  80. package/dist/cjs/management/__generated/managers/rules-configs-manager.js +82 -0
  81. package/dist/cjs/management/__generated/managers/rules-configs-manager.js.map +1 -0
  82. package/dist/cjs/management/__generated/managers/rules-manager.js +149 -0
  83. package/dist/cjs/management/__generated/managers/rules-manager.js.map +1 -0
  84. package/dist/cjs/management/__generated/managers/stats-manager.js +72 -0
  85. package/dist/cjs/management/__generated/managers/stats-manager.js.map +1 -0
  86. package/dist/cjs/management/__generated/managers/tenants-manager.js +76 -0
  87. package/dist/cjs/management/__generated/managers/tenants-manager.js.map +1 -0
  88. package/dist/cjs/management/__generated/managers/tickets-manager.js +69 -0
  89. package/dist/cjs/management/__generated/managers/tickets-manager.js.map +1 -0
  90. package/dist/cjs/management/__generated/managers/user-blocks-manager.js +123 -0
  91. package/dist/cjs/management/__generated/managers/user-blocks-manager.js.map +1 -0
  92. package/dist/cjs/management/__generated/managers/users-by-email-manager.js +69 -0
  93. package/dist/cjs/management/__generated/managers/users-by-email-manager.js.map +1 -0
  94. package/dist/cjs/management/__generated/managers/users-manager.js +634 -0
  95. package/dist/cjs/management/__generated/managers/users-manager.js.map +1 -0
  96. package/dist/cjs/management/__generated/models/index.js +1581 -0
  97. package/dist/cjs/management/__generated/models/index.js.map +1 -0
  98. package/dist/cjs/management/index.js +20 -0
  99. package/dist/cjs/management/index.js.map +1 -0
  100. package/dist/cjs/management/management-client-options.js +3 -0
  101. package/dist/cjs/management/management-client-options.js.map +1 -0
  102. package/dist/cjs/management/management-client.js +54 -0
  103. package/dist/cjs/management/management-client.js.map +1 -0
  104. package/dist/cjs/management/token-provider-middleware.js +39 -0
  105. package/dist/cjs/management/token-provider-middleware.js.map +1 -0
  106. package/dist/cjs/management/token-provider.js +36 -0
  107. package/dist/cjs/management/token-provider.js.map +1 -0
  108. package/dist/cjs/package.json +1 -0
  109. package/dist/cjs/utils.js +16 -0
  110. package/dist/cjs/utils.js.map +1 -0
  111. package/dist/cjs/version.js +5 -0
  112. package/dist/cjs/version.js.map +1 -0
  113. package/dist/esm/auth/base-auth-api.js +55 -0
  114. package/dist/esm/auth/base-auth-api.js.map +1 -0
  115. package/dist/esm/auth/client-authentication.js +37 -0
  116. package/dist/esm/auth/client-authentication.js.map +1 -0
  117. package/dist/esm/auth/database.js +69 -0
  118. package/dist/esm/auth/database.js.map +1 -0
  119. package/dist/esm/auth/id-token-validator.js +107 -0
  120. package/dist/esm/auth/id-token-validator.js.map +1 -0
  121. package/dist/esm/auth/index.js +20 -0
  122. package/dist/esm/auth/index.js.map +1 -0
  123. package/dist/esm/auth/oauth.js +195 -0
  124. package/dist/esm/auth/oauth.js.map +1 -0
  125. package/dist/esm/auth/passwordless.js +150 -0
  126. package/dist/esm/auth/passwordless.js.map +1 -0
  127. package/dist/esm/index.js +3 -0
  128. package/dist/esm/index.js.map +1 -0
  129. package/dist/esm/lib/errors.js +42 -0
  130. package/dist/esm/lib/errors.js.map +1 -0
  131. package/dist/esm/lib/index.js +3 -0
  132. package/dist/esm/lib/index.js.map +1 -0
  133. package/dist/esm/lib/middleware/telemetry-middleware.js +23 -0
  134. package/dist/esm/lib/middleware/telemetry-middleware.js.map +1 -0
  135. package/dist/esm/lib/models.js +35 -0
  136. package/dist/esm/lib/models.js.map +1 -0
  137. package/dist/esm/lib/retry.js +51 -0
  138. package/dist/esm/lib/retry.js.map +1 -0
  139. package/dist/esm/lib/runtime.js +225 -0
  140. package/dist/esm/lib/runtime.js.map +1 -0
  141. package/dist/esm/management/__generated/index.js +40 -0
  142. package/dist/esm/management/__generated/index.js.map +1 -0
  143. package/dist/esm/management/__generated/managers/actions-manager.js +309 -0
  144. package/dist/esm/management/__generated/managers/actions-manager.js.map +1 -0
  145. package/dist/esm/management/__generated/managers/anomaly-manager.js +36 -0
  146. package/dist/esm/management/__generated/managers/anomaly-manager.js.map +1 -0
  147. package/dist/esm/management/__generated/managers/attack-protection-manager.js +104 -0
  148. package/dist/esm/management/__generated/managers/attack-protection-manager.js.map +1 -0
  149. package/dist/esm/management/__generated/managers/blacklists-manager.js +49 -0
  150. package/dist/esm/management/__generated/managers/blacklists-manager.js.map +1 -0
  151. package/dist/esm/management/__generated/managers/branding-manager.js +180 -0
  152. package/dist/esm/management/__generated/managers/branding-manager.js.map +1 -0
  153. package/dist/esm/management/__generated/managers/client-grants-manager.js +87 -0
  154. package/dist/esm/management/__generated/managers/client-grants-manager.js.map +1 -0
  155. package/dist/esm/management/__generated/managers/clients-manager.js +211 -0
  156. package/dist/esm/management/__generated/managers/clients-manager.js.map +1 -0
  157. package/dist/esm/management/__generated/managers/connections-manager.js +166 -0
  158. package/dist/esm/management/__generated/managers/connections-manager.js.map +1 -0
  159. package/dist/esm/management/__generated/managers/custom-domains-manager.js +152 -0
  160. package/dist/esm/management/__generated/managers/custom-domains-manager.js.map +1 -0
  161. package/dist/esm/management/__generated/managers/device-credentials-manager.js +85 -0
  162. package/dist/esm/management/__generated/managers/device-credentials-manager.js.map +1 -0
  163. package/dist/esm/management/__generated/managers/email-templates-manager.js +75 -0
  164. package/dist/esm/management/__generated/managers/email-templates-manager.js.map +1 -0
  165. package/dist/esm/management/__generated/managers/emails-manager.js +75 -0
  166. package/dist/esm/management/__generated/managers/emails-manager.js.map +1 -0
  167. package/dist/esm/management/__generated/managers/grants-manager.js +76 -0
  168. package/dist/esm/management/__generated/managers/grants-manager.js.map +1 -0
  169. package/dist/esm/management/__generated/managers/guardian-manager.js +491 -0
  170. package/dist/esm/management/__generated/managers/guardian-manager.js.map +1 -0
  171. package/dist/esm/management/__generated/managers/hooks-manager.js +187 -0
  172. package/dist/esm/management/__generated/managers/hooks-manager.js.map +1 -0
  173. package/dist/esm/management/__generated/managers/index.js +32 -0
  174. package/dist/esm/management/__generated/managers/index.js.map +1 -0
  175. package/dist/esm/management/__generated/managers/jobs-manager.js +112 -0
  176. package/dist/esm/management/__generated/managers/jobs-manager.js.map +1 -0
  177. package/dist/esm/management/__generated/managers/keys-manager.js +58 -0
  178. package/dist/esm/management/__generated/managers/keys-manager.js.map +1 -0
  179. package/dist/esm/management/__generated/managers/log-streams-manager.js +365 -0
  180. package/dist/esm/management/__generated/managers/log-streams-manager.js.map +1 -0
  181. package/dist/esm/management/__generated/managers/logs-manager.js +68 -0
  182. package/dist/esm/management/__generated/managers/logs-manager.js.map +1 -0
  183. package/dist/esm/management/__generated/managers/organizations-manager.js +436 -0
  184. package/dist/esm/management/__generated/managers/organizations-manager.js.map +1 -0
  185. package/dist/esm/management/__generated/managers/prompts-manager.js +74 -0
  186. package/dist/esm/management/__generated/managers/prompts-manager.js.map +1 -0
  187. package/dist/esm/management/__generated/managers/resource-servers-manager.js +104 -0
  188. package/dist/esm/management/__generated/managers/resource-servers-manager.js.map +1 -0
  189. package/dist/esm/management/__generated/managers/roles-manager.js +211 -0
  190. package/dist/esm/management/__generated/managers/roles-manager.js.map +1 -0
  191. package/dist/esm/management/__generated/managers/rules-configs-manager.js +55 -0
  192. package/dist/esm/management/__generated/managers/rules-configs-manager.js.map +1 -0
  193. package/dist/esm/management/__generated/managers/rules-manager.js +122 -0
  194. package/dist/esm/management/__generated/managers/rules-manager.js.map +1 -0
  195. package/dist/esm/management/__generated/managers/stats-manager.js +45 -0
  196. package/dist/esm/management/__generated/managers/stats-manager.js.map +1 -0
  197. package/dist/esm/management/__generated/managers/tenants-manager.js +49 -0
  198. package/dist/esm/management/__generated/managers/tenants-manager.js.map +1 -0
  199. package/dist/esm/management/__generated/managers/tickets-manager.js +42 -0
  200. package/dist/esm/management/__generated/managers/tickets-manager.js.map +1 -0
  201. package/dist/esm/management/__generated/managers/user-blocks-manager.js +96 -0
  202. package/dist/esm/management/__generated/managers/user-blocks-manager.js.map +1 -0
  203. package/dist/esm/management/__generated/managers/users-by-email-manager.js +42 -0
  204. package/dist/esm/management/__generated/managers/users-by-email-manager.js.map +1 -0
  205. package/dist/esm/management/__generated/managers/users-manager.js +607 -0
  206. package/dist/esm/management/__generated/managers/users-manager.js.map +1 -0
  207. package/dist/esm/management/__generated/models/index.js +1575 -0
  208. package/dist/esm/management/__generated/models/index.js.map +1 -0
  209. package/dist/esm/management/index.js +4 -0
  210. package/dist/esm/management/index.js.map +1 -0
  211. package/dist/esm/management/management-client-options.js +2 -0
  212. package/dist/esm/management/management-client-options.js.map +1 -0
  213. package/dist/esm/management/management-client.js +49 -0
  214. package/dist/esm/management/management-client.js.map +1 -0
  215. package/dist/esm/management/token-provider-middleware.js +35 -0
  216. package/dist/esm/management/token-provider-middleware.js.map +1 -0
  217. package/dist/esm/management/token-provider.js +32 -0
  218. package/dist/esm/management/token-provider.js.map +1 -0
  219. package/dist/esm/utils.js +12 -0
  220. package/dist/esm/utils.js.map +1 -0
  221. package/dist/esm/version.js +2 -0
  222. package/dist/esm/version.js.map +1 -0
  223. package/dist/typings/auth/base-auth-api.d.ts +33 -0
  224. package/dist/typings/auth/client-authentication.d.ts +26 -0
  225. package/dist/typings/auth/database.d.ts +153 -0
  226. package/dist/typings/auth/id-token-validator.d.ts +18 -0
  227. package/dist/typings/auth/index.d.ts +15 -0
  228. package/dist/typings/auth/oauth.d.ts +295 -0
  229. package/dist/typings/auth/passwordless.d.ts +165 -0
  230. package/dist/typings/index.d.ts +2 -0
  231. package/dist/typings/lib/errors.d.ts +34 -0
  232. package/dist/typings/lib/index.d.ts +3 -0
  233. package/dist/typings/lib/middleware/telemetry-middleware.d.ts +12 -0
  234. package/dist/typings/lib/models.d.ts +124 -0
  235. package/dist/typings/lib/retry.d.ts +27 -0
  236. package/dist/typings/lib/runtime.d.ts +69 -0
  237. package/dist/typings/management/__generated/index.d.ts +39 -0
  238. package/dist/typings/management/__generated/managers/actions-manager.d.ts +136 -0
  239. package/dist/typings/management/__generated/managers/anomaly-manager.d.ts +24 -0
  240. package/dist/typings/management/__generated/managers/attack-protection-manager.d.ts +52 -0
  241. package/dist/typings/management/__generated/managers/blacklists-manager.d.ts +28 -0
  242. package/dist/typings/management/__generated/managers/branding-manager.d.ts +103 -0
  243. package/dist/typings/management/__generated/managers/client-grants-manager.d.ts +42 -0
  244. package/dist/typings/management/__generated/managers/clients-manager.d.ts +119 -0
  245. package/dist/typings/management/__generated/managers/connections-manager.d.ts +71 -0
  246. package/dist/typings/management/__generated/managers/custom-domains-manager.d.ts +106 -0
  247. package/dist/typings/management/__generated/managers/device-credentials-manager.d.ts +42 -0
  248. package/dist/typings/management/__generated/managers/email-templates-manager.d.ts +38 -0
  249. package/dist/typings/management/__generated/managers/emails-manager.d.ts +40 -0
  250. package/dist/typings/management/__generated/managers/grants-manager.d.ts +34 -0
  251. package/dist/typings/management/__generated/managers/guardian-manager.d.ts +240 -0
  252. package/dist/typings/management/__generated/managers/hooks-manager.d.ts +94 -0
  253. package/dist/typings/management/__generated/managers/index.d.ts +31 -0
  254. package/dist/typings/management/__generated/managers/jobs-manager.d.ts +47 -0
  255. package/dist/typings/management/__generated/managers/keys-manager.d.ts +34 -0
  256. package/dist/typings/management/__generated/managers/log-streams-manager.d.ts +326 -0
  257. package/dist/typings/management/__generated/managers/logs-manager.d.ts +56 -0
  258. package/dist/typings/management/__generated/managers/organizations-manager.d.ts +191 -0
  259. package/dist/typings/management/__generated/managers/prompts-manager.d.ts +42 -0
  260. package/dist/typings/management/__generated/managers/resource-servers-manager.d.ts +48 -0
  261. package/dist/typings/management/__generated/managers/roles-manager.d.ts +110 -0
  262. package/dist/typings/management/__generated/managers/rules-configs-manager.d.ts +33 -0
  263. package/dist/typings/management/__generated/managers/rules-manager.d.ts +55 -0
  264. package/dist/typings/management/__generated/managers/stats-manager.d.ts +24 -0
  265. package/dist/typings/management/__generated/managers/tenants-manager.d.ts +24 -0
  266. package/dist/typings/management/__generated/managers/tickets-manager.d.ts +24 -0
  267. package/dist/typings/management/__generated/managers/user-blocks-manager.d.ts +45 -0
  268. package/dist/typings/management/__generated/managers/users-by-email-manager.d.ts +22 -0
  269. package/dist/typings/management/__generated/managers/users-manager.d.ts +323 -0
  270. package/dist/typings/management/__generated/models/index.d.ts +12704 -0
  271. package/dist/typings/management/index.d.ts +3 -0
  272. package/dist/typings/management/management-client-options.d.ts +17 -0
  273. package/dist/typings/management/management-client.d.ts +17 -0
  274. package/dist/typings/management/token-provider-middleware.d.ts +7 -0
  275. package/dist/typings/management/token-provider.d.ts +21 -0
  276. package/dist/typings/utils.d.ts +10 -0
  277. package/dist/typings/version.d.ts +1 -0
  278. package/package.json +47 -33
  279. package/CHANGELOG.md +0 -685
  280. package/src/Auth0RestClient.js +0 -123
  281. package/src/RetryRestClient.js +0 -105
  282. package/src/auth/DatabaseAuthenticator.js +0 -282
  283. package/src/auth/OAUthWithIDTokenValidation.js +0 -124
  284. package/src/auth/OAuthAuthenticator.js +0 -405
  285. package/src/auth/PasswordlessAuthenticator.js +0 -303
  286. package/src/auth/TokensManager.js +0 -254
  287. package/src/auth/UsersManager.js +0 -161
  288. package/src/auth/clientAuthentication.js +0 -86
  289. package/src/auth/idToken.js +0 -167
  290. package/src/auth/index.js +0 -573
  291. package/src/errors.js +0 -60
  292. package/src/index.js +0 -11
  293. package/src/index.mjs +0 -4
  294. package/src/management/ActionsManager.js +0 -526
  295. package/src/management/AttackProtectionManager.js +0 -158
  296. package/src/management/BaseManager.js +0 -41
  297. package/src/management/BlacklistedTokensManager.js +0 -67
  298. package/src/management/BrandingManager.js +0 -250
  299. package/src/management/ClientCredentialsManager.js +0 -112
  300. package/src/management/ClientGrantsManager.js +0 -124
  301. package/src/management/ClientsManager.js +0 -184
  302. package/src/management/ConnectionsManager.js +0 -213
  303. package/src/management/CustomDomainsManager.js +0 -141
  304. package/src/management/DeviceCredentialsManager.js +0 -91
  305. package/src/management/EmailProviderManager.js +0 -101
  306. package/src/management/EmailTemplatesManager.js +0 -90
  307. package/src/management/GrantsManager.js +0 -84
  308. package/src/management/GuardianManager.js +0 -361
  309. package/src/management/HooksManager.js +0 -295
  310. package/src/management/JobsManager.js +0 -324
  311. package/src/management/LogStreamsManager.js +0 -136
  312. package/src/management/LogsManager.js +0 -82
  313. package/src/management/ManagementTokenProvider.js +0 -144
  314. package/src/management/MigrationsManager.js +0 -76
  315. package/src/management/OrganizationsManager.js +0 -721
  316. package/src/management/PromptsManager.js +0 -162
  317. package/src/management/ResourceServersManager.js +0 -143
  318. package/src/management/RolesManager.js +0 -329
  319. package/src/management/RulesConfigsManager.js +0 -86
  320. package/src/management/RulesManager.js +0 -148
  321. package/src/management/StatsManager.js +0 -84
  322. package/src/management/TenantManager.js +0 -76
  323. package/src/management/TicketsManager.js +0 -104
  324. package/src/management/UserBlocksManager.js +0 -121
  325. package/src/management/UsersManager.js +0 -882
  326. package/src/management/index.js +0 -3409
  327. package/src/utils.js +0 -60
@@ -1,3409 +0,0 @@
1
- const util = require('util');
2
- const utils = require('../utils');
3
- const { jsonToBase64, generateClientInfo } = utils;
4
- const { ArgumentError } = require('rest-facade');
5
-
6
- // Managers.
7
- const ClientCredentialsManager = require('./ClientCredentialsManager');
8
- const ClientsManager = require('./ClientsManager');
9
- const ClientGrantsManager = require('./ClientGrantsManager');
10
- const GrantsManager = require('./GrantsManager');
11
- const UsersManager = require('./UsersManager');
12
- const UserBlocksManager = require('./UserBlocksManager');
13
- const ConnectionsManager = require('./ConnectionsManager');
14
- const AttackProtectionManager = require('./AttackProtectionManager');
15
- const BlacklistedTokensManager = require('./BlacklistedTokensManager');
16
- const RulesManager = require('./RulesManager');
17
- const DeviceCredentialsManager = require('./DeviceCredentialsManager');
18
- const EmailProviderManager = require('./EmailProviderManager');
19
- const StatsManager = require('./StatsManager');
20
- const TenantManager = require('./TenantManager');
21
- const JobsManager = require('./JobsManager');
22
- const TicketsManager = require('./TicketsManager');
23
- const LogsManager = require('./LogsManager');
24
- const LogStreamsManager = require('./LogStreamsManager');
25
- const ResourceServersManager = require('./ResourceServersManager');
26
- const ManagementTokenProvider = require('./ManagementTokenProvider');
27
- const RulesConfigsManager = require('./RulesConfigsManager');
28
- const EmailTemplatesManager = require('./EmailTemplatesManager');
29
- const GuardianManager = require('./GuardianManager');
30
- const CustomDomainsManager = require('./CustomDomainsManager');
31
- const RolesManager = require('./RolesManager');
32
- const HooksManager = require('./HooksManager');
33
- const BrandingManager = require('./BrandingManager');
34
- const MigrationsManager = require('./MigrationsManager');
35
- const PromptsManager = require('./PromptsManager');
36
- const ActionsManager = require('./ActionsManager');
37
- const OrganizationsManager = require('./OrganizationsManager');
38
-
39
- const BASE_URL_FORMAT = 'https://%s/api/v2';
40
- const MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
41
-
42
- /**
43
- * Management API SDK.
44
- *
45
- * The Auth0 Management API is meant to be used by back-end servers or trusted
46
- * parties performing administrative tasks. Generally speaking, anything that
47
- * can be done through the Auth0 dashboard (and more) can also be done through
48
- * this API.
49
- *
50
- * @example <caption>
51
- * Initialize your client class with an API v2 token (you can generate one
52
- * <a href="https://auth0.com/docs/apiv2">here</a>) and a domain.
53
- * </caption>
54
- *
55
- * var ManagementClient = require('auth0').ManagementClient;
56
- * var auth0 = new ManagementClient({
57
- * domain: '{YOUR_ACCOUNT}.auth0.com',
58
- * token: '{YOUR_API_V2_TOKEN}'
59
- * });
60
- * @example <caption>
61
- * Initialize your client class, by using a Non Interactive Client to fetch an access_token
62
- * via the Client Credentials Grant.
63
- * </caption>
64
- *
65
- * var ManagementClient = require('auth0').ManagementClient;
66
- * var auth0 = new ManagementClient({
67
- * domain: '{YOUR_ACCOUNT}.auth0.com',
68
- * clientId: '{YOUR_NON_INTERACTIVE_CLIENT_ID}',
69
- * clientSecret: '{YOUR_NON_INTERACTIVE_CLIENT_SECRET}',
70
- * scope: "read:users write:users",
71
- * audience: 'https://{YOUR_TENANT_NAME}.auth0.com/api/v2/',
72
- * tokenProvider: {
73
- * enableCache: true,
74
- * cacheTTLInSeconds: 10
75
- * }
76
- * });
77
- * @example <caption>
78
- * Initialize your client class, by using a Non Interactive Client to fetch an access_token
79
- * via the Client Credentials Grant, providing a Private Key using the private_key_jwt token
80
- * endpoint auth method.
81
- * </caption>
82
- *
83
- * var ManagementClient = require('auth0').ManagementClient;
84
- * var auth0 = new ManagementClient({
85
- * domain: '{YOUR_ACCOUNT}.auth0.com',
86
- * clientId: '{YOUR_NON_INTERACTIVE_CLIENT_ID}',
87
- * clientAssertionSigningKey: fs.readFileSync('private-key.pem'),
88
- * scope: "read:users write:users"
89
- * });
90
- */
91
- class ManagementClient {
92
- /**
93
- * @param {object} options Options for the ManagementClient SDK.
94
- * If a token is provided only the domain is required, other parameters are ignored.
95
- * If no token is provided domain, clientId and clientSecret (or clientAssertionSigningKey)
96
- * are required.
97
- * @param {string} options.domain ManagementClient server domain.
98
- * @param {string|Function} [options.token] API access token.
99
- * @param {string} [options.clientId] Management API Non Interactive Client Id.
100
- * @param {string} [options.clientSecret] Management API Non Interactive Client Secret.
101
- * @param {string} [options.clientAssertionSigningKey] Private key used to sign the client assertion JWT.
102
- * @param {string} [options.clientAssertionSigningAlg] Default 'RS256'.
103
- * @param {string} [options.audience] Management API Audience. By default is your domain's, e.g. the domain is `tenant.auth0.com` and the audience is `http://tenant.auth0.com/api/v2/`
104
- * @param {string} [options.scope] Management API Scopes.
105
- * @param {boolean} [options.tokenProvider.enableCache=true] Enabled or Disable Cache.
106
- * @param {number} [options.tokenProvider.cacheTTLInSeconds] By default the `expires_in` value will be used to determine the cached time of the token, this can be overridden.
107
- * @param {boolean} [options.retry.enabled=true] Enabled or Disable Retry Policy functionality.
108
- * @param {number} [options.retry.maxRetries=10] Retry failed requests X times.
109
- * @param {object} [options.headers] Additional headers that will be added to the outgoing requests.
110
- * @param {string} [options.proxy] Add the `superagent-proxy` dependency and specify a proxy url eg 'https://myproxy.com:1234'
111
- * @param {boolean} [options.includeResponseHeaders] Include the response headers in the payload in the format `{ data, headers }`.
112
- */
113
- constructor(options) {
114
- if (!options || typeof options !== 'object') {
115
- throw new ArgumentError('Management API SDK options must be an object');
116
- }
117
-
118
- if (!options.domain || options.domain.length === 0) {
119
- throw new ArgumentError('Must provide a domain');
120
- }
121
-
122
- const baseUrl = util.format(BASE_URL_FORMAT, options.domain);
123
-
124
- const defaultHeaders = {
125
- 'User-Agent': `node.js/${process.version.replace('v', '')}`,
126
- 'Content-Type': 'application/json',
127
- };
128
-
129
- const managerOptions = {
130
- headers: Object.assign(defaultHeaders, options.headers || {}),
131
- baseUrl,
132
- };
133
-
134
- if (options.token === undefined) {
135
- const config = Object.assign(
136
- { audience: util.format(MANAGEMENT_API_AUD_FORMAT, options.domain) },
137
- options
138
- );
139
-
140
- if (options.tokenProvider) {
141
- config.enableCache = options.tokenProvider.enableCache;
142
- config.cacheTTLInSeconds = options.tokenProvider.cacheTTLInSeconds;
143
- delete config.tokenProvider;
144
- }
145
-
146
- this.tokenProvider = new ManagementTokenProvider(config);
147
- } else if (
148
- typeof options.token !== 'function' &&
149
- (typeof options.token !== 'string' || options.token.length === 0)
150
- ) {
151
- throw new ArgumentError('Must provide a token');
152
- } else {
153
- this.tokenProvider = {
154
- getAccessToken() {
155
- return typeof options.token === 'function'
156
- ? options.token()
157
- : Promise.resolve(options.token);
158
- },
159
- };
160
- }
161
-
162
- managerOptions.tokenProvider = this.tokenProvider;
163
-
164
- if (options.telemetry !== false) {
165
- const clientInfo = options.clientInfo || generateClientInfo();
166
- if ('string' === typeof clientInfo.name && clientInfo.name.length > 0) {
167
- const telemetry = jsonToBase64(clientInfo);
168
- managerOptions.headers['Auth0-Client'] = telemetry;
169
- }
170
- }
171
-
172
- managerOptions.retry = options.retry;
173
- managerOptions.includeResponseHeaders = options.includeResponseHeaders;
174
- managerOptions.proxy = options.proxy;
175
-
176
- /**
177
- * Simple abstraction for performing CRUD operations on the
178
- * clients endpoint.
179
- *
180
- * @type {ClientsManager}
181
- */
182
- this.clients = new ClientsManager(managerOptions);
183
-
184
- /**
185
- * Simple abstraction for performing CRUD operations on the
186
- * client credentials endpoint.
187
- *
188
- * @type {module:management.ClientCredentialsManager}
189
- */
190
- this.clientCredentials = new ClientCredentialsManager(managerOptions);
191
-
192
- /**
193
- * Simple abstraction for performing CRUD operations on the client grants
194
- * endpoint.
195
- *
196
- * @type {ClientGrantsManager}
197
- */
198
- this.clientGrants = new ClientGrantsManager(managerOptions);
199
-
200
- /**
201
- * Simple abstraction for performing CRUD operations on the grants
202
- * endpoint.
203
- *
204
- * @type {GrantsManager}
205
- */
206
- this.grants = new GrantsManager(managerOptions);
207
-
208
- /**
209
- * Simple abstraction for performing CRUD operations on the
210
- * users endpoint.
211
- *
212
- * @type {UsersManager}
213
- */
214
- this.users = new UsersManager(managerOptions);
215
-
216
- /**
217
- * Simple abstraction for performing CRUD operations on the
218
- * user-blocks endpoint.
219
- *
220
- * @type {UserBlocksManager}
221
- */
222
- this.userBlocks = new UserBlocksManager(managerOptions);
223
-
224
- /**
225
- * Simple abstraction for performing CRUD operations on the
226
- * guardian endpoint.
227
- *
228
- * @type {GuardianManager}
229
- */
230
- this.guardian = new GuardianManager(managerOptions);
231
-
232
- /**
233
- * Simple abstraction for performing CRUD operations on the
234
- * custom domains endpoint.
235
- *
236
- * @type {CustomDomainsManager}
237
- */
238
- this.customDomains = new CustomDomainsManager(managerOptions);
239
-
240
- /**
241
- * Simple abstraction for performing CRUD operations on the
242
- * connections endpoint.
243
- *
244
- * @type {ConnectionsManager}
245
- */
246
- this.connections = new ConnectionsManager(managerOptions);
247
-
248
- /**
249
- * Simple abstraction for performing CRUD operations on the
250
- * device credentials endpoint.
251
- *
252
- * @type {DeviceCredentialsManager}
253
- */
254
- this.deviceCredentials = new DeviceCredentialsManager(managerOptions);
255
-
256
- /**
257
- * Simple abstraction for performing CRUD operations on the
258
- * rules endpoint.
259
- *
260
- * @type {RulesManager}
261
- */
262
- this.rules = new RulesManager(managerOptions);
263
-
264
- /**
265
- * Simple abstraction for performing CRUD operations on the
266
- * blacklisted tokens endpoint.
267
- *
268
- * @type {BlacklistedTokensManager}
269
- */
270
- this.blacklistedTokens = new BlacklistedTokensManager(managerOptions);
271
-
272
- /**
273
- * Simple abstraction for performing CRUD operations on the
274
- * email provider endpoint.
275
- *
276
- * @type {EmailProviderManager}
277
- */
278
- this.emailProvider = new EmailProviderManager(managerOptions);
279
-
280
- /**
281
- * ManagementClient account statistics manager.
282
- *
283
- * @type {StatsManager}
284
- */
285
- this.stats = new StatsManager(managerOptions);
286
-
287
- /**
288
- * ManagementClient tenant settings manager.
289
- *
290
- * @type {TenantManager}
291
- */
292
- this.tenant = new TenantManager(managerOptions);
293
-
294
- /**
295
- * Jobs manager.
296
- *
297
- * @type {JobsManager}
298
- */
299
- this.jobs = new JobsManager(managerOptions);
300
-
301
- /**
302
- * Tickets manager.
303
- *
304
- * @type {TicketsManager}
305
- */
306
- this.tickets = new TicketsManager(managerOptions);
307
-
308
- /**
309
- * Logs manager.
310
- *
311
- * @type {LogsManager}
312
- */
313
- this.logs = new LogsManager(managerOptions);
314
-
315
- /**
316
- * Log Streams manager.
317
- *
318
- * @type {LogStreamsManager}
319
- */
320
- this.logStreams = new LogStreamsManager(managerOptions);
321
-
322
- /**
323
- * Simple abstraction for performing CRUD operations on the
324
- * resource servers endpoint.
325
- *
326
- * @type {ResourceServersManager}
327
- */
328
- this.resourceServers = new ResourceServersManager(managerOptions);
329
-
330
- /**
331
- * Simple abstraction for performing CRUD operations on
332
- * Auth0's Email Templates
333
- *
334
- * @type {EmailTemplatesManager}
335
- */
336
- this.emailTemplates = new EmailTemplatesManager(managerOptions);
337
-
338
- /**
339
- * RulesConfigs manager.
340
- *
341
- * @type {RulesConfigsManager}
342
- */
343
- this.rulesConfigs = new RulesConfigsManager(managerOptions);
344
-
345
- /**
346
- * Simple abstraction for performing CRUD operations on the
347
- * roles endpoint.
348
- *
349
- * @type {RolesManager}
350
- */
351
- this.roles = new RolesManager(managerOptions);
352
-
353
- /**
354
- * Simple abstraction for performing CRUD operations on the
355
- * hooks endpoint.
356
- *
357
- * @type {HooksManager}
358
- */
359
- this.hooks = new HooksManager(managerOptions);
360
-
361
- /**
362
- * Simple abstraction for performing CRUD operations on the
363
- * branding endpoint.
364
- *
365
- * @type {BrandingManager}
366
- */
367
- this.branding = new BrandingManager(managerOptions);
368
-
369
- /**
370
- * ManagementClient migrations manager.
371
- *
372
- * @type {MigrationsManager}
373
- */
374
- this.migrations = new MigrationsManager(managerOptions);
375
-
376
- /**
377
- * Prompts Manager
378
- *
379
- * @type {PromptsManager}
380
- */
381
- this.prompts = new PromptsManager(managerOptions);
382
-
383
- /**
384
- * Simple abstraction for performing CRUD operations on the
385
- * actions endpoint.
386
- *
387
- * @type {ActionsManager}
388
- */
389
- this.actions = new ActionsManager(managerOptions);
390
-
391
- /**
392
- * Organizations Manager
393
- *
394
- * @type {OrganizationsManager}
395
- */
396
- this.organizations = new OrganizationsManager(managerOptions);
397
-
398
- /**
399
- * Attack Protection Manager
400
- *
401
- * @type {AttackProtectionManager}
402
- */
403
- this.attackProtection = new AttackProtectionManager(managerOptions);
404
- }
405
-
406
- /**
407
- * Get all connections.
408
- *
409
- * @example <caption>
410
- * This method takes an optional object as first argument that may be used to
411
- * specify pagination settings. If pagination options are not present,
412
- * the first page of a limited number of results will be returned.
413
- * </caption>
414
- *
415
- * // Pagination settings.
416
- * var params = {
417
- * per_page: 10,
418
- * page: 0
419
- * };
420
- *
421
- * management.getConnections(params, function (err, connections) {
422
- * console.log(connections.length);
423
- * });
424
- * @param {object} [params] Connections params.
425
- * @param {number} [params.per_page] Number of results per page.
426
- * @param {number} [params.page] Page number, zero indexed.
427
- * @param {Function} [cb] Callback function.
428
- * @returns {Promise|undefined}
429
- */
430
- getConnections(...args) {
431
- return this.connections.getAll(...args);
432
- }
433
-
434
- /**
435
- * Create a new connection.
436
- *
437
- * @example
438
- * management.createConnection(data, function (err) {
439
- * if (err) {
440
- * // Handle error.
441
- * }
442
- *
443
- * // Connection created.
444
- * });
445
- * @param {object} data Connection data object.
446
- * @param {Function} [cb] Callback function.
447
- * @returns {Promise|undefined}
448
- */
449
-
450
- createConnection(...args) {
451
- return this.connections.create(...args);
452
- }
453
-
454
- /**
455
- * Get an Auth0 connection.
456
- *
457
- * @example
458
- * management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
459
- * if (err) {
460
- * // Handle error.
461
- * }
462
- *
463
- * console.log(connection);
464
- * });
465
- * @param {object} params Connection parameters.
466
- * @param {string} params.id Connection ID.
467
- * @param {Function} [cb] Callback function.
468
- * @returns {Promise|undefined}
469
- */
470
- getConnection(...args) {
471
- return this.connections.get(...args);
472
- }
473
-
474
- /**
475
- * Delete an existing connection.
476
- *
477
- * @example
478
- * management.deleteConnection({ id: CONNECTION_ID }, function (err) {
479
- * if (err) {
480
- * // Handle error.
481
- * }
482
- *
483
- * // Connection deleted.
484
- * });
485
- * @param {object} params Connection parameters.
486
- * @param {string} params.id Connection ID.
487
- * @param {Function} [cb] Callback function.
488
- * @returns {Promise|undefined}
489
- */
490
- deleteConnection(...args) {
491
- return this.connections.delete(...args);
492
- }
493
-
494
- /**
495
- * Update an existing connection.
496
- *
497
- * @example
498
- * var data = { name: 'newConnectionName' };
499
- * var params = { id: CONNECTION_ID };
500
- *
501
- * management.updateConnection(params, data, function (err, connection) {
502
- * if (err) {
503
- * // Handle error.
504
- * }
505
- *
506
- * console.log(connection.name); // 'newConnectionName'
507
- * });
508
- * @param {object} params Connection parameters.
509
- * @param {string} params.id Connection ID.
510
- * @param {object} data Updated connection data.
511
- * @param {Function} [cb] Callback function.
512
- * @returns {Promise|undefined}
513
- */
514
- updateConnection(...args) {
515
- return this.connections.update(...args);
516
- }
517
-
518
- /**
519
- * Get all Auth0 clients.
520
- *
521
- * @example <caption>
522
- * This method takes an optional object as first argument that may be used to
523
- * specify pagination settings. If pagination options are not present,
524
- * the first page of a limited number of results will be returned.
525
- * </caption>
526
- *
527
- * // Pagination settings.
528
- * var params = {
529
- * per_page: 10,
530
- * page: 0
531
- * };
532
- *
533
- * management.getClients(params, function (err, clients) {
534
- * console.log(clients.length);
535
- * });
536
- * @param {object} [params] Clients parameters.
537
- * @param {number} [params.per_page] Number of results per page.
538
- * @param {number} [params.page] Page number, zero indexed.
539
- * @param {Function} [cb] Callback function.
540
- * @returns {Promise|undefined}
541
- */
542
- getClients(...args) {
543
- return this.clients.getAll(...args);
544
- }
545
-
546
- /**
547
- * Get an Auth0 client.
548
- *
549
- * @example
550
- * management.getClient({ client_id: CLIENT_ID }, function (err, client) {
551
- * if (err) {
552
- * // Handle error.
553
- * }
554
- *
555
- * console.log(client);
556
- * });
557
- * @param {object} params Client parameters.
558
- * @param {string} params.client_id Application client ID.
559
- * @param {string} params.fields Comma-separated list of fields to include or exclude (based on value provided for include_fields).
560
- * @param {string} params.include_fields Whether specified fields are to be included (true) or excluded (false).
561
- * @param {Function} [cb] Callback function.
562
- * @returns {Promise|undefined}
563
- */
564
- getClient(...args) {
565
- return this.clients.get(...args);
566
- }
567
-
568
- /**
569
- * Create an Auth0 client.
570
- *
571
- * @example
572
- * management.createClient(data, function (err) {
573
- * if (err) {
574
- * // Handle error.
575
- * }
576
- *
577
- * // Client created.
578
- * });
579
- * @param {object} data The client data object.
580
- * @param {Function} [cb] Callback function.
581
- * @returns {Promise|undefined}
582
- */
583
- createClient(...args) {
584
- return this.clients.create(...args);
585
- }
586
-
587
- /**
588
- * Update an Auth0 client.
589
- *
590
- * @example
591
- * var data = { name: 'newClientName' };
592
- * var params = { client_id: CLIENT_ID };
593
- *
594
- * management.updateClient(params, data, function (err, client) {
595
- * if (err) {
596
- * // Handle error.
597
- * }
598
- *
599
- * console.log(client.name); // 'newClientName'
600
- * });
601
- * @param {object} params Client parameters.
602
- * @param {string} params.client_id Application client ID.
603
- * @param {object} data Updated client data.
604
- * @param {Function} [cb] Callback function.
605
- * @returns {Promise|undefined}
606
- */
607
- updateClient(...args) {
608
- return this.clients.update(...args);
609
- }
610
-
611
- /**
612
- * Delete an Auth0 client.
613
- *
614
- * @example
615
- * management.deleteClient({ client_id: CLIENT_ID }, function (err) {
616
- * if (err) {
617
- * // Handle error.
618
- * }
619
- *
620
- * // Client deleted.
621
- * });
622
- * @param {object} params Client parameters.
623
- * @param {string} params.client_id Application client ID.
624
- * @param {Function} [cb] Callback function.
625
- * @returns {Promise|undefined}
626
- */
627
- deleteClient(...args) {
628
- return this.clients.delete(...args);
629
- }
630
-
631
- /**
632
- * Get all Auth0 Client Grants.
633
- *
634
- * @example <caption>
635
- * This method takes an optional object as first argument that may be used to
636
- * specify pagination settings. If pagination options are not present,
637
- * the first page of a limited number of results will be returned.
638
- * </caption>
639
- *
640
- * // Pagination settings.
641
- * var params = {
642
- * per_page: 10,
643
- * page: 0
644
- * };
645
- *
646
- * management.getClientGrants(params, function (err, grants) {
647
- * console.log(grants.length);
648
- * });
649
- * @param {object} [params] Client Grants parameters.
650
- * @param {number} [params.per_page] Number of results per page.
651
- * @param {number} [params.page] Page number, zero indexed.
652
- * @param {Function} [cb] Callback function.
653
- * @returns {Promise|undefined}
654
- */
655
- getClientGrants(...args) {
656
- return this.clientGrants.getAll(...args);
657
- }
658
-
659
- /**
660
- * Create an Auth0 client grant.
661
- *
662
- * @example
663
- * management.clientGrants.create(data, function (err) {
664
- * if (err) {
665
- * // Handle error.
666
- * }
667
- *
668
- * // Client grant created.
669
- * });
670
- * @param {object} data The client data object.
671
- * @param {Function} [cb] Callback function.
672
- * @returns {Promise|undefined}
673
- */
674
- createClientGrant(...args) {
675
- return this.clientGrants.create(...args);
676
- }
677
-
678
- /**
679
- * Update an Auth0 client grant.
680
- *
681
- * @example
682
- * var data = {
683
- * client_id: CLIENT_ID,
684
- * audience: AUDIENCE,
685
- * scope: []
686
- * };
687
- * var params = { id: CLIENT_GRANT_ID };
688
- *
689
- * management.clientGrants.update(params, data, function (err, grant) {
690
- * if (err) {
691
- * // Handle error.
692
- * }
693
- *
694
- * console.log(grant.id);
695
- * });
696
- * @param {object} params Client parameters.
697
- * @param {string} params.id Client grant ID.
698
- * @param {object} data Updated client data.
699
- * @param {Function} [cb] Callback function.
700
- * @returns {Promise|undefined}
701
- */
702
- updateClientGrant(...args) {
703
- return this.clientGrants.update(...args);
704
- }
705
-
706
- /**
707
- * Delete an Auth0 client grant.
708
- *
709
- * @example
710
- * management.clientGrants.delete({ id: GRANT_ID }, function (err) {
711
- * if (err) {
712
- * // Handle error.
713
- * }
714
- *
715
- * // Grant deleted.
716
- * });
717
- * @param {object} params Client parameters.
718
- * @param {string} params.id Client grant ID.
719
- * @param {Function} [cb] Callback function.
720
- * @returns {Promise|undefined}
721
- */
722
- deleteClientGrant(...args) {
723
- return this.clientGrants.delete(...args);
724
- }
725
-
726
- /**
727
- * Get all Auth0 Grants.
728
- *
729
- * @example
730
- * var params = {
731
- * per_page: 10,
732
- * page: 0,
733
- * include_totals: true,
734
- * user_id: USER_ID,
735
- * client_id: CLIENT_ID,
736
- * audience: AUDIENCE
737
- * };
738
- *
739
- * management.getGrants(params, function (err, grants) {
740
- * console.log(grants.length);
741
- * });
742
- * @param {object} params Grants parameters.
743
- * @param {number} params.per_page Number of results per page.
744
- * @param {number} params.page Page number, zero indexed.
745
- * @param {boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
746
- * @param {string} params.user_id The user_id of the grants to retrieve.
747
- * @param {string} params.client_id The client_id of the grants to retrieve.
748
- * @param {string} params.audience The audience of the grants to retrieve.
749
- * @param {Function} [cb] Callback function.
750
- * @returns {Promise|undefined}
751
- */
752
- getGrants(...args) {
753
- return this.grants.getAll(...args);
754
- }
755
-
756
- /**
757
- * Delete an Auth0 grant.
758
- *
759
- * @example
760
- * var params = {
761
- * id: GRANT_ID,
762
- * user_id: USER_ID
763
- * };
764
- *
765
- * management.deleteGrant(params, function (err) {
766
- * if (err) {
767
- * // Handle error.
768
- * }
769
- *
770
- * // Grant deleted.
771
- * });
772
- * @param {object} params Grant parameters.
773
- * @param {string} params.id Grant ID.
774
- * @param {string} params.user_id The user_id of the grants to delete.
775
- * @param {Function} [cb] Callback function.
776
- * @returns {Promise|undefined}
777
- */
778
- deleteGrant(...args) {
779
- return this.grants.delete(...args);
780
- }
781
-
782
- /**
783
- * Create an Auth0 credential.
784
- *
785
- * @example
786
- * management.createConnection(data, function (err) {
787
- * if (err) {
788
- * // Handle error.
789
- * }
790
- *
791
- * // Credential created.
792
- * });
793
- * @param {object} data The device credential data object.
794
- * @param {Function} [cb] Callback function.
795
- * @returns {Promise|undefined}
796
- */
797
- createDevicePublicKey(...args) {
798
- return this.deviceCredentials.createPublicKey(...args);
799
- }
800
-
801
- /**
802
- * Get all Auth0 credentials.
803
- *
804
- * @example
805
- * var params = {user_id: "USER_ID"};
806
- *
807
- * management.getDeviceCredentials(params, function (err, credentials) {
808
- * console.log(credentials.length);
809
- * });
810
- * @param {object} params Credential parameters.
811
- * @param {Function} [cb] Callback function.
812
- * @returns {Promise|undefined}
813
- */
814
- getDeviceCredentials(...args) {
815
- return this.deviceCredentials.getAll(...args);
816
- }
817
-
818
- /**
819
- * Delete an Auth0 device credential.
820
- *
821
- * @example
822
- * var params = { id: CREDENTIAL_ID };
823
- *
824
- * management.deleteDeviceCredential(params, function (err) {
825
- * if (err) {
826
- * // Handle error.
827
- * }
828
- *
829
- * // Credential deleted.
830
- * });
831
- * @param {object} params Credential parameters.
832
- * @param {string} params.id Device credential ID.
833
- * @param {Function} [cb] Callback function.
834
- * @returns {Promise|undefined}
835
- */
836
- deleteDeviceCredential(...args) {
837
- return this.deviceCredentials.delete(...args);
838
- }
839
-
840
- /**
841
- * Get all rules.
842
- *
843
- * @example <caption>
844
- * This method takes an optional object as first argument that may be used to
845
- * specify pagination settings. If pagination options are not present,
846
- * the first page of a limited number of results will be returned.
847
- * </caption>
848
- *
849
- * // Pagination settings.
850
- * var params = {
851
- * per_page: 10,
852
- * page: 0
853
- * };
854
- *
855
- * management.getRules(params, function (err, rules) {
856
- * console.log(rules.length);
857
- * });
858
- * @param {object} [params] Rules parameters.
859
- * @param {number} [params.per_page] Number of results per page.
860
- * @param {number} [params.page] Page number, zero indexed.
861
- * @param {Function} [cb] Callback function.
862
- * @returns {Promise|undefined}
863
- */
864
- getRules(...args) {
865
- return this.rules.getAll(...args);
866
- }
867
-
868
- /**
869
- * Create a new rule.
870
- *
871
- * @example
872
- * management.createRule(data, function (err) {
873
- * if (err) {
874
- * // Handle error.
875
- * }
876
- *
877
- * // Rule created.
878
- * });
879
- * @param {object} data Rule data object.
880
- * @param {Function} [cb] Callback function.
881
- * @returns {Promise|undefined}
882
- */
883
- createRule(...args) {
884
- return this.rules.create(...args);
885
- }
886
-
887
- /**
888
- * Get an Auth0 rule.
889
- *
890
- * @example
891
- * management.getRule({ id: RULE_ID }, function (err, rule) {
892
- * if (err) {
893
- * // Handle error.
894
- * }
895
- *
896
- * console.log(rule);
897
- * });
898
- * @param {object} params Rule parameters.
899
- * @param {string} params.id Rule ID.
900
- * @param {Function} [cb] Callback function.
901
- * @returns {Promise|undefined}
902
- */
903
- getRule(...args) {
904
- return this.rules.get(...args);
905
- }
906
-
907
- /**
908
- * Delete an existing rule.
909
- *
910
- * @example
911
- * auth0.deleteRule({ id: RULE_ID }, function (err) {
912
- * if (err) {
913
- * // Handle error.
914
- * }
915
- *
916
- * // Rule deleted.
917
- * });
918
- * @param {object} params Rule parameters.
919
- * @param {string} params.id Rule ID.
920
- * @param {Function} [cb] Callback function.
921
- * @returns {Promise|undefined}
922
- */
923
- deleteRule(...args) {
924
- return this.rules.delete(...args);
925
- }
926
-
927
- /**
928
- * Update an existing rule.
929
- *
930
- * @example
931
- * var params = { id: RULE_ID };
932
- * var data = { name: 'my-rule'};
933
- * management.updateRule(params, data, function (err, rule) {
934
- * if (err) {
935
- * // Handle error.
936
- * }
937
- *
938
- * console.log(rule.name); // 'my-rule'.
939
- * });
940
- * @param {object} params Rule parameters.
941
- * @param {string} params.id Rule ID.
942
- * @param {object} data Updated rule data.
943
- * @param {Function} [cb] Callback function.
944
- * @returns {Promise|undefined}
945
- */
946
- updateRule(...args) {
947
- return this.rules.update(...args);
948
- }
949
-
950
- /**
951
- * Get all users.
952
- *
953
- * @example <caption>
954
- * This method takes an optional object as first argument that may be used to
955
- * specify pagination settings. If pagination options are not present,
956
- * the first page of a limited number of results will be returned.
957
- * </caption>
958
- *
959
- * // Pagination settings.
960
- * var params = {
961
- * search_engine: 'v3',
962
- * q: 'name:*jane*',
963
- * per_page: 10,
964
- * page: 0
965
- * };
966
- *
967
- * auth0.getUsers(params, function (err, users) {
968
- * console.log(users.length);
969
- * });
970
- * @param {object} [params] Users params.
971
- * @param {number} [params.search_engine] The version of the search engine to use.
972
- * @param {string} [params.q] User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
973
- * @param {number} [params.per_page] Number of results per page.
974
- * @param {number} [params.page] Page number, zero indexed.
975
- * @param {Function} [cb] Callback function.
976
- * @returns {Promise|undefined}
977
- */
978
- getUsers(...args) {
979
- return this.users.getAll(...args);
980
- }
981
-
982
- /**
983
- * Get users for a given email address
984
- *
985
- * @example <caption>
986
- * This method takes an email address as the first argument,
987
- * and returns all users with that email address
988
- * </caption>
989
- *
990
- * auth0.getUsersByEmail(email, function (err, users) {
991
- * console.log(users);
992
- * });
993
- * @param {string} [email] Email address of user(s) to find
994
- * @param {object} [options] Additional options to pass to the endpoint
995
- * @param {string} [options.fields] Comma-separated list of fields to include or exclude in the result
996
- * @param {boolean} [options.include_fields] Whether specified fields are to be included (true) or excluded (false). Defaults to true.
997
- * @param {Function} [cb] Callback function.
998
- * @returns {Promise|undefined}
999
- */
1000
- getUsersByEmail(...args) {
1001
- return this.users.getByEmail(...args);
1002
- }
1003
-
1004
- /**
1005
- * Get a user by its id.
1006
- *
1007
- * @example
1008
- * management.getUser({ id: USER_ID }, function (err, user) {
1009
- * console.log(user);
1010
- * });
1011
- * @param {object} data The user data object.
1012
- * @param {string} data.id The user id.
1013
- * @param {Function} [cb] Callback function.
1014
- * @returns {Promise|undefined}
1015
- */
1016
- getUser(...args) {
1017
- return this.users.get(...args);
1018
- }
1019
-
1020
- /**
1021
- * Delete all users.
1022
- *
1023
- * @example
1024
- * management.deleteAllUsers(function (err) {
1025
- * if (err) {
1026
- * // Handle error.
1027
- * }
1028
- *
1029
- * // Users deleted
1030
- * });
1031
- * @param {Function} [cb] Callback function
1032
- * @returns {Promise|undefined}
1033
- * @deprecated This method will be removed in the next major release.
1034
- */
1035
- deleteAllUsers(...args) {
1036
- return this.users.deleteAll(...args);
1037
- }
1038
-
1039
- /**
1040
- * Delete a user by its id.
1041
- *
1042
- * @example
1043
- * management.deleteUser({ id: USER_ID }, function (err) {
1044
- * if (err) {
1045
- * // Handle error.
1046
- * }
1047
- *
1048
- * // User deleted.
1049
- * });
1050
- * @param {object} params The user data object..
1051
- * @param {string} params.id The user id.
1052
- * @param {Function} [cb] Callback function
1053
- * @returns {Promise|undefined}
1054
- */
1055
- deleteUser(...args) {
1056
- return this.users.delete(...args);
1057
- }
1058
-
1059
- /**
1060
- * Create a new user.
1061
- *
1062
- * @example
1063
- * management.createUser(data, function (err) {
1064
- * if (err) {
1065
- * // Handle error.
1066
- * }
1067
- *
1068
- * // User created.
1069
- * });
1070
- * @param {object} data User data.
1071
- * @param {Function} [cb] Callback function.
1072
- * @returns {Promise|undefined}
1073
- */
1074
- createUser(...args) {
1075
- return this.users.create(...args);
1076
- }
1077
-
1078
- /**
1079
- * Update a user by its id.
1080
- *
1081
- * @example
1082
- * var params = { id: USER_ID };
1083
- *
1084
- * management.updateUser(params, data, function (err, user) {
1085
- * if (err) {
1086
- * // Handle error.
1087
- * }
1088
- *
1089
- * // Updated user.
1090
- * console.log(user);
1091
- * });
1092
- * @param {object} params The user parameters.
1093
- * @param {string} params.id The user id.
1094
- * @param {object} data New user data.
1095
- * @param {Function} [cb] Callback function
1096
- * @returns {Promise|undefined}
1097
- */
1098
- updateUser(...args) {
1099
- return this.users.update(...args);
1100
- }
1101
-
1102
- /**
1103
- * Update the user metadata for a user.
1104
- *
1105
- * @example
1106
- * var params = { id: USER_ID };
1107
- * var metadata = {
1108
- * address: '123th Node.js Street'
1109
- * };
1110
- *
1111
- * management.updateUserMetadata(params, metadata, function (err, user) {
1112
- * if (err) {
1113
- * // Handle error.
1114
- * }
1115
- *
1116
- * // Updated user.
1117
- * console.log(user);
1118
- * });
1119
- * @param {object} params The user data object..
1120
- * @param {string} params.id The user id.
1121
- * @param {object} metadata New user metadata.
1122
- * @param {Function} [cb] Callback function
1123
- * @returns {Promise|undefined}
1124
- */
1125
- updateUserMetadata(...args) {
1126
- return this.users.updateUserMetadata(...args);
1127
- }
1128
-
1129
- /**
1130
- * Update the app metadata for a user.
1131
- *
1132
- * @example
1133
- * var params = { id: USER_ID };
1134
- * var metadata = {
1135
- * foo: 'bar'
1136
- * };
1137
- *
1138
- * management.updateAppMetadata(params, metadata, function (err, user) {
1139
- * if (err) {
1140
- * // Handle error.
1141
- * }
1142
- *
1143
- * // Updated user.
1144
- * console.log(user);
1145
- * });
1146
- * @param {object} params The user data object..
1147
- * @param {string} params.id The user id.
1148
- * @param {object} metadata New app metadata.
1149
- * @param {Function} [cb] Callback function
1150
- * @returns {Promise|undefined}
1151
- */
1152
- updateAppMetadata(...args) {
1153
- return this.users.updateAppMetadata(...args);
1154
- }
1155
-
1156
- /**
1157
- * Delete a multifactor provider for a user.
1158
- *
1159
- * @example
1160
- * var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
1161
- *
1162
- * management.deleteUserMultifactor(params, function (err, user) {
1163
- * if (err) {
1164
- * // Handle error.
1165
- * }
1166
- *
1167
- * // Users accounts unlinked.
1168
- * });
1169
- * @param {object} params Data object.
1170
- * @param {string} params.id The user id.
1171
- * @param {string} params.provider Multifactor provider.
1172
- * @param {Function} [cb] Callback function
1173
- * @returns {Promise|undefined}
1174
- */
1175
- deleteUserMultifactor(...args) {
1176
- return this.users.deleteMultifactorProvider(...args);
1177
- }
1178
-
1179
- /**
1180
- * Delete a multifactor provider for a user.
1181
- *
1182
- * @example
1183
- * var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
1184
- *
1185
- * management.deleteUserMultifcator(params, function (err, user) {
1186
- * if (err) {
1187
- * // Handle error.
1188
- * }
1189
- *
1190
- * // Users accounts unlinked.
1191
- * });
1192
- * @param {object} params Data object.
1193
- * @param {string} params.id The user id.
1194
- * @param {string} params.provider Multifactor provider.
1195
- * @param {Function} [cb] Callback function
1196
- * @returns {Promise|undefined}
1197
- * @deprecated The function name has a typo.
1198
- * We're shipping this so it doesn't break compatibility.
1199
- * Use {@link deleteUserMultifactor} instead.
1200
- */
1201
- deleteUserMultifcator(...args) {
1202
- return this.users.deleteMultifactorProvider(...args);
1203
- }
1204
-
1205
- /**
1206
- * Unlink the given accounts.
1207
- *
1208
- * @example
1209
- * var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
1210
- *
1211
- * management.unlinkUsers(params, function (err, user) {
1212
- * if (err) {
1213
- * // Handle error.
1214
- * }
1215
- *
1216
- * // Users accounts unlinked.
1217
- * });
1218
- * @param {object} params Linked users data.
1219
- * @param {string} params.id Primary user ID.
1220
- * @param {string} params.provider Identity provider in use.
1221
- * @param {string} params.user_id Secondary user ID.
1222
- * @param {Function} [cb] Callback function.
1223
- * @returns {Promise|undefined}
1224
- */
1225
- unlinkUsers(...args) {
1226
- return this.users.unlink(...args);
1227
- }
1228
-
1229
- /**
1230
- * Link the user with another account.
1231
- *
1232
- * @example
1233
- * var userId = 'USER_ID';
1234
- * var params = {
1235
- * user_id: 'OTHER_USER_ID',
1236
- * connection_id: 'CONNECTION_ID'
1237
- * };
1238
- *
1239
- * management.linkUsers(userId, params, function (err, user) {
1240
- * if (err) {
1241
- * // Handle error.
1242
- * }
1243
- *
1244
- * // Users linked.
1245
- * });
1246
- * @param {string} userId ID of the primary user.
1247
- * @param {object} params Secondary user data.
1248
- * @param {string} params.user_id ID of the user to be linked.
1249
- * @param {string} params.connection_id ID of the connection to be used.
1250
- * @param {string} params.provider Identity provider of the secondary user account being linked.
1251
- * @param {string} params.link_with JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.
1252
- * @param {Function} [cb] Callback function.
1253
- * @returns {Promise|undefined}
1254
- */
1255
- linkUsers(...args) {
1256
- return this.users.link(...args);
1257
- }
1258
-
1259
- /**
1260
- * Get user's log events.
1261
- *
1262
- * @example
1263
- * var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
1264
- *
1265
- * management.getUserLogs(params, function (err, logs) {
1266
- * if (err) {
1267
- * // Handle error.
1268
- * }
1269
- *
1270
- * console.log(logs);
1271
- * });
1272
- * @param {object} params Get logs data.
1273
- * @param {string} params.id User id.
1274
- * @param {number} params.per_page Number of results per page.
1275
- * @param {number} params.page Page number, zero indexed.
1276
- * @param {string} params.sort The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
1277
- * @param {boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
1278
- * @param {Function} [cb] Callback function.
1279
- * @returns {Promise|undefined}
1280
- */
1281
- getUserLogs(...args) {
1282
- return this.users.logs(...args);
1283
- }
1284
-
1285
- /**
1286
- * Get user's roles
1287
- *
1288
- * @example
1289
- * var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
1290
- *
1291
- * management.getUserRoles(params, function (err, logs) {
1292
- * if (err) {
1293
- * // Handle error.
1294
- * }
1295
- *
1296
- * console.log(logs);
1297
- * });
1298
- * @param {object} params Get roles data.
1299
- * @param {string} params.id User id.
1300
- * @param {number} params.per_page Number of results per page.
1301
- * @param {number} params.page Page number, zero indexed.
1302
- * @param {string} params.sort The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
1303
- * @param {boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
1304
- * @param {Function} [cb] Callback function.
1305
- * @returns {Promise|undefined}
1306
- */
1307
- getUserRoles(...args) {
1308
- return this.users.getRoles(...args);
1309
- }
1310
-
1311
- /**
1312
- * Assign roles to a user
1313
- *
1314
- * @example
1315
- * var parms = { id : 'USER_ID'};
1316
- * var data = { "roles" :["role1"]};
1317
- *
1318
- * management.assignRolestoUser(params, data, function (err) {
1319
- * if (err) {
1320
- * // Handle error.
1321
- * }
1322
- *
1323
- * // User assigned roles.
1324
- * });
1325
- * @param {object} params params object
1326
- * @param {string} params.id user_id
1327
- * @param {object} data data object containing list of role IDs
1328
- * @param {string} data.roles Array of role IDs
1329
- * @param {Function} [cb] Callback function.
1330
- * @returns {Promise|undefined}
1331
- */
1332
- assignRolestoUser(...args) {
1333
- return this.users.assignRoles(...args);
1334
- }
1335
-
1336
- /**
1337
- * Assign users to a role
1338
- *
1339
- * @example
1340
- * var params = { id :'ROLE_ID'};
1341
- * var data = { "users" : ["userId1","userId2"]};
1342
- *
1343
- * management.roles.assignUsers(params, data, function (err, user) {
1344
- * if (err) {
1345
- * // Handle error.
1346
- * }
1347
- *
1348
- * // permissions added.
1349
- * });
1350
- * @param {string} params.id ID of the Role.
1351
- * @param {object} data permissions data
1352
- * @param {string} data.permissions Array of permissions
1353
- * @param {string} data.permissions.permission_name Name of a permission
1354
- * @param {string} data.permissions.resource_server_identifier Identifier for a resource
1355
- * @param {Function} [cb] Callback function.
1356
- * @returns {Promise|undefined}
1357
- */
1358
- assignUsersToRole(...args) {
1359
- return this.roles.assignUsers(...args);
1360
- }
1361
-
1362
- /**
1363
- * Remove roles from a user
1364
- *
1365
- * @example
1366
- * var parms = { id : 'USER_ID'};
1367
- * var data = { "roles" :["role1"]};
1368
- *
1369
- * management.removeRolesFromUser(params, data, function (err) {
1370
- * if (err) {
1371
- * // Handle error.
1372
- * }
1373
- *
1374
- * // User assigned roles.
1375
- * });
1376
- * @param {object} params params object
1377
- * @param {string} params.id user_id
1378
- * @param {string} data data object containing list of role IDs
1379
- * @param {string} data.roles Array of role IDs
1380
- * @param {Function} [cb] Callback function.
1381
- * @returns {Promise|undefined}
1382
- */
1383
- removeRolesFromUser(...args) {
1384
- return this.users.removeRoles(...args);
1385
- }
1386
-
1387
- /**
1388
- * Get user's permissions
1389
- *
1390
- * @example
1391
- * var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
1392
- *
1393
- * management.getUserPermissions(params, function (err, logs) {
1394
- * if (err) {
1395
- * // Handle error.
1396
- * }
1397
- *
1398
- * console.log(logs);
1399
- * });
1400
- * @param {object} params Get permissions data.
1401
- * @param {string} params.id User id.
1402
- * @param {number} params.per_page Number of results per page.
1403
- * @param {number} params.page Page number, zero indexed.
1404
- * @param {string} params.sort The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
1405
- * @param {boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
1406
- * @param {Function} [cb] Callback function.
1407
- * @returns {Promise|undefined}
1408
- */
1409
- getUserPermissions(...args) {
1410
- return this.users.getPermissions(...args);
1411
- }
1412
-
1413
- /**
1414
- * Assign permissions to a user
1415
- *
1416
- * @example
1417
- * var parms = { id : 'USER_ID'};
1418
- * var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
1419
- *
1420
- * management.assignPermissionsToUser(params, data, function (err) {
1421
- * if (err) {
1422
- * // Handle error.
1423
- * }
1424
- *
1425
- * // User assigned permissions.
1426
- * });
1427
- * @param {object} params params object
1428
- * @param {string} params.id user_id
1429
- * @param {string} data data object containing list of permissions
1430
- * @param {string} data.permissions Array of permission IDs
1431
- * @param {Function} [cb] Callback function.
1432
- * @returns {Promise|undefined}
1433
- */
1434
- assignPermissionsToUser(...args) {
1435
- return this.users.assignPermissions(...args);
1436
- }
1437
-
1438
- /**
1439
- * Remove permissions from a user
1440
- *
1441
- * @example
1442
- * var parms = { id : 'USER_ID'};
1443
- * var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
1444
- *
1445
- * management.removePermissionsFromUser(params, data, function (err) {
1446
- * if (err) {
1447
- * // Handle error.
1448
- * }
1449
- *
1450
- * // User assigned permissions.
1451
- * });
1452
- * @param {object} params params object
1453
- * @param {string} params.id user_id
1454
- * @param {string} data data object containing list of permission IDs
1455
- * @param {string} data.permissions Array of permission IDs
1456
- * @param {Function} [cb] Callback function.
1457
- * @returns {Promise|undefined}
1458
- */
1459
- removePermissionsFromUser(...args) {
1460
- return this.users.removePermissions(...args);
1461
- }
1462
-
1463
- /**
1464
- * Get a list of a user's Guardian enrollments.
1465
- *
1466
- * @example
1467
- * management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
1468
- * console.log(enrollments);
1469
- * });
1470
- * @param {object} data The user data object.
1471
- * @param {string} data.id The user id.
1472
- * @param {Function} [cb] Callback function.
1473
- * @returns {Promise|undefined}
1474
- */
1475
- getGuardianEnrollments(...args) {
1476
- return this.users.getGuardianEnrollments(...args);
1477
- }
1478
-
1479
- /**
1480
- * Generate new Guardian recovery code.
1481
- *
1482
- * @example
1483
- * management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
1484
- * console.log(newRecoveryCode);
1485
- * });
1486
- * @param {object} data The user data object.
1487
- * @param {string} data.id The user id.
1488
- * @param {Function} [cb] Callback function.
1489
- * @returns {Promise|undefined}
1490
- */
1491
- regenerateRecoveryCode(...args) {
1492
- return this.users.regenerateRecoveryCode(...args);
1493
- }
1494
-
1495
- /**
1496
- * Invalidate all remembered browsers for MFA.
1497
- *
1498
- * @example
1499
- * management.invalidateRememberBrowser({ id: USER_ID }, function (err) {
1500
- * if (err) {
1501
- * // Handle error.
1502
- * }
1503
- *
1504
- * // Invalidated all remembered browsers.
1505
- * });
1506
- * @param {object} data The user data object.
1507
- * @param {string} data.id The user id.
1508
- * @param {Function} [cb] Callback function.
1509
- * @returns {Promise|undefined}
1510
- */
1511
- invalidateRememberBrowser(...args) {
1512
- return this.users.invalidateRememberBrowser(...args);
1513
- }
1514
-
1515
- /**
1516
- * Get user blocks by its id.
1517
- *
1518
- * @example
1519
- * management.getUserBlocks({ id: USER_ID }, function (err, blocks) {
1520
- * if (err) {
1521
- * // Handle error.
1522
- * }
1523
- *
1524
- * console.log(blocks);
1525
- * });
1526
- * @param {object} params The user data object..
1527
- * @param {string} params.id The user id.
1528
- * @param {Function} [cb] Callback function
1529
- * @returns {Promise|undefined}
1530
- */
1531
- getUserBlocks(...args) {
1532
- return this.userBlocks.get(...args);
1533
- }
1534
-
1535
- /**
1536
- * Unblock an user by its id.
1537
- *
1538
- * @example
1539
- * management.unblockUser({ id: USER_ID }, function (err) {
1540
- * if (err) {
1541
- * // Handle error.
1542
- * }
1543
- *
1544
- * // User unblocked.
1545
- * });
1546
- * @param {object} params The user data object..
1547
- * @param {string} params.id The user id.
1548
- * @param {Function} [cb] Callback function
1549
- * @returns {Promise|undefined}
1550
- */
1551
- unblockUser(...args) {
1552
- return this.userBlocks.delete(...args);
1553
- }
1554
-
1555
- /**
1556
- * Get user blocks by its identifier.
1557
- *
1558
- * @example
1559
- * management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
1560
- * if (err) {
1561
- * // Handle error.
1562
- * }
1563
- *
1564
- * console.log(blocks);
1565
- * });
1566
- * @param {object} params The user data object..
1567
- * @param {string} params.identifier The user identifier, any of: username, phone_number, email.
1568
- * @param {Function} [cb] Callback function
1569
- * @returns {Promise|undefined}
1570
- */
1571
- getUserBlocksByIdentifier(...args) {
1572
- return this.userBlocks.getByIdentifier(...args);
1573
- }
1574
-
1575
- /**
1576
- * Unblock an user by its id.
1577
- *
1578
- * @example
1579
- * management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
1580
- * if (err) {
1581
- * // Handle error.
1582
- * }
1583
- *
1584
- * // User unblocked.
1585
- * });
1586
- * @param {object} params The user data object..
1587
- * @param {string} params.identifier The user identifier, any of: username, phone_number, email.
1588
- * @param {Function} [cb] Callback function
1589
- * @returns {Promise|undefined}
1590
- */
1591
- unblockUserByIdentifier(...args) {
1592
- return this.userBlocks.deleteByIdentifier(...args);
1593
- }
1594
-
1595
- /**
1596
- * Get a single Guardian enrollment.
1597
- *
1598
- * @example
1599
- * management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
1600
- * console.log(enrollment);
1601
- * });
1602
- * @param {object} data The Guardian enrollment data object.
1603
- * @param {string} data.id The Guardian enrollment id.
1604
- * @param {Function} [cb] Callback function.
1605
- * @returns {Promise|undefined}
1606
- */
1607
- getGuardianEnrollment(...args) {
1608
- return this.guardian.getGuardianEnrollment(...args);
1609
- }
1610
-
1611
- /**
1612
- * Delete a user's Guardian enrollment.
1613
- *
1614
- * @example
1615
- * management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
1616
- * if (err) {
1617
- * // Handle error.
1618
- * }
1619
- *
1620
- * // Email provider deleted.
1621
- * });
1622
- * @param {object} data The Guardian enrollment data object.
1623
- * @param {string} data.id The Guardian enrollment id.
1624
- * @param {Function} [cb] Callback function.
1625
- * @returns {Promise|undefined}
1626
- */
1627
- deleteGuardianEnrollment(...args) {
1628
- return this.guardian.deleteGuardianEnrollment(...args);
1629
- }
1630
-
1631
- /**
1632
- * Get all blacklisted tokens.
1633
- *
1634
- * @example
1635
- * management.getBlacklistedTokens(function (err, tokens) {
1636
- * console.log(tokens.length);
1637
- * });
1638
- * @param {Function} [cb] Callback function.
1639
- * @returns {Promise|undefined}
1640
- */
1641
- getBlacklistedTokens(...args) {
1642
- return this.blacklistedTokens.getAll(...args);
1643
- }
1644
-
1645
- /**
1646
- * Blacklist a new token.
1647
- *
1648
- * @example
1649
- * var token = {
1650
- * aud: 'aud',
1651
- * jti: 'jti'
1652
- * };
1653
- *
1654
- * management.blacklistToken(token, function (err) {
1655
- * if (err) {
1656
- * // Handle error.
1657
- * }
1658
- *
1659
- * // Token blacklisted.
1660
- * });
1661
- * @param {object} token Token data.
1662
- * @param {string} token.aud Audience (your app client ID).
1663
- * @param {string} token.jti The JWT ID claim.
1664
- * @param {Function} [cb] Callback function.
1665
- * @returns {Promise|undefined}
1666
- */
1667
- blacklistToken(...args) {
1668
- return this.blacklistedTokens.add(...args);
1669
- }
1670
-
1671
- /**
1672
- * Create a new Email Template.
1673
- *
1674
- * @example
1675
- * management.createEmailTemplate(data, function (err) {
1676
- * if (err) {
1677
- * // Handle error.
1678
- * // Email Template created.
1679
- * });
1680
- * @param {object} data Email Template data object.
1681
- * @param {Function} [cb] Callback function.
1682
- * @returns {Promise|undefined}
1683
- */
1684
- createEmailTemplate(...args) {
1685
- return this.emailTemplates.create(...args);
1686
- }
1687
-
1688
- /**
1689
- * Get an Auth0 Email Template.
1690
- *
1691
- * @example
1692
- * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
1693
- * if (err) {
1694
- * // Handle error.
1695
- * }
1696
- *
1697
- * console.log(emailTemplate);
1698
- * });
1699
- * @param {object} params Email Template parameters.
1700
- * @param {string} params.name Template Name
1701
- * @param {Function} [cb] Callback function.
1702
- * @returns {Promise|undefined}
1703
- */
1704
- getEmailTemplate(...args) {
1705
- return this.emailTemplates.get(...args);
1706
- }
1707
-
1708
- /**
1709
- * Update an existing Email Template.
1710
- *
1711
- * @example
1712
- * var data = { from: 'new@email.com' };
1713
- * var params = { name: EMAIL_TEMPLATE_NAME };
1714
- *
1715
- * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
1716
- * if (err) {
1717
- * // Handle error.
1718
- * }
1719
- *
1720
- * console.log(emailTemplate.from); // 'new@email.com'
1721
- * });
1722
- * @param {object} params Email Template parameters.
1723
- * @param {string} params.name Template Name
1724
- * @param {object} data Updated Email Template data.
1725
- * @param {Function} [cb] Callback function.
1726
- * @returns {Promise|undefined}
1727
- */
1728
- updateEmailTemplate(...args) {
1729
- return this.emailTemplates.update(...args);
1730
- }
1731
-
1732
- /**
1733
- * Get the email provider.
1734
- *
1735
- * @example
1736
- * management.getEmailProvider(function (err, provider) {
1737
- * console.log(provider.length);
1738
- * });
1739
- * @param {Function} [cb] Callback function.
1740
- * @param {object} [params] Clients parameters.
1741
- * @param {number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
1742
- * @param {number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
1743
- * @returns {Promise|undefined}
1744
- */
1745
- getEmailProvider(...args) {
1746
- return this.emailProvider.get(...args);
1747
- }
1748
-
1749
- /**
1750
- * Configure the email provider.
1751
- *
1752
- * @example
1753
- * management.configureEmailProvider(data, function (err) {
1754
- * if (err) {
1755
- * // Handle error.
1756
- * }
1757
- *
1758
- * // Email provider configured.
1759
- * });
1760
- * @param {object} data The email provider data object.
1761
- * @param {Function} [cb] Callback function.
1762
- * @returns {Promise|undefined}
1763
- */
1764
- configureEmailProvider(...args) {
1765
- return this.emailProvider.configure(...args);
1766
- }
1767
-
1768
- /**
1769
- * Delete email provider.
1770
- *
1771
- * @example
1772
- * management.deleteEmailProvider(function (err) {
1773
- * if (err) {
1774
- * // Handle error.
1775
- * }
1776
- *
1777
- * // Email provider deleted.
1778
- * });
1779
- * @param {Function} [cb] Callback function.
1780
- * @returns {Promise|undefined}
1781
- */
1782
- deleteEmailProvider(...args) {
1783
- return this.emailProvider.delete(...args);
1784
- }
1785
-
1786
- /**
1787
- * Update the email provider.
1788
- *
1789
- * @example
1790
- * management.updateEmailProvider(params, data, function (err, provider) {
1791
- * if (err) {
1792
- * // Handle error.
1793
- * }
1794
- *
1795
- * // Updated email provider.
1796
- * console.log(provider);
1797
- * });
1798
- * @param {object} params Email provider parameters.
1799
- * @param {object} data Updated email provider data.
1800
- * @param {Function} [cb] Callback function.
1801
- * @returns {Promise|undefined}
1802
- */
1803
- updateEmailProvider(...args) {
1804
- return this.emailProvider.update(...args);
1805
- }
1806
-
1807
- /**
1808
- * Get a the active users count.
1809
- *
1810
- * @example
1811
- * management.getActiveUsersCount(function (err, usersCount) {
1812
- * if (err) {
1813
- * // Handle error.
1814
- * }
1815
- *
1816
- * console.log(usersCount);
1817
- * });
1818
- * @param {Function} [cb] Callback function.
1819
- * @returns {Promise|undefined}
1820
- */
1821
- getActiveUsersCount(...args) {
1822
- return this.stats.getActiveUsersCount(...args);
1823
- }
1824
-
1825
- /**
1826
- * Get the daily stats.
1827
- *
1828
- * @example
1829
- * var params = {
1830
- * from: '{YYYYMMDD}', // First day included in the stats.
1831
- * to: '{YYYYMMDD}' // Last day included in the stats.
1832
- * };
1833
- *
1834
- * management.getDaily(params, function (err, stats) {
1835
- * if (err) {
1836
- * // Handle error.
1837
- * }
1838
- *
1839
- * console.log(stats);
1840
- * });
1841
- * @param {object} params Stats parameters.
1842
- * @param {string} params.from The first day in YYYYMMDD format.
1843
- * @param {string} params.to The last day in YYYYMMDD format.
1844
- * @param {Function} [cb] Callback function.
1845
- * @returns {Promise|undefined}
1846
- */
1847
- getDailyStats(...args) {
1848
- return this.stats.getDaily(...args);
1849
- }
1850
-
1851
- /**
1852
- * Get the tenant settings..
1853
- *
1854
- * @example
1855
- * management.getSettings(function (err, settings) {
1856
- * if (err) {
1857
- * // Handle error.
1858
- * }
1859
- *
1860
- * console.log(settings);
1861
- * });
1862
- * @param {Function} [cb] Callback function.
1863
- * @returns {Promise|undefined}
1864
- */
1865
- getTenantSettings(...args) {
1866
- return this.tenant.getSettings(...args);
1867
- }
1868
-
1869
- /**
1870
- * Update the tenant settings.
1871
- *
1872
- * @example
1873
- * management.updateTenantSettings(data, function (err) {
1874
- * if (err) {
1875
- * // Handle error.
1876
- * }
1877
- * });
1878
- * @param {object} data The new tenant settings.
1879
- * @param {Function} [cb] Callback function.
1880
- * @returns {Promise|undefined}
1881
- */
1882
- updateTenantSettings(...args) {
1883
- return this.tenant.updateSettings(...args);
1884
- }
1885
-
1886
- /**
1887
- * Get a job by its ID.
1888
- *
1889
- * @example
1890
- * var params = {
1891
- * id: '{JOB_ID}'
1892
- * };
1893
- *
1894
- * management.getJob(params, function (err, job) {
1895
- * if (err) {
1896
- * // Handle error.
1897
- * }
1898
- *
1899
- * // Retrieved job.
1900
- * console.log(job);
1901
- * });
1902
- * @param {object} params Job parameters.
1903
- * @param {string} params.id Job ID.
1904
- * @param {Function} [cb] Callback function.
1905
- * @returns {Promise|undefined}
1906
- */
1907
- getJob(...args) {
1908
- return this.jobs.get(...args);
1909
- }
1910
-
1911
- /**
1912
- * Given a path to a file and a connection id, create a new job that imports the
1913
- * users contained in the file or JSON string and associate them with the given
1914
- * connection.
1915
- *
1916
- * @example
1917
- * var params = {
1918
- * connection_id: '{CONNECTION_ID}',
1919
- * users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
1920
- * };
1921
- *
1922
- * management.importUsers(params, function (err) {
1923
- * if (err) {
1924
- * // Handle error.
1925
- * }
1926
- * });
1927
- * @param {object} data Users import data.
1928
- * @param {string} data.connection_id connection_id of the connection to which users will be imported.
1929
- * @param {string} [data.users] Path to the users data file. Either users or users_json is mandatory.
1930
- * @param {string} [data.users_json] JSON data for the users.
1931
- * @param {boolean} [data.upsert] Whether to update users if they already exist (true) or to ignore them (false).
1932
- * @param {boolean} [data.send_completion_email] Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
1933
- * @param {Function} [cb] Callback function.
1934
- * @returns {Promise|undefined}
1935
- */
1936
- importUsers(...args) {
1937
- return this.jobs.importUsers(...args);
1938
- }
1939
-
1940
- /**
1941
- * Given a path to a file and a connection id, create a new job that imports the
1942
- * users contained in the file or JSON string and associate them with the given
1943
- * connection.
1944
- *
1945
- * @example
1946
- * var params = {
1947
- * connection_id: '{CONNECTION_ID}',
1948
- * users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
1949
- * };
1950
- *
1951
- * management.importUsersJob(params, function (err) {
1952
- * if (err) {
1953
- * // Handle error.
1954
- * }
1955
- * });
1956
- * @param {object} data Users import data.
1957
- * @param {string} data.connection_id connection_id of the connection to which users will be imported.
1958
- * @param {string} [data.users] Path to the users data file. Either users or users_json is mandatory.
1959
- * @param {string} [data.users_json] JSON data for the users.
1960
- * @param {boolean} [data.upsert] Whether to update users if they already exist (true) or to ignore them (false).
1961
- * @param {boolean} [data.send_completion_email] Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
1962
- * @param {Function} [cb] Callback function.
1963
- * @returns {Promise|undefined}
1964
- */
1965
- importUsersJob(...args) {
1966
- return this.jobs.importUsersJob(...args);
1967
- }
1968
-
1969
- /**
1970
- * Export all users to a file using a long running job.
1971
- *
1972
- * @example
1973
- * var data = {
1974
- * connection_id: 'con_0000000000000001',
1975
- * format: 'csv',
1976
- * limit: 5,
1977
- * fields: [
1978
- * {
1979
- * "name": "user_id"
1980
- * },
1981
- * {
1982
- * "name": "name"
1983
- * },
1984
- * {
1985
- * "name": "email"
1986
- * },
1987
- * {
1988
- * "name": "identities[0].connection",
1989
- * "export_as": "provider"
1990
- * },
1991
- * {
1992
- * "name": "user_metadata.some_field"
1993
- * }
1994
- * ]
1995
- * }
1996
- *
1997
- * management.exportUsers(data, function (err, results) {
1998
- * if (err) {
1999
- * // Handle error.
2000
- * }
2001
- *
2002
- * // Retrieved job.
2003
- * console.log(results);
2004
- * });
2005
- * @param {object} data Users export data.
2006
- * @param {string} [data.connection_id] The connection id of the connection from which users will be exported
2007
- * @param {string} [data.format] The format of the file. Valid values are: "json" and "csv".
2008
- * @param {number} [data.limit] Limit the number of records.
2009
- * @param {object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
2010
- * @param {Function} [cb] Callback function.
2011
- * @returns {Promise|undefined}
2012
- */
2013
- exportUsers(...args) {
2014
- return this.jobs.exportUsers(...args);
2015
- }
2016
-
2017
- /**
2018
- * Given a job ID, retrieve the failed/errored items
2019
- *
2020
- * @example
2021
- * var params = {
2022
- * id: '{JOB_ID}'
2023
- * };
2024
- *
2025
- * management.jobs.errors(params, function (err, job) {
2026
- * if (err) {
2027
- * // Handle error.
2028
- * }
2029
- *
2030
- * // Retrieved job.
2031
- * console.log(job);
2032
- * });
2033
- * @param {object} params Job parameters.
2034
- * @param {string} params.id Job ID.
2035
- * @param {Function} [cb] Callback function.
2036
- * @returns {Promise|undefined}
2037
- */
2038
- getJobErrors(...args) {
2039
- return this.jobs.errors(...args);
2040
- }
2041
-
2042
- /**
2043
- * Send a verification email to a user.
2044
- *
2045
- * @example
2046
- * var params = {
2047
- * user_id: '{USER_ID}'
2048
- * };
2049
- *
2050
- * management.sendEmailVerification(params, function (err) {
2051
- * if (err) {
2052
- * // Handle error.
2053
- * }
2054
- * });
2055
- * @param {object} data User data object.
2056
- * @param {string} data.user_id ID of the user to be verified.
2057
- * @param {string} [data.organization_id] Organization ID
2058
- * @param {string} [data.client_id] client_id of the client (application). If no value provided, the global Client ID will be used.
2059
- * @param {object} [data.identity] Used to verify secondary, federated, and passwordless-email identities.
2060
- * @param {string} data.identity.user_id user_id of the identity.
2061
- * @param {string} data.identity.provider provider of the identity.
2062
- * @param {Function} [cb] Callback function.
2063
- * @returns {Promise|undefined}
2064
- */
2065
- sendEmailVerification(...args) {
2066
- return this.jobs.verifyEmail(...args);
2067
- }
2068
-
2069
- /**
2070
- * Create a new password change ticket.
2071
- *
2072
- * @example
2073
- *
2074
- * var params = {
2075
- * result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
2076
- * user_id: '{USER_ID}'
2077
- * };
2078
- *
2079
- * // or
2080
- *
2081
- * var params = {
2082
- * result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
2083
- * email: '{USER_EMAIL}',
2084
- * connection_id: '{CONNECTION}' // eg. con_00000000001
2085
- * };
2086
- *
2087
- * auth0.createPasswordChangeTicket(params, function (err) {
2088
- * if (err) {
2089
- * // Handle error.
2090
- * }
2091
- * });
2092
- * @param {Function} [cb] Callback function.
2093
- * @returns {Promise}
2094
- */
2095
- createPasswordChangeTicket(...args) {
2096
- return this.tickets.changePassword(...args);
2097
- }
2098
-
2099
- /**
2100
- * Create an email verification ticket.
2101
- *
2102
- * @example
2103
- * var data = {
2104
- * user_id: '{USER_ID}',
2105
- * result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
2106
- * };
2107
- *
2108
- * auth0.createEmailVerificationTicket(data, function (err) {
2109
- * if (err) {
2110
- * // Handle error.
2111
- * }
2112
- * });
2113
- * @param {Function} [cb] Callback function.
2114
- * @returns {Promise}
2115
- */
2116
- createEmailVerificationTicket(...args) {
2117
- return this.tickets.verifyEmail(...args);
2118
- }
2119
-
2120
- /**
2121
- * Get an Auth0 log.
2122
- *
2123
- * @example
2124
- * management.getLog({ id: EVENT_ID }, function (err, log) {
2125
- * if (err) {
2126
- * // Handle error.
2127
- * }
2128
- *
2129
- * console.log(log);
2130
- * });
2131
- * @param {object} params Log parameters.
2132
- * @param {string} params.id Event ID.
2133
- * @param {Function} [cb] Callback function.
2134
- * @returns {Promise|undefined}
2135
- */
2136
- getLog(...args) {
2137
- return this.logs.get(...args);
2138
- }
2139
-
2140
- /**
2141
- * Get all logs.
2142
- *
2143
- * @example <caption>
2144
- * This method takes an optional object as first argument that may be used to
2145
- * specify pagination settings and the search query. If pagination options are
2146
- * not present, the first page of a limited number of results will be returned.
2147
- * </caption>
2148
- *
2149
- * // Pagination settings.
2150
- * var params = {
2151
- * per_page: 10,
2152
- * page: 2
2153
- * };
2154
- *
2155
- * management.getLogs(params, function (err, logs) {
2156
- * console.log(logs.length);
2157
- * });
2158
- * @param {object} [params] Logs params.
2159
- * @param {string} [params.q] Search Criteria using Query String Syntax
2160
- * @param {number} [params.page] Page number. Zero based
2161
- * @param {number} [params.per_page] The amount of entries per page
2162
- * @param {string} [params.sort] The field to use for sorting.
2163
- * @param {string} [params.fields] A comma separated list of fields to include or exclude
2164
- * @param {boolean} [params.include_fields] true if the fields specified are to be included in the result, false otherwise.
2165
- * @param {boolean} [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
2166
- * @param {Function} [cb] Callback function.
2167
- * @returns {Promise|undefined}
2168
- */
2169
- getLogs(...args) {
2170
- return this.logs.getAll(...args);
2171
- }
2172
-
2173
- /**
2174
- * Get all Log Streams.
2175
- *
2176
- *
2177
- *
2178
- * management.getLogStreams( function (err, logStreams) {
2179
- * console.log(logStreams.length);
2180
- * });
2181
- *
2182
- * @param {Function} [cb] Callback function.
2183
- * @returns {Promise|undefined}
2184
- */
2185
- getLogStreams(...args) {
2186
- return this.logStreams.getAll(...args);
2187
- }
2188
-
2189
- /**
2190
- * Create a new Log Stream.
2191
- *
2192
- * @example
2193
- * management.createLogStream(data, function (err) {
2194
- * if (err) {
2195
- * // Handle error.
2196
- * }
2197
- *
2198
- * // Log Stream created.
2199
- * });
2200
- * @param {object} data Log Stream data.
2201
- * @param {Function} [cb] Callback function.
2202
- * @returns {Promise|undefined}
2203
- */
2204
- createLogStream(...args) {
2205
- return this.logStreams.create(...args);
2206
- }
2207
-
2208
- /**
2209
- * Get an Auth0 Log Stream.
2210
- *
2211
- * @example
2212
- * management.getLogStream({ id: LOG_STREAM_ID }, function (err, logStream) {
2213
- * if (err) {
2214
- * // Handle error.
2215
- * }
2216
- *
2217
- * console.log(logStream);
2218
- * });
2219
- * @param {object} params Log Stream parameters.
2220
- * @param {string} params.id Log Stream ID.
2221
- * @param {Function} [cb] Callback function.
2222
- * @returns {Promise|undefined}
2223
- */
2224
- getLogStream(...args) {
2225
- return this.logStreams.get(...args);
2226
- }
2227
-
2228
- /**
2229
- * Delete an existing Log Stream.
2230
- *
2231
- * @example
2232
- * management.deleteLogStream({ id: LOG_STREAM_ID }, function (err) {
2233
- * if (err) {
2234
- * // Handle error.
2235
- * }
2236
- *
2237
- * // Log Stream deleted.
2238
- * });
2239
- * @param {object} params Log Stream parameters.
2240
- * @param {string} params.id Log Stream ID.
2241
- * @param {Function} [cb] Callback function.
2242
- * @returns {Promise|undefined}
2243
- */
2244
- deleteLogStream(...args) {
2245
- return this.logStreams.delete(...args);
2246
- }
2247
-
2248
- /**
2249
- * Update an existing Log Stream.
2250
- *
2251
- * @example
2252
- * var params = { id: LOG_STREAM_ID };
2253
- * var data = { name: 'my-log-stream'};
2254
- * management.updateLogStream(params, data, function (err, logStream) {
2255
- * if (err) {
2256
- * // Handle error.
2257
- * }
2258
- *
2259
- * console.log(logStream.name); // 'my-log-stream'.
2260
- * });
2261
- * @param {object} params Rule parameters.
2262
- * @param {string} params.id Rule ID.
2263
- * @param {object} data Updated rule data.
2264
- * @param {Function} [cb] Callback function.
2265
- * @returns {Promise|undefined}
2266
- */
2267
- updateLogStream(...args) {
2268
- return this.logStreams.update(...args);
2269
- }
2270
-
2271
- /**
2272
- * Create a new resource server.
2273
- *
2274
- * @example
2275
- * management.createResourceServer(data, function (err) {
2276
- * if (err) {
2277
- * // Handle error.
2278
- * }
2279
- *
2280
- * // Resource Server created.
2281
- * });
2282
- * @param {object} data Resource Server data object.
2283
- * @param {Function} [cb] Callback function.
2284
- * @returns {Promise|undefined}
2285
- */
2286
- createResourceServer(...args) {
2287
- return this.resourceServers.create(...args);
2288
- }
2289
-
2290
- /**
2291
- * Get all resource servers.
2292
- *
2293
- * @example <caption>
2294
- * This method takes an optional object as first argument that may be used to
2295
- * specify pagination settings. If pagination options are not present,
2296
- * the first page of a limited number of results will be returned.
2297
- * </caption>
2298
- *
2299
- * // Pagination settings.
2300
- * var params = {
2301
- * per_page: 10,
2302
- * page: 0
2303
- * };
2304
- *
2305
- * management.getResourceServers(params, function (err, resourceServers) {
2306
- * console.log(resourceServers.length);
2307
- * });
2308
- * @param {object} [params] Resource Servers parameters.
2309
- * @param {number} [params.per_page] Number of results per page.
2310
- * @param {number} [params.page] Page number, zero indexed.
2311
- * @param {Function} [cb] Callback function.
2312
- * @returns {Promise|undefined}
2313
- */
2314
- getResourceServers(...args) {
2315
- return this.resourceServers.getAll(...args);
2316
- }
2317
-
2318
- /**
2319
- * Get a Resource Server.
2320
- *
2321
- * @example
2322
- * management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
2323
- * if (err) {
2324
- * // Handle error.
2325
- * }
2326
- *
2327
- * console.log(resourceServer);
2328
- * });
2329
- * @param {object} params Resource Server parameters.
2330
- * @param {string} params.id Resource Server ID.
2331
- * @param {Function} [cb] Callback function.
2332
- * @returns {Promise|undefined}
2333
- */
2334
- getResourceServer(...args) {
2335
- return this.resourceServers.get(...args);
2336
- }
2337
-
2338
- /**
2339
- * Delete an existing resource server.
2340
- *
2341
- * @example
2342
- * management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
2343
- * if (err) {
2344
- * // Handle error.
2345
- * }
2346
- *
2347
- * // Resource Server deleted.
2348
- * });
2349
- * @param {object} params Resource Server parameters.
2350
- * @param {string} params.id Resource Server ID.
2351
- * @param {Function} [cb] Callback function.
2352
- * @returns {Promise|undefined}
2353
- */
2354
- deleteResourceServer(...args) {
2355
- return this.resourceServers.delete(...args);
2356
- }
2357
-
2358
- /**
2359
- * Update an existing resource server.
2360
- *
2361
- * @example
2362
- * var data = { name: 'newResourceServerName' };
2363
- * var params = { id: RESOURCE_SERVER_ID };
2364
- *
2365
- * management.updateResourceServer(params, data, function (err, resourceServer) {
2366
- * if (err) {
2367
- * // Handle error.
2368
- * }
2369
- *
2370
- * console.log(resourceServer.name); // 'newResourceServerName'
2371
- * });
2372
- * @param {object} params Resource Server parameters.
2373
- * @param {string} params.id Resource Server ID.
2374
- * @param {object} data Updated Resource Server data.
2375
- * @param {Function} [cb] Callback function.
2376
- * @returns {Promise|undefined}
2377
- */
2378
- updateResourceServer(...args) {
2379
- return this.resourceServers.update(...args);
2380
- }
2381
-
2382
- /**
2383
- * Set a new rules config.
2384
- *
2385
- * @example
2386
- * var params = { key: RULE_CONFIG_KEY };
2387
- * var data = { value: RULES_CONFIG_VALUE };
2388
- *
2389
- * management.setRulesConfig(params, data, function (err, rulesConfig) {
2390
- * if (err) {
2391
- * // Handle error.
2392
- * }
2393
- *
2394
- * // Rules Config set.
2395
- * });
2396
- * @param {object} params Rule Config parameters.
2397
- * @param {string} params.key Rule Config key.
2398
- * @param {object} data Rule Config Data parameters.
2399
- * @param {string} data.value Rule Config Data value.
2400
- * @param {Function} [cb] Callback function.
2401
- * @returns {Promise|undefined}
2402
- */
2403
- setRulesConfig(...args) {
2404
- return this.rulesConfigs.set(...args);
2405
- }
2406
-
2407
- /**
2408
- * Get rules config.
2409
- *
2410
- * @param {Function} [cb] Callback function.
2411
- * @example
2412
- *
2413
- * management.getRulesConfigs(function (err, rulesConfigs) {
2414
- * if (err) {
2415
- * // Handle error.
2416
- * }
2417
- *
2418
- * // Get Rules Configs.
2419
- * });
2420
- * @returns {Promise|undefined}
2421
- */
2422
- getRulesConfigs(...args) {
2423
- return this.rulesConfigs.getAll(...args);
2424
- }
2425
-
2426
- /**
2427
- * Delete rules config.
2428
- *
2429
- * @example
2430
- *
2431
- * management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
2432
- * if (err) {
2433
- * // Handle error.
2434
- * }
2435
- *
2436
- * // Rules Config deleted.
2437
- * });
2438
- * @param {object} params Rule Configs parameters.
2439
- * @param {string} params.key Rule Configs key.
2440
- * @param {Function} [cb] Callback function.
2441
- * @returns {Promise|undefined}
2442
- */
2443
- deleteRulesConfig(...args) {
2444
- return this.rulesConfigs.delete(...args);
2445
- }
2446
-
2447
- /**
2448
- * Create an Auth0 Custom Domain.
2449
- *
2450
- * @example
2451
- * management.createCustomDomain(data, function (err) {
2452
- * if (err) {
2453
- * // Handle error.
2454
- * }
2455
- *
2456
- * // CustomDomain created.
2457
- * });
2458
- * @param {object} data The custom domain data object.
2459
- * @param {Function} [cb] Callback function.
2460
- * @returns {Promise|undefined}
2461
- */
2462
- createCustomDomain(...args) {
2463
- return this.customDomains.create(...args);
2464
- }
2465
-
2466
- /**
2467
- * Get all Auth0 CustomDomains.
2468
- *
2469
- * @example
2470
- * management.getCustomDomains(function (err, customDomains) {
2471
- * console.log(customDomains.length);
2472
- * });
2473
- * @returns {Promise|undefined}
2474
- */
2475
- getCustomDomains(...args) {
2476
- return this.customDomains.getAll(...args);
2477
- }
2478
-
2479
- /**
2480
- * Get a Custom Domain.
2481
- *
2482
- * @example
2483
- * management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
2484
- * if (err) {
2485
- * // Handle error.
2486
- * }
2487
- *
2488
- * console.log(customDomain);
2489
- * });
2490
- * @param {object} params Custom Domain parameters.
2491
- * @param {string} params.id Custom Domain ID.
2492
- * @param {Function} [cb] Callback function.
2493
- * @returns {Promise|undefined}
2494
- */
2495
- getCustomDomain(...args) {
2496
- return this.customDomains.get(...args);
2497
- }
2498
-
2499
- /**
2500
- * Verify a Custom Domain.
2501
- *
2502
- * @example
2503
- * management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
2504
- * if (err) {
2505
- * // Handle error.
2506
- * }
2507
- *
2508
- * console.log(customDomain);
2509
- * });
2510
- * @param {object} params Custom Domain parameters.
2511
- * @param {string} params.id Custom Domain ID.
2512
- * @param {Function} [cb] Callback function.
2513
- * @returns {Promise|undefined}
2514
- */
2515
- verifyCustomDomain(...args) {
2516
- return this.customDomains.verify(...args);
2517
- }
2518
-
2519
- /**
2520
- * Delete a Custom Domain.
2521
- *
2522
- * @example
2523
- * management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
2524
- * if (err) {
2525
- * // Handle error.
2526
- * }
2527
- *
2528
- * // CustomDomain deleted.
2529
- * });
2530
- * @param {object} params Custom Domain parameters.
2531
- * @param {string} params.id Custom Domain ID.
2532
- * @param {Function} [cb] Callback function.
2533
- * @returns {Promise|undefined}
2534
- */
2535
- deleteCustomDomain(...args) {
2536
- return this.customDomains.delete(...args);
2537
- }
2538
-
2539
- /**
2540
- * Create a Guardian enrollment ticket.
2541
- *
2542
- * @example
2543
- * management.createGuardianEnrollmentTicket(function (err, ticket) {
2544
- * console.log(ticket);
2545
- * });
2546
- * @param {Function} [cb] Callback function.
2547
- * @returns {Promise|undefined}
2548
- */
2549
- createGuardianEnrollmentTicket(...args) {
2550
- return this.guardian.createEnrollmentTicket(...args);
2551
- }
2552
-
2553
- /**
2554
- * Get a list of Guardian factors and statuses.
2555
- *
2556
- * @example
2557
- * management.getGuardianFactors(function (err, factors) {
2558
- * console.log(factors.length);
2559
- * });
2560
- * @param {Function} [cb] Callback function.
2561
- * @returns {Promise|undefined}
2562
- */
2563
- getGuardianFactors(...args) {
2564
- return this.guardian.getFactors(...args);
2565
- }
2566
-
2567
- /**
2568
- * Get the settings of a Guardian factor.
2569
- *
2570
- * @example
2571
- * management.getGuardianFactorSettings({ name: 'duo' }, function (err, settings) {
2572
- * console.log(settings);
2573
- * });
2574
- * @param {object} params Factor parameters.
2575
- * @param {Function} [cb] Callback function.
2576
- * @returns {Promise|undefined}
2577
- */
2578
- getGuardianFactorSettings(...args) {
2579
- return this.guardian.getFactorSettings(...args);
2580
- }
2581
-
2582
- /**
2583
- * Get Guardian factor provider configuration
2584
- *
2585
- * @example
2586
- * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
2587
- * console.log(provider);
2588
- * });
2589
- * @param {object} params Factor provider parameters.
2590
- * @param {Function} [cb] Callback function.
2591
- * @returns {Promise|undefined}
2592
- */
2593
- getGuardianFactorProvider(...args) {
2594
- return this.guardian.getFactorProvider(...args);
2595
- }
2596
-
2597
- /**
2598
- * Update Guardian's factor provider
2599
- *
2600
- * @example
2601
- * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
2602
- * messaging_service_sid: 'XXXXXXXXXXXXXX',
2603
- * auth_token: 'XXXXXXXXXXXXXX',
2604
- * sid: 'XXXXXXXXXXXXXX'
2605
- * }, function (err, provider) {
2606
- * console.log(provider);
2607
- * });
2608
- * @param {object} params Factor provider parameters.
2609
- * @param {object} data Updated Factor provider data.
2610
- * @param {Function} [cb] Callback function.
2611
- * @returns {Promise|undefined}
2612
- */
2613
- updateGuardianFactorProvider(...args) {
2614
- return this.guardian.updateFactorProvider(...args);
2615
- }
2616
-
2617
- /**
2618
- * Update a Guardian's factor settings
2619
- *
2620
- * @example
2621
- * management.updateGuardianFactorSettings(
2622
- * { name: 'webauthn-roaming' },
2623
- * { userVerification: 'discouraged', overrideRelyingParty: false },
2624
- * function (err, settings) {
2625
- * console.log(settings);
2626
- * })
2627
- * @param {object} params Factor parameters.
2628
- * @param {object} data Updated Factor settings data.
2629
- * @param {Function} [cb] Callback function.
2630
- * @returns {Promise|undefined}
2631
- */
2632
- updateGuardianFactorSettings(...args) {
2633
- return this.guardian.updateFactorSettings(...args);
2634
- }
2635
-
2636
- /**
2637
- * Get Guardian enrollment and verification factor templates
2638
- *
2639
- * @example
2640
- * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
2641
- * console.log(templates);
2642
- * });
2643
- * @param {object} params Factor parameters.
2644
- * @param {Function} [cb] Callback function.
2645
- * @returns {Promise|undefined}
2646
- */
2647
- getGuardianFactorTemplates(...args) {
2648
- return this.guardian.getFactorTemplates(...args);
2649
- }
2650
-
2651
- /**
2652
- * Update Guardian enrollment and verification factor templates
2653
- *
2654
- * @example
2655
- * management.updateGuardianFactorTemplates({ name: 'sms' }, {
2656
- * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
2657
- * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
2658
- * }, function (err, templates) {
2659
- * console.log(templates);
2660
- * });
2661
- * @param {object} params Factor parameters.
2662
- * @param {object} data Updated factor templates data.
2663
- * @param {Function} [cb] Callback function.
2664
- * @returns {Promise|undefined}
2665
- */
2666
- updateGuardianFactorTemplates(...args) {
2667
- return this.guardian.updateFactorTemplates(...args);
2668
- }
2669
-
2670
- /**
2671
- * Update Guardian Factor
2672
- *
2673
- * @example
2674
- * management.updateGuardianFactor({ name: 'sms' }, {
2675
- * enabled: true
2676
- * }, function (err, factor) {
2677
- * console.log(factor);
2678
- * });
2679
- * @param {object} params Factor parameters.
2680
- * @param {object} data Updated factor data.
2681
- * @param {Function} [cb] Callback function.
2682
- * @returns {Promise|undefined}
2683
- */
2684
- updateGuardianFactor(...args) {
2685
- return this.guardian.updateFactor(...args);
2686
- }
2687
-
2688
- /**
2689
- * Get enabled Guardian policies
2690
- *
2691
- * @example
2692
- * management.getGuardianPolicies(function (err, policies) {
2693
- * console.log(policies);
2694
- * });
2695
- * @param {Function} [cb] Callback function.
2696
- * @returns {Promise|undefined}
2697
- */
2698
- getGuardianPolicies(...args) {
2699
- return this.guardian.getPolicies(...args);
2700
- }
2701
-
2702
- /**
2703
- * Update enabled Guardian policies
2704
- *
2705
- * @example
2706
- * management.updateGuardianPolicies({}, [
2707
- * 'all-applications'
2708
- * ], function (err, policies) {
2709
- * console.log(policies);
2710
- * });
2711
- * @param {object} params Parameters.
2712
- * @param {string[]} data Policies to enable. Empty array disables all policies.
2713
- * @param {Function} [cb] Callback function.
2714
- * @returns {Promise|undefined}
2715
- */
2716
- updateGuardianPolicies(...args) {
2717
- return this.guardian.updatePolicies(...args);
2718
- }
2719
-
2720
- /**
2721
- * Get the Guardian phone factor's selected provider
2722
- *
2723
- * @example
2724
- * management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
2725
- * console.log(selectedProvider);
2726
- * });
2727
- * @param {Function} [cb] Callback function.
2728
- * @returns {Promise|undefined}
2729
- */
2730
- getGuardianPhoneFactorSelectedProvider(...args) {
2731
- return this.guardian.getPhoneFactorSelectedProvider(...args);
2732
- }
2733
-
2734
- /**
2735
- * Update the Guardian phone factor's selected provider
2736
- *
2737
- * @example
2738
- * management.updateGuardianPhoneFactorSelectedProvider({}, {
2739
- * provider: 'twilio'
2740
- * }, function (err, factor) {
2741
- * console.log(factor);
2742
- * });
2743
- * @param {object} params Parameters.
2744
- * @param {object} data Updated selected provider data.
2745
- * @param {string} data.provider Name of the selected provider
2746
- * @param {Function} [cb] Callback function.
2747
- * @returns {Promise|undefined}
2748
- */
2749
- updateGuardianPhoneFactorSelectedProvider(...args) {
2750
- return this.guardian.updatePhoneFactorSelectedProvider(...args);
2751
- }
2752
-
2753
- /**
2754
- * Get the Guardian phone factor's message types
2755
- *
2756
- * @example
2757
- * management.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
2758
- * console.log(messageTypes);
2759
- * });
2760
- * @param {Function} [cb] Callback function.
2761
- * @returns {Promise|undefined}
2762
- */
2763
- getGuardianPhoneFactorMessageTypes(...args) {
2764
- return this.guardian.getPhoneFactorMessageTypes(...args);
2765
- }
2766
-
2767
- /**
2768
- * Update the Guardian phone factor's message types
2769
- *
2770
- * @example
2771
- * management.updateGuardianPhoneFactorMessageTypes({}, {
2772
- * message_types: ['sms', 'voice']
2773
- * }, function (err, factor) {
2774
- * console.log(factor);
2775
- * });
2776
- * @param {object} params Parameters.
2777
- * @param {object} data Updated selected provider data.
2778
- * @param {string[]} data.message_types Message types (only `"sms"` and `"voice"` are supported).
2779
- * @param {Function} [cb] Callback function.
2780
- * @returns {Promise|undefined}
2781
- */
2782
- updateGuardianPhoneFactorMessageTypes(...args) {
2783
- return this.guardian.updatePhoneFactorMessageTypes(...args);
2784
- }
2785
-
2786
- /**
2787
- * Get all roles.
2788
- *
2789
- * @example <caption>
2790
- * This method takes an optional object as first argument that may be used to
2791
- * specify pagination settings. If pagination options are not present,
2792
- * the first page of a limited number of results will be returned.
2793
- * </caption>
2794
- *
2795
- * // Pagination settings.
2796
- * var params = {
2797
- * per_page: 10,
2798
- * page: 0
2799
- * };
2800
- *
2801
- * management.getRoles(params, function (err, roles) {
2802
- * console.log(roles.length);
2803
- * });
2804
- * @param {object} [params] Roles parameters.
2805
- * @param {number} [params.per_page] Number of results per page.
2806
- * @param {number} [params.page] Page number, zero indexed.
2807
- * @param {Function} [cb] Callback function.
2808
- * @returns {Promise|undefined}
2809
- */
2810
- getRoles(...args) {
2811
- return this.roles.getAll(...args);
2812
- }
2813
-
2814
- /**
2815
- * Create a new role.
2816
- *
2817
- * @example
2818
- * data = {"name": "test1","description": "123"}
2819
- * management.createRole(data, function (err) {
2820
- * if (err) {
2821
- * // Handle error.
2822
- * }
2823
- *
2824
- * // Role created.
2825
- * });
2826
- * @param {object} data Role data object.
2827
- * @param {Function} [cb] Callback function.
2828
- * @returns {Promise|undefined}
2829
- */
2830
- createRole(...args) {
2831
- return this.roles.create(...args);
2832
- }
2833
-
2834
- /**
2835
- * Get an Auth0 role.
2836
- *
2837
- * @example
2838
- * management.getRole({ id: ROLE_ID }, function (err, role) {
2839
- * if (err) {
2840
- * // Handle error.
2841
- * }
2842
- *
2843
- * console.log(role);
2844
- * });
2845
- * @param {object} params Role parameters.
2846
- * @param {string} params.id Role ID.
2847
- * @param {Function} [cb] Callback function.
2848
- * @returns {Promise|undefined}
2849
- */
2850
- getRole(...args) {
2851
- return this.roles.get(...args);
2852
- }
2853
-
2854
- /**
2855
- * Delete an existing role.
2856
- *
2857
- * @example
2858
- * management.deleteRole({ id: ROLE_ID }, function (err) {
2859
- * if (err) {
2860
- * // Handle error.
2861
- * }
2862
- *
2863
- * // Role deleted.
2864
- * });
2865
- * @param {object} params Role parameters.
2866
- * @param {string} params.id Role ID.
2867
- * @param {Function} [cb] Callback function.
2868
- * @returns {Promise|undefined}
2869
- */
2870
- deleteRole(...args) {
2871
- return this.roles.delete(...args);
2872
- }
2873
-
2874
- /**
2875
- * Update an existing role.
2876
- *
2877
- * @example
2878
- * var params = { id: ROLE_ID };
2879
- * var data = { name: 'my-role'};
2880
- * management.updateRole(params, data, function (err, role) {
2881
- * if (err) {
2882
- * // Handle error.
2883
- * }
2884
- *
2885
- * console.log(role.name); // 'my-role'.
2886
- * });
2887
- * @param {object} params Role parameters.
2888
- * @param {string} params.id Role ID.
2889
- * @param {object} data Updated role data.
2890
- * @param {Function} [cb] Callback function.
2891
- * @returns {Promise|undefined}
2892
- */
2893
- updateRole(...args) {
2894
- return this.roles.update(...args);
2895
- }
2896
-
2897
- /**
2898
- * Get permissions for a given role
2899
- *
2900
- * @example
2901
- * var params = { id :'ROLE_ID'};
2902
- * @example <caption>
2903
- * This method takes a roleId and
2904
- * returns all permissions within that role
2905
- *
2906
- * </caption>
2907
- *
2908
- * management.getPermissionsInRole(params, function (err, permissions) {
2909
- * console.log(permissions);
2910
- * });
2911
- * @param {string} [roleId] Id of the role
2912
- * @param {Function} [cb] Callback function.
2913
- * @returns {Promise|undefined}
2914
- */
2915
- getPermissionsInRole(...args) {
2916
- return this.roles.getPermissions(...args);
2917
- }
2918
-
2919
- /**
2920
- * Add permissions in a role
2921
- *
2922
- * @example
2923
- * var params = { id :'ROLE_ID'};
2924
- * var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
2925
- *
2926
- * management.addPermissionsInRole(params, data, function (err, permissions) {
2927
- * console.log(permissions);
2928
- * });
2929
- * @param {string} params.id ID of the Role.
2930
- * @param {object} data permissions data
2931
- * @param {string} data.permissions Array of permissions
2932
- * @param {string} data.permissions.permission_name Name of a permission
2933
- * @param {string} data.permissions.resource_server_identifier Identifier for a resource
2934
- * @param {Function} [cb] Callback function.
2935
- * @returns {Promise|undefined}
2936
- */
2937
- addPermissionsInRole(...args) {
2938
- return this.roles.addPermissions(...args);
2939
- }
2940
-
2941
- /**
2942
- * Remove permissions from a role
2943
- *
2944
- * @example
2945
- * var params = { id :'ROLE_ID'};
2946
- * var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
2947
- *
2948
- * management.removePermissionsFromRole(params, data, function (err, permissions) {
2949
- * console.log(permissions);
2950
- * });
2951
- * @param {string} params.id ID of the Role.
2952
- * @param {object} data permissions data
2953
- * @param {string} data.permissions Array of permissions
2954
- * @param {string} data.permissions.permission_name Name of a permission
2955
- * @param {string} data.permissions.resource_server_identifier Identifier for a resource
2956
- * @param {Function} [cb] Callback function.
2957
- * @returns {Promise|undefined}
2958
- */
2959
- removePermissionsFromRole(...args) {
2960
- return this.roles.removePermissions(...args);
2961
- }
2962
-
2963
- /**
2964
- * Get users in a given role
2965
- *
2966
- * @example
2967
- * var params = {
2968
- * id: 'ROLE_ID',
2969
- * per_page: 50,
2970
- * page: 0
2971
- * };
2972
- * @example <caption>
2973
- * This method takes a roleId and returns all users within that role. Supports offset (page, per_page) and checkpoint pagination (from, take). You must use checkpoint pagination to retrieve beyond the first 1000 records.
2974
- * </caption>
2975
- *
2976
- * management.getUsersInRole(params, function (err, users) {
2977
- * console.log(users);
2978
- * });
2979
- * @param {string} [id] Id of the role
2980
- * @param {number} [params.per_page] Number of results per page.
2981
- * @param {number} [params.page] Page number, zero indexed.
2982
- * @param {string} [params.from] Optional id from which to start selection.
2983
- * @param {number} [params.take] The total amount of entries to retrieve when using the from parameter. Defaults to 50.
2984
- * @param {Function} [cb] Callback function.
2985
- * @returns {Promise|undefined}
2986
- */
2987
- getUsersInRole(...args) {
2988
- return this.roles.getUsers(...args);
2989
- }
2990
-
2991
- /**
2992
- * Get all hooks.
2993
- *
2994
- * @example <caption>
2995
- * This method takes an optional object as first argument that may be used to
2996
- * specify pagination settings. If pagination options are not present,
2997
- * the first page of a limited number of results will be returned.
2998
- * </caption>
2999
- *
3000
- * // Pagination settings.
3001
- * var params = {
3002
- * per_page: 10,
3003
- * page: 0
3004
- * };
3005
- *
3006
- * management.getHooks(params, function (err, hooks) {
3007
- * console.log(hooks.length);
3008
- * });
3009
- * @param {object} [params] Hooks parameters.
3010
- * @param {number} [params.per_page] Number of results per page.
3011
- * @param {number} [params.page] Page number, zero indexed.
3012
- * @param {Function} [cb] Callback function.
3013
- * @returns {Promise|undefined}
3014
- */
3015
- getHooks(...args) {
3016
- return this.hooks.getAll(...args);
3017
- }
3018
-
3019
- /**
3020
- * Get an Auth0 hook.
3021
- *
3022
- * @example
3023
- * management.getHook({ id: HOOK_ID }, function (err, hook) {
3024
- * if (err) {
3025
- * // Handle error.
3026
- * }
3027
- *
3028
- * console.log(hook);
3029
- * });
3030
- * @param {object} params Hook parameters.
3031
- * @param {string} params.id Hook ID.
3032
- * @param {Function} [cb] Callback function.
3033
- * @returns {Promise|undefined}
3034
- */
3035
- getHook(...args) {
3036
- return this.hooks.get(...args);
3037
- }
3038
-
3039
- /**
3040
- * Create a new hook.
3041
- *
3042
- * @example
3043
- * management.createHook(data, function (err) {
3044
- * if (err) {
3045
- * // Handle error.
3046
- * }
3047
- *
3048
- * // Hook created.
3049
- * });
3050
- * @param {object} data Hook data object.
3051
- * @param {Function} [cb] Callback function.
3052
- * @returns {Promise|undefined}
3053
- */
3054
- createHook(...args) {
3055
- return this.hooks.create(...args);
3056
- }
3057
-
3058
- /**
3059
- * Update an existing hook.
3060
- *
3061
- * @example
3062
- * var params = { id: HOOK_ID };
3063
- * var data = { name: 'my-hook'};
3064
- * management.updateHook(params, data, function (err, hook) {
3065
- * if (err) {
3066
- * // Handle error.
3067
- * }
3068
- *
3069
- * console.log(hook.name); // 'my-hook'.
3070
- * });
3071
- * @param {object} params Hook parameters.
3072
- * @param {string} params.id Hook ID.
3073
- * @param {object} data Updated hook data.
3074
- * @param {Function} [cb] Callback function.
3075
- * @returns {Promise|undefined}
3076
- */
3077
- updateHook(...args) {
3078
- return this.hooks.update(...args);
3079
- }
3080
-
3081
- /**
3082
- * Delete an existing hook.
3083
- *
3084
- * @example
3085
- * auth0.deleteHook({ id: HOOK_ID }, function (err) {
3086
- * if (err) {
3087
- * // Handle error.
3088
- * }
3089
- *
3090
- * // Hook deleted.
3091
- * });
3092
- * @param {object} params Hook parameters.
3093
- * @param {string} params.id Hook ID.
3094
- * @param {Function} [cb] Callback function.
3095
- * @returns {Promise|undefined}
3096
- */
3097
- deleteHook(...args) {
3098
- return this.hooks.delete(...args);
3099
- }
3100
-
3101
- /**
3102
- * Get an Auth0 hook's secrets.
3103
- *
3104
- * @example
3105
- * var params = { id: HOOK_ID }
3106
- * management.getHookSecrets(params, function (err, secrets) {
3107
- * if (err) {
3108
- * // Handle error.
3109
- * }
3110
- *
3111
- * console.log(secrets);
3112
- * });
3113
- * @param {object} params Hook parameters.
3114
- * @param {string} params.id Hook ID.
3115
- * @param {Function} [cb] Callback function.
3116
- * @returns {Promise|undefined}
3117
- */
3118
- getHookSecrets(...args) {
3119
- return this.hooks.getSecrets(...args);
3120
- }
3121
-
3122
- /**
3123
- * Add hook screts.
3124
- *
3125
- * @example
3126
- * var params = { id: 'HOOK_ID' }
3127
- * var data = { DB_PASSWORD: 'password1', API_TOKEN: 'secret' }
3128
- * management.addHookScrets(params, data, function (err, secrets) {
3129
- * if (err) {
3130
- * // Handle error.
3131
- * }
3132
- *
3133
- * // Hook secrets created.
3134
- * });
3135
- * @param {object} params Hook parameters.
3136
- * @param {string} params.id Hook ID.
3137
- * @param {object} data Secrets key/value pairs
3138
- * @param {Function} [cb] Callback function.
3139
- * @returns {Promise|undefined}
3140
- */
3141
- addHookSecrets(...args) {
3142
- return this.hooks.addSecrets(...args);
3143
- }
3144
-
3145
- /**
3146
- * Update an existing hook.
3147
- *
3148
- * @example
3149
- * var params = { id: HOOK_ID };
3150
- * var data = { API_TOKEN: 'updated-secret'};
3151
- * management.updateHookSecrets(params, data, function (err, secrets) {
3152
- * if (err) {
3153
- * // Handle error.
3154
- * }
3155
- *
3156
- * console.log(secrets)
3157
- * });
3158
- * @param {object} params Hook parameters.
3159
- * @param {string} params.id Hook ID.
3160
- * @param {object} data Secrets key/value pairs
3161
- * @param {Function} [cb] Callback function.
3162
- * @returns {Promise|undefined}
3163
- */
3164
- updateHookSecrets(...args) {
3165
- return this.hooks.updateSecrets(...args);
3166
- }
3167
-
3168
- /**
3169
- * Delete an existing hook.
3170
- *
3171
- * @example
3172
- * var params = { id: HOOK_ID }
3173
- * var data = ['API_TOKEN', 'DB_PASSWORD']
3174
- * auth0.removeHookSecrets(params, data, function (err) {
3175
- * if (err) {
3176
- * // Handle error.
3177
- * }
3178
- *
3179
- * // Hook deleted.
3180
- * });
3181
- * @param {object} params Hook parameters.
3182
- * @param {string} params.id Hook ID.
3183
- * @param {object} data Secrets key/value pairs
3184
- * @param {Function} [cb] Callback function.
3185
- * @returns {Promise|undefined}
3186
- */
3187
- removeHookSecrets(...args) {
3188
- return this.hooks.removeSecrets(...args);
3189
- }
3190
-
3191
- /**
3192
- * Returns the access_token.
3193
- *
3194
- * @returns {Promise} Promise returning an access_token.
3195
- */
3196
- getAccessToken(...args) {
3197
- return this.tokenProvider.getAccessToken(...args);
3198
- }
3199
-
3200
- /**
3201
- * Update the branding settings.
3202
- *
3203
- * @example
3204
- * management.updateBrandingSettings(data, function (err, branding) {
3205
- * if (err) {
3206
- * // Handle error.
3207
- * }
3208
- *
3209
- * // Updated branding
3210
- * console.log(branding);
3211
- * });
3212
- * @param {object} params Branding parameters.
3213
- * @param {object} data Updated branding data.
3214
- * @param {Function} [cb] Callback function.
3215
- * @returns {Promise|undefined}
3216
- */
3217
- updateBrandingSettings(...args) {
3218
- return this.branding.updateSettings(...args);
3219
- }
3220
-
3221
- /**
3222
- * Get the branding settings..
3223
- *
3224
- * @example
3225
- * management.getBrandingSettings(data, function (err, branding) {
3226
- * if (err) {
3227
- * // Handle error.
3228
- * }
3229
- *
3230
- * // Branding
3231
- * console.log(branding);
3232
- * });
3233
- * @param {object} params Branding parameters.
3234
- * @param {object} data Branding data.
3235
- * @param {Function} [cb] Callback function.
3236
- * @returns {Promise|undefined}
3237
- */
3238
- getBrandingSettings(...args) {
3239
- return this.branding.getSettings(...args);
3240
- }
3241
-
3242
- /**
3243
- * Get the new universal login template.
3244
- *
3245
- * @example
3246
- * management.getBrandingUniversalLoginTemplate(data, function (err, template) {
3247
- * if (err) {
3248
- * // Handle error.
3249
- * }
3250
- *
3251
- * // Branding
3252
- * console.log(template);
3253
- * });
3254
- * @param {object} params Branding parameters (leave empty).
3255
- * @param {object} data Branding data (leave empty).
3256
- * @param {Function} [cb] Callback function.
3257
- * @returns {Promise|undefined}
3258
- */
3259
- getBrandingUniversalLoginTemplate(...args) {
3260
- return this.branding.getUniversalLoginTemplate(...args);
3261
- }
3262
-
3263
- /**
3264
- * Set the new universal login template.
3265
- *
3266
- * @example
3267
- * management.setBrandingUniversalLoginTemplate({}, { template: "a template" }, function (err, template) {
3268
- * if (err) {
3269
- * // Handle error.
3270
- * }
3271
- * });
3272
- * @param {object} params Branding parameters (leave empty).
3273
- * @param {object} template Branding data (object with template field).
3274
- * @param {Function} [cb] Callback function.
3275
- * @returns {Promise|undefined}
3276
- */
3277
- setBrandingUniversalLoginTemplate(...args) {
3278
- return this.branding.setUniversalLoginTemplate(...args);
3279
- }
3280
-
3281
- /**
3282
- * Delete the new universal login template.
3283
- *
3284
- * @example
3285
- * management.deleteBrandingUniversalLoginTemplate(template, function (err) {
3286
- * if (err) {
3287
- * // Handle error.
3288
- * }
3289
- * });
3290
- * @param {object} params Branding parameters (leave empty).
3291
- * @param {object} data Branding data (leave empty).
3292
- * @param {Function} [cb] Callback function.
3293
- * @returns {Promise|undefined}
3294
- */
3295
- deleteBrandingUniversalLoginTemplate(...args) {
3296
- return this.branding.deleteUniversalLoginTemplate(...args);
3297
- }
3298
-
3299
- /**
3300
- * Update the tenant migrations.
3301
- *
3302
- * @example
3303
- * data = { flags: { migration: true } };
3304
- * management.updateMigrations(data, function (err, migrations) {
3305
- * if (err) {
3306
- * // Handle error.
3307
- * }
3308
- *
3309
- * // Updated migrations flags
3310
- * console.log(migrations.flags);
3311
- * });
3312
- * @param {object} data Updated migrations data.
3313
- * @param {Function} [cb] Callback function.
3314
- * @returns {Promise|undefined}
3315
- */
3316
- updateMigrations(...args) {
3317
- return this.migrations.updateMigrations(...args);
3318
- }
3319
-
3320
- /**
3321
- * Get migrations flags
3322
- *
3323
- * @example
3324
- * management.getMigrations(function (err, migrations) {
3325
- * if (err) {
3326
- * // Handle error.
3327
- * }
3328
- *
3329
- * // Migration flags
3330
- * console.log(migrations.flags);
3331
- * });
3332
- * @param {Function} [cb] Callback function.
3333
- * @returns {Promise|undefined}
3334
- */
3335
- getMigrations(...args) {
3336
- return this.migrations.getMigrations(...args);
3337
- }
3338
-
3339
- /**
3340
- * Get prompts settings..
3341
- *
3342
- * @example
3343
- * management.getPromptsSettings(function (err, settings) {
3344
- * console.log(settings);
3345
- * });
3346
- * @param {Function} [cb] Callback function.
3347
- * @returns {Promise|undefined}
3348
- */
3349
- getPromptsSettings(...args) {
3350
- return this.prompts.getSettings(...args);
3351
- }
3352
-
3353
- /**
3354
- * Update prompts settings.
3355
- *
3356
- * @example
3357
- * management.updatePromptsSettings(data, function (err) {
3358
- * if (err) {
3359
- * // Handle error.
3360
- * }
3361
- * });
3362
- * @param {object} data The new prompts settings.
3363
- * @param {Function} [cb] Callback function.
3364
- * @returns {Promise|undefined}
3365
- */
3366
- updatePromptsSettings(...args) {
3367
- return this.prompts.updateSettings(...args);
3368
- }
3369
- /**
3370
- * Retrieve custom text for a specific prompt and language.
3371
- *
3372
- * @example
3373
- * var params = { prompt: PROMPT_NAME, language: LANGUAGE };
3374
- *
3375
- * management.prompts.getCustomTextByLanguage(params, function (err, customText) {
3376
- * console.log('CustomText', customText);
3377
- * });
3378
- * @param {object} params Data object.
3379
- * @param {string} params.prompt Name of the prompt.
3380
- * @param {string} params.language Language to retrieve.
3381
- * @param {Function} [cb] Callback function
3382
- * @returns {Promise|undefined}
3383
- */
3384
- getCustomTextByLanguage(...args) {
3385
- return this.prompts.getCustomTextByLanguage(...args);
3386
- }
3387
-
3388
- /**
3389
- * Set custom text for a specific prompt.
3390
- *
3391
- * @example
3392
- * var params = { prompt: PROMPT_NAME, language: LANGUAGE, body: BODY_OBJECT };
3393
- *
3394
- * management.prompts.updateCustomTextByLanguage(params, function (err, customText) {
3395
- * console.log('CustomText', customText);
3396
- * });
3397
- * @param {object} params Data object.
3398
- * @param {string} params.prompt Name of the prompt.
3399
- * @param {string} params.language Language to retrieve.
3400
- * @param {object} params.body An object containing custom dictionaries for a group of screens.
3401
- * @param {Function} [cb] Callback function
3402
- * @returns {Promise|undefined}
3403
- */
3404
- updateCustomTextByLanguage(...args) {
3405
- return this.prompts.updateCustomTextByLanguage(...args);
3406
- }
3407
- }
3408
-
3409
- module.exports = ManagementClient;