From 805429708d0a88013a65203ee0eb66761c79a2bc Mon Sep 17 00:00:00 2001 From: Anthony DeMartini Date: Mon, 20 Jul 2020 20:42:47 -0400 Subject: [PATCH 1/2] Adding docs for secondary and federated identity email verification --- src/management/JobsManager.js | 3 +++ src/management/TicketsManager.js | 8 ++++++++ 2 files changed, 11 insertions(+) diff --git a/src/management/JobsManager.js b/src/management/JobsManager.js index bdded4099..4c281a11d 100644 --- a/src/management/JobsManager.js +++ b/src/management/JobsManager.js @@ -362,6 +362,9 @@ JobsManager.prototype.errors = function(params, cb) { * * @param {Object} data User data object. * @param {String} data.user_id ID of the user to be verified. + * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities + * @param {String} data.identity.user_id user_id of the identity + * @param {String} data.identity.provider provider of the identity * @param {Function} [cb] Callback function. * * @return {Promise|undefined} diff --git a/src/management/TicketsManager.js b/src/management/TicketsManager.js index 78a1383be..ae402cbec 100644 --- a/src/management/TicketsManager.js +++ b/src/management/TicketsManager.js @@ -98,6 +98,14 @@ TicketsManager.prototype.changePassword = function(data, cb) { * } * }); * + * @param {Object} data + * @param {String} [data.result_url] URL the user will be redirected to once ticket is used + * @param {String} data.user_id user_id for whom the ticket should be created + * @param {Integer} [data.ttl_sec] Number of seconds for which the ticket is valid before expiration + * @param {Boolean} [data.includeEmailInRedirect] Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false) + * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities + * @param {String} data.identity.user_id user_id of the identity + * @param {String} data.identity.provider provider of the identity * @param {Function} [cb] Callback function. * @return {Promise} */ From 81b86714eccc7ac559ffc0d75d8abb8861cd26da Mon Sep 17 00:00:00 2001 From: Anthony DeMartini Date: Tue, 21 Jul 2020 09:50:22 -0400 Subject: [PATCH 2/2] doc fixes --- src/management/JobsManager.js | 7 ++++--- src/management/TicketsManager.js | 14 +++++++------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/src/management/JobsManager.js b/src/management/JobsManager.js index 4c281a11d..40714ebb8 100644 --- a/src/management/JobsManager.js +++ b/src/management/JobsManager.js @@ -362,9 +362,10 @@ JobsManager.prototype.errors = function(params, cb) { * * @param {Object} data User data object. * @param {String} data.user_id ID of the user to be verified. - * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities - * @param {String} data.identity.user_id user_id of the identity - * @param {String} data.identity.provider provider of the identity + * @param {String} [data.client_id] client_id of the client (application). If no value provided, the global Client ID will be used. + * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities. + * @param {String} data.identity.user_id user_id of the identity. + * @param {String} data.identity.provider provider of the identity. * @param {Function} [cb] Callback function. * * @return {Promise|undefined} diff --git a/src/management/TicketsManager.js b/src/management/TicketsManager.js index ae402cbec..a037d82b0 100644 --- a/src/management/TicketsManager.js +++ b/src/management/TicketsManager.js @@ -99,13 +99,13 @@ TicketsManager.prototype.changePassword = function(data, cb) { * }); * * @param {Object} data - * @param {String} [data.result_url] URL the user will be redirected to once ticket is used - * @param {String} data.user_id user_id for whom the ticket should be created - * @param {Integer} [data.ttl_sec] Number of seconds for which the ticket is valid before expiration - * @param {Boolean} [data.includeEmailInRedirect] Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false) - * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities - * @param {String} data.identity.user_id user_id of the identity - * @param {String} data.identity.provider provider of the identity + * @param {String} [data.result_url] URL the user will be redirected to once ticket is used. + * @param {String} data.user_id user_id for whom the ticket should be created. + * @param {Integer} [data.ttl_sec] Number of seconds for which the ticket is valid before expiration. + * @param {Boolean} [data.includeEmailInRedirect] Whether to include the email address as part of the result_url (true), or not (false). + * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities. + * @param {String} data.identity.user_id user_id of the identity. + * @param {String} data.identity.provider provider of the identity. * @param {Function} [cb] Callback function. * @return {Promise} */