Multi-Factor Sign-In
Multi-factor sign-in is available from eConnect 11.0.10.
From 11.0.10, people who sign in to the eConnect applications can add a second step to their sign-in, and an administrator can require one for a user group. It is a feature for people: it is set up and used in the eConnect web application and desktop client.
The API is not multi-factor, by design
An integration has no person in the middle to answer a second step, so API access does not ask for one.
- Sign in with a service account and its access id. This is the supported way for an integration to authenticate — see Signing in with an access id. Service accounts cannot have multi-factor sign-in, and no user group requirement applies to them.
- Existing integrations keep working. The sign-in endpoints keep their addresses, inputs and response shapes. Nothing changes for an account that does not use multi-factor sign-in.
Do not sign an integration in as a person
An integration that signs in with a person's user name and password can stop working without warning: when that person turns multi-factor sign-in on, or when their user group starts requiring it. The sign-in is then refused, and the response carries one of these error codes with a message for the person to read.
| Code | Meaning |
|---|---|
98 | The account has multi-factor sign-in, and this sign-in did not include its second step |
99 | The account's user group requires multi-factor sign-in, and it has not been set up yet |
13131 | The account uses emailed codes, and this sign-in did not include one |
13126 | A switch into a user group that requires multi-factor sign-in was refused |
If your integration receives one of these, move it to a service account. Treat the refusal as final: do not retry in a loop, because repeated failed sign-ins lock the account for a time.
On v2, a refusal is the usual problem document, with the code in errorCode. On v1, the result comes
back with Failed: true and the code in FailureErrorCode.
Related
- Getting Started — tokens, refresh and access ids
- Multi-Factor Sign-In — the user's side, in the eConnect Core manual
- Multi-Factor Sign-In for Administrators — requiring it for a user group