Merge pull request #366 from auth0/fix/password-ticket-docs

FIx createPasswordChangeTicket docs
auth0 · May 23, 2019 · 3f8bbb8 · 3f8bbb8
2 parents 4201c0a + dce5c00
commit 3f8bbb8
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/src/management/index.js b/src/management/index.js
@@ -2016,11 +2016,18 @@ utils.wrapPropertyMethod(ManagementClient, 'sendEmailVerification', 'jobs.verify
  * @memberOf  module:management.ManagementClient.prototype
  *
  * @example
+ * 
+ * var params = {
+  *   result_url: '{REDIRECT_URL}',  // Redirect after using the ticket.
+  *   user_id: '{USER_ID}'
+  * };
+  * 
+  * // or
+  * 
  * var params = {
  *   result_url: '{REDIRECT_URL}',  // Redirect after using the ticket.
- *   user_id: '{USER_ID}',  // Optional.
- *   email: '{USER_EMAIL}',  // Optional.
- *   new_password: '{PASSWORD}'
+ *   email: '{USER_EMAIL}',
+ *   connection_id: '{CONNECTION}' // eg. con_00000000001
  * };
  *
  * auth0.createPasswordChangeTicket(params, function (err) {