Skip to content

Tenant Consent Required (Key Analytics)

URI: https://docs.ankatech.co/errors/tenant-consent-required
HTTP Status: 403 Forbidden

When you see this

A platform administrator asked the Admin API's platform analytics for a customer tenant's figures, on a deployment ANKATech operates. On such a deployment a platform administrator reads a customer tenant's key analytics only inside a support-access session that tenant granted, or on that tenant's own analytics: the platform analytics answer deployment-wide totals and name no customer tenant and no key.

The rule is deployment-scoped. It applies on SAAS and DEDICATED_SAAS deployments, and on a deployment whose record carries no type. A deployment with no record at all is a server fault, answered 500, never this refusal. On PRIVATE_CLOUD and ON_PREMISE the platform administrator is the deployment's own owner, the rule does not apply, and these requests are answered per tenant and per key.

This is not a missing scope: the caller holds platform.analytics.read. The refusal is raised before anything is read, and the platform tenant's own figures are never refused.

Common Causes

  • A tenantIds filter naming any customer tenant on a platform analytics read: the health summary, the expiration report, the algorithm usage, the most-used keys, the migration candidates, the component distribution, the keys by component algorithm, the usage limits, and the two CSV exports. The whole request is refused; the list is never filtered silently. A list naming only the platform tenant is admitted, and no filter returns the deployment-wide totals.
  • One customer tenant's evaluation of a compliance pack on the platform plane, GET /api/v3/admin/platform/compliance-evaluations/{packId}/tenants/{tenantId}.

What the platform analytics answer on this deployment

  • Every per-tenant and per-key member is empty: the expiring keys and the per-tenant expiry rows, the most-used, usage-limit and by-component keys, the migration candidates, the per-tenant conformance rows and the per-tenant compliance rows. The totals are kept. The CSV exports carry the totals and no key record, and their preamble names no tenant.

Response Example

{
  "type": "https://docs.ankatech.co/errors/tenant-consent-required",
  "title": "Tenant consent required",
  "status": 403,
  "detail": "On this deployment a platform administrator reads a tenant's key analytics only through that tenant's support access.",
  "instance": "/api/v3/admin/platform/compliance-evaluations/NIST_PQC_TRANSITION/tenants/{id}",
  "timestamp": 1762941600,
  "extensions": {
    "requestId": "9c41e7a2-5b08-4d3f-a6e1-2f7c90b4d815"
  }
}

Content-Type: application/problem+json — the response follows RFC 9457 Problem Details.

Branch on type, not on the status: the generic forbidden type reads as a missing scope and would send an operator to widen a role, which cannot help here. The title and detail are fixed. The body is the same whether the tenant exists or not: instance names the operation with any tenant id replaced by {id}, and only timestamp and extensions.requestId vary between requests.

The audit trail has its own refusal of the same kind, Tenant Consent Required, raised by the Audit API.

How to Resolve

  1. Ask the tenant's administrator to grant support access for the window the work needs (at most 24 hours).
  2. Enter the tenant through the support-access session and read its analytics there.
  3. For a deployment-wide question, call the platform analytics without a customer tenant filter: they answer with deployment totals.

For full schema definitions, examples, and interactive testing, see the Developer Hub Reference.