key_scope: This API key cannot call that route
On the multi-tenant hosted tier, the presented credential is not allowed to make this request. Nothing was billed. The causes:
- The key's scope (
owner,read_only,wire, ormerchant) does not allow the method and path. - A member session (single sign-on) called a route outside
/owner/; member sessions reach/owner/routes only. - A tenant credential tried to change a revenue switch (a write under
/owner/v1/revenue). Revenue switches are set by the deployment operator; tenant credentials may only read them. - A credential without the
ownerscope tried to create or revoke a key, or a credential other than a dashboard session calledGET /tenant/v1/session. - A
merchantkey has no merchant surface in this environment.
What to do
- Create a key with the needed scope in the dashboard (
POST /tenant/v1/keys). - Use a
wirekey only for/plugin/v1/, amerchantkey only for/merchant/, andread_onlyonly for GET/HEAD on owner routes and on/tenant/v1/settings. - Members act through
/owner/routes only; ask the tenant owner for anything else. - Ask the deployment operator to change a revenue switch.
On the wire
HTTP 403, error type authentication_error. Only the multi-tenant front door answers this code, always with errorDetail:
{
"error": "key_scope",
"errorDetail": {
"type": "authentication_error",
"code": "key_scope",
"message": "a read_only key cannot call POST /owner/v1/…",
"param": null,
"doc_url": "…/errors/key_scope.md",
"fix": "this key's scope does not allow this route; create a key with the needed scope in the dashboard"
}
}
See all error codes.