Skip to content

Commit

Permalink
docs: Add types of TWO_FAS
Browse files Browse the repository at this point in the history
  • Loading branch information
ptbrowne authored Aug 23, 2019
1 parent 6aaf119 commit 67b3e6f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/io.cozy.accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ Accounts can be managed in [Cozy-Home](http://github.com/cozy/cozy-home/) (via [
- `data`: {object} Additional custom data.
- `label`: {string} Label given by user.
- `state`: {string} The account state is used to communicate between the konnector and [Harvest](https://github.com/cozy/cozy-libs/tree/master/packages/cozy-harvest-lib) to ask for a needed 2FA Code or to tell to reset the konnector session for example. Here are the used values for now:
- `TWOFA_NEEDED`: The service is asking for a Two Factor connexion and the related code (sent by the service) must be provided by the user.
- `TWOFA_NEEDED_RETRY`: The 2FA code provided by the user is wrong, the user can retry by providing a new one.
- `TWOFA_NEEDED`: The service is asking for a Two Factor connexion and the related code (sent by the service) must be provided by the user. This status can be further precised with its type. This allows the UI presented to the user to have custom messages, depending on the type of two factor authentication required by the vendor.
- `TWOFA_NEEDED.EMAIL`: If the two factor authentication is done by email
- `TWOFA_NEEDED.SMS`: If the two factor authentication is done by SMS
- `TWOFA_NEEDED_RETRY`: The 2FA code provided by the user is wrong, the user can retry by providing a new one. `TWO_FA_NEEDED_RETRY.EMAIL` and `TWO_FA_NEEDED_RETRY.SMS` can also be used.
- `RESET_SESSION`: By finding this state, the konnector should reset the login session if there is one stored and reset the state.
- `twoFACode`: When a 2FA code is asked by the service, [Harvest](https://github.com/cozy/cozy-libs/tree/master/packages/cozy-harvest-lib) will ask the user for it from and send it to the konnector via this attribute.

Expand Down

0 comments on commit 67b3e6f

Please sign in to comment.