Skip to content

Invalid Provider Credential Structure

URI: https://docs.ankatech.co/errors/invalid-provider-credential
HTTP Status: 400 Bad Request

When you see this

A delivery-provider credential was saved, and it does not have the structure the provider's mechanism requires. It is returned by the three credential saves:

  • PUT /api/v3/admin/tenants/{tenantId}/notification/providers/{id}/credential (operation replaceNotificationProviderCredential), a tenant's own provider;
  • PUT /api/v3/admin/platform/tenants/{tenantId}/notification/providers/{id}/credential (operation replacePlatformTenantNotificationProviderCredential), a tenant's provider configured by the platform operator;
  • PUT /api/v3/admin/platform/notification/providers/{id}/credential (operation replacePlatformNotificationProviderCredential), a platform provider.

Structure is all that was examined. The check proves that a service-account document parses and carries the members the mechanism reads. Nothing was contacted and the credential was not verified: whether it authenticates is what the provider's connection test decides.

The refused save writes nothing and changes nothing: no credential is sealed, the provider is not demoted, and a credential sealed earlier stays in force. The body names members, never values, and carries no fragment of what was submitted.

extensions.missingMembers lists the required members a service-account document did not carry. It is present only when the document could be read: when the payload is not a JSON object, no member could be read, and the member is absent rather than empty.

Common Causes

  • A Gmail service-account document that lacks client_email, private_key or token_uri, or carries one of them as an empty or non-string value.
  • A Gmail credential that is not a JSON object at all, for example the private key pasted on its own.
  • A credential sent to a WEBHOOK provider. Webhook requests are signed with a per-destination secret configured on the destination itself, so a webhook provider carries no provider credential.

A blank credential, or one longer than 8,192 characters, is refused at the request boundary before this check runs, as a Validation Error.

Response Example

{
  "type": "https://docs.ankatech.co/errors/invalid-provider-credential",
  "title": "Invalid Provider Credential Structure",
  "status": 400,
  "detail": "The service-account document does not carry private_key. Only the document's structure was examined — nothing was contacted, no key was parsed or loaded, and nothing was verified.",
  "instance": "/api/v3/admin/tenants/2c8f5a31-7b04-4d9e-a1c6-3f80e5b2d947/notification/providers/9f2b7c14-8d3e-4a61-b0d9-5e7c1a2f6b83/credential",
  "timestamp": 1763112600,
  "extensions": {
    "missingMembers": ["private_key"],
    "requestId": "0f3c7b2a-91d4-4e58-8c2f-6a1b0d9e3745"
  }
}

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

How to Resolve

  1. Read the detail and, when present, extensions.missingMembers.
  2. For a Gmail provider, send the complete service-account JSON document, carrying client_email, private_key and token_uri.
  3. For a webhook provider, send no provider credential: the signing secret is configured on the destination.
  4. Save the credential again, then run the provider's connection test (operation testNotificationProvider for a tenant's own provider) to verify that it authenticates.

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