GitXplorerGitXplorer
e

node-authy

public
96 stars
40 forks
5 issues

Commits

List of commits on branch master.
Verified
0b029d7e1d38f41607b4ee41d1352b9a0d6e7b16

Merge pull request #31 from robinske/standardize-readme

jjosh-authy committed 5 years ago
Unverified
8cf0737c82e1cf6cc8ef2178a630fcc2f22b511a

Move documentation to twilio.com/docs/authy/api

rrobinske committed 5 years ago
Verified
a507d34fea0ffc7a4b4dd25120d7b9666c640efe

Merge pull request #28 from christian-muertz/master

jjosh-authy committed 6 years ago
Verified
b94fa19fb48cafbe2ac5803bc3418c47e5e51822

Iterate Version number for @josh-authy

ddacbd committed 6 years ago
Unverified
9f37c891e9f1b4dc607ca690e5c6e4160145c192

Add support for 'Check the Status of a Verification Code Sent to the User'

committed 6 years ago
Verified
5cbfd0d4e69c6a7fb686150df3366337cc1e4a95

Merge pull request #26 from AuthySE/master

jjosh-authy committed 7 years ago

README

The README file for this repository.

Dependency Status

Node.js Client for Twilio Authy Two-Factor Authentication (2FA) API

Authy client for Node.js written by Adam Baldwin.

Documentation for this Node.js usage of the Authy API lives in the official Twilio documentation.

The Authy API supports multiple channels of 2FA:

  • One-time passwords via SMS and voice.
  • Soft token (TOTP via the Authy App)
  • Push authentication via the Authy App

If you only need SMS and Voice support for one-time passwords, we recommend using the Twilio Verify API instead.

More on how to choose between Authy and Verify here.

Authy Quickstart

For a full tutorial, check out the Node.js Authy Quickstart in our docs:

Authy Node.js Installation

Install with npm:

$ npm install authy

Usage

To use the Authy client, require Authy and initialize it with your production API Key found in the Twilio Console:

var authy = require('authy')('APIKEY');

authy api key in console

2FA Workflow

  1. Create a user
  2. Send a one-time password
  3. Verify a one-time password

OR

  1. Create a user
  2. Send a push authentication
  3. Check a push authentication status

Phone Verification

Phone verification now lives in the Twilio API and has Node.js support through the official Twilio helper libraries.

Legacy (V1) documentation here. Verify V1 is not recommended for new development. Please consider using Verify V2.

Contributing

Install dependencies:

npm install

To run tests:

npm test

Contributors