API_KEY_LEDGER_READ_NOT_ALLOWED

API keys may not read this organisation's finance data

HTTP status 403 Forbidden, code API_KEY_LEDGER_READ_NOT_ALLOWED.

What it means#

The organisation API key holds the ledger.read scope, or you asked for a key with it, and the organisation has not allowed API keys to read its finance data (allowApiKeyLedgerRead on the organisation, off by default). The scope on the key is not enough on its own. Every ledger read and a payment provider's balances refuse the key with this code for as long as the setting is off, including a key minted while it was on.

What to do#

Ask an organisation admin to allow it in Backstage under Platform > Settings, "API keys and finance data" (or PATCH /organisations/{id} with {"allowApiKeyLedgerRead": true}, as a person holding organisation.update). The key needs no change once it is allowed.

On the wire#

Every error response carrying this code names this page in error.moreInfo, with the request id in the query string. See Error codes for the response shape and the list of every code.