Skip to content
This repository has been archived by the owner on Jan 5, 2019. It is now read-only.

Commit

Permalink
Merge pull request #368 from stormpath/develop
Browse files Browse the repository at this point in the history
Minor updates
  • Loading branch information
Jakub Swiatczak authored Nov 1, 2016
2 parents b81e659 + 2ba4d33 commit 5811579
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
13 changes: 9 additions & 4 deletions source/auth_n.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4084,7 +4084,7 @@ The multi-factor authentication process works as follows with text messages:
With Google Authenticator, the flow is only slightly different:

#. An additional **Factor** of type ``google-authenticator`` is added to an Account.
#. The new **Factor** has a **secret** and a Base64-encoded **QR code**, both of which can be used to add it to the Google Authenticator app.
#. The new **Factor** has a **secret** and a Base64-encoded **QR code**, both of which can be used to add it to the Google Authenticator (or `similar <https://www.authy.com/tutorials/how-use-authy-google-authenticator/>`__) app.
#. At any time, you can send the **code** from the Authenticator app to Stormpath's ``/challenges`` endpoint, at which point you will get back either a ``SUCCESS`` or ``FAILED`` response.

.. note::
Expand Down Expand Up @@ -4366,8 +4366,13 @@ To add an additional Google Authenticator Factor to this Account, you must send
{
"type":"google-authenticator",
"accountName": "[email protected]"
"issuer": "Example App"
}
.. note::

Although the ``issuer`` field is not required, it is recommended because it will make a name show up under the code in the Google Authenticator (or `similar <https://www.authy.com/tutorials/how-use-authy-google-authenticator/>`__) app.

.. only:: java

.. literalinclude:: code/java/authentication/mfa_add_ga_factor_req.java
Expand Down Expand Up @@ -4517,11 +4522,11 @@ You can now take this string and turn it into a QR Code image:
- You could use a QR Code Library, such as `QRCode.js <https://davidshimjs.github.io/qrcodejs/>`__
- Or you could generate the image yourself, using an ``<img>`` tag or CSS. For examples of both, see `here <https://css-tricks.com/examples/DataURIs/>`__.

.. todo::
Once the image is generated, the user will scan it into their Authenticator app. If you ask them for a code, they will go into the app and find the code for your application. For information about what happens with this code, see :ref:`below <mfa-challenge-after-google>`.

Not sure if this text above applies for the SDKs?
.. note::

Once the image is generated, the user will scan it into their Authenticator app. If you ask them for a code, they will go into the app and find the code for your application. For information about what happens with this code, see :ref:`below <mfa-challenge-after-google>`.
Many authenticator apps are compatible with Google Authenticator QR codes. Apps we like include `Authy <https://www.authy.com/app/>`__ and `Duo Mobile <https://duo.com/solutions/features/two-factor-authentication-methods/duo-mobile>`__.

.. _mfa-challenge:

Expand Down
4 changes: 2 additions & 2 deletions source/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4071,7 +4071,7 @@
- Optional Query Parameters
- Description

* - POST /v1/groupMemberships/$GROUP_MEMBERSHIP_ID
* - POST /v1/groupMemberships
- Required: ``account``, ``group``
- N/A
- Creates a new groupMembership resource.
Expand Down Expand Up @@ -5448,7 +5448,7 @@
* - ``issuer``
- String
- N/A
- (Google Authenticator only; Optional) The issuer of the Google Authenticator Factor.
- (Google Authenticator only; Optional) The issuer of the Google Authenticator Factor. This name will appear in the Google Authenticator (or Authy, etc) application under the code.

* - ``secret``
- String
Expand Down

0 comments on commit 5811579

Please sign in to comment.