Two-factor authentication
When a company requires two-factor authentication, its API tokens work only for people who have set it up.
A token is not asked for a code. The check is whether the person behind the token has set up two-factor authentication when their company requires it.
Who is refused
| Company requires two-factor | Person has set it up | Result |
|---|---|---|
| No | Either | Allowed |
| Yes | Yes | Allowed |
| Yes | No | 403 |
Which requests are checked
An endpoint's reference page says whether the check applies. The table says, for each area, whether its requests are checked.
| Area | Needs two-factor enrolment |
|---|---|
| Account | None |
| Agencies and clients | 2 of 6 requests |
| Agency | None |
| CoreCluster | Every request |
| Database | Every request |
| Demos | Every request |
| Enterprise copies | 3 of 5 requests |
| Enterprise deployments | Some requests |
| Environment variables | 3 of 4 requests |
| Operations | Every request |
| Organisations | None |
| PHP | Every request |
| Packages and capacity | Every request |
| Password protection | Every request |
| Performance audits | None |
| Platform plugins | Every request |
| Registry secrets | 4 of 5 requests |
| Repository connections | 2 of 4 requests |
| Sites | Every request |
| Snapshots | Every request |
| Support | None |
| Team | None |
| Websites and environments | Some requests |
| What's new | None |
| Access | Every request |
| Application versions | None |
| Create a site | Every request |
| Platform tools | 2 of 4 requests |
| Marketplace keys | 6 of 8 requests |
| Billing | Every request |
| Copies | Every request |
| Cloudflare | Every request |
| Environments | Every request |
| Scheduled tasks | Every request |
| Deployment templates | Every request |
| Deployment pipeline | Every request |
| Variables and secrets | Every request |
| Deployments | Every request |
| Domains | Every request |
| Outbound email | 9 of 12 requests |
| Error pages | Every request |
| Feedback | Every request |
| Firewall | 7 of 20 requests |
| Logs | Every request |
| Magento stores | Every request |
| Maintenance mode | Every request |
| Maintenance windows | 6 of 14 requests |
| Web server rules | Every request |
| Node.js | Every request |
| Orders | Every request |
| PageSpeed | Every request |
| PHP settings | Every request |
| Laravel queues | Every request |
| Redirects | Every request |
| Pending changes | Every request |
| Account security | None |
| SSH keys | Some requests |
| Terminal | Every request |
| Varnish | Every request |
The refusal
{
"message": "Two-factor enrolment is required before using this.",
"reason": "two_factor_required",
"code": "two_factor_required"
}The reason is the same on every endpoint the check guards. Set up two-factor authentication on your profile in the Control Panel, then send the request again with the same token.
Was this helpful?