Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding docs for secondary and federated identity email verification #510

Merged
merged 3 commits into from
Jul 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/management/JobsManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +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.
ademartini marked this conversation as resolved.
Show resolved Hide resolved
* @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}
Expand Down
8 changes: 8 additions & 0 deletions src/management/TicketsManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 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}
*/
Expand Down