github/meteor
1
1
Fork 0
mirror of https://github.com/meteor/meteor.git synced 2026-05-02 03:01:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Additional info and improvements of docs for passwordless

Browse Source
This commit is contained in:
Jan Dvorak
2021-10-27 10:17:44 +02:00
parent ea7274abb8
commit d5b700fc55
2 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/source/packages/accounts-passwordless.md
View File

@@ -3,13 +3,20 @@ title: accounts-passwordless
description: Documentation of Meteor's `accounts-passwordless` package.
---
Passwordless package allows you to create a login for users without the need for user to provide password. Upon registering or login an email is sent to the user's email with a code to enter to confirm login and a link to login directly.
Passwordless package allows you to create a login for users without the need for user to provide password. Upon registering or login an email is sent to the user's email with a code to enter to confirm login and a link to login directly. Since the user is responding to the email it will also verify the email.
The first step to in the passwordless process is for the user to sign-up or request a token to their email address. You can do that with the following:
{% apibox "Accounts.requestLoginTokenForUser" %}
If the user is signing up you can pass in the `userData` object like in [Accounts.createUser](/api/passwords.html#Accounts-createUser).
{% apibox "Meteor.loginWithToken" %}
{% apibox "Accounts.requestLoginTokenForUser" %}
{% apibox "Accounts.sendLoginTokenEmail" %}
The second step in the passwordless flow. Like all the other `loginWith` functions call this method to login the user with the token they have inputted.
### E-mail templates
{% apibox "Accounts.sendLoginTokenEmail" %}
Use this function if you want to manually send the email to users to login with token from the server. Do note that you will need to create the token/sequence and save it in the DB yourself. This is good if you want to change how the tokens look or are generated, but unless you are sure of what you are doing we don't recommend it.
<h3 id="passwordless-email-templates">E-mail templates</h3>
`accounts-passwordless` brings new templates that you can edit to change the look of emails which send code to users. The email template is named `sendLoginToken` and beside `user` and `url`, the templates also receive a data object with `sequence` which is the user's code.

7
packages/accounts-passwordless/passwordless_client.js
View File

@@ -34,7 +34,7 @@ const transformSelector = selector => {
/**
* @summary Log the user in with a one time token.
* @locus Client
* @param {Object} selector
* @param {Object|String} selector Username, email or custom selector to identify the user.
* @param {String} token one time token generated by the server
* @param {Function} [callback] Optional callback.
* Called with no arguments on success, or with a single `Error` argument
@@ -62,11 +62,10 @@ Meteor.loginWithToken = (selector, token, callback) => {
/**
* @summary Request a login token.
* @locus Client
* @param {Object} selector
* @param {Object} userData
* @param {Object|String} selector Username, email or custom selector to identify the user.
* @param {Object} userData When creating a user use this data if selector produces no result.
* @param {Object} options
* @param {String} options.selector The email address to get a token for or username or a mongo selector.
* @param {String} options.userData When creating an user use this data if selector produces no result
* @param {String} options.options For example userCreationDisabled.
* @param {Function} [callback] Optional callback. Called with no arguments on success, or with a single `Error` argument on failure.
*/