Skip to main content

Remove Integration Credentials (admin)

Requires admin-scoped API key

This tool is only available when authenticated with an admin-scoped Phoenix API key. User-scoped keys never see it in tools/list and receive 403 forbidden_admin_scope if they try to call it directly. See Admin operations overview for details.

Deactivate an integration by removing its credential. Idempotent — returns success whether or not a row existed at the time of the call. This avoids hostile retries on automation jobs that may have already succeeded.

Tool key: admin_remove_integration_credentials

Parameters​

NameTypeRequiredDefaultDescription
integration_keystringYes–Catalog key for the integration to deactivate. 1–255 chars.

Required Integrations​

None.

Output​

{
  "key": "zoominfo",
  "isConfigured": false
}

How It Works​

  1. Org slug is derived from the API key.
  2. The catalog entry for integration_key is resolved — 404 integration_not_found if integration_key is not in the catalog at all (this is not the same as "no credential exists" — that case returns success).
  3. The configured_integrations row is deleted (no-op if no row existed).
  4. For TrustRadius specifically, the aggregator credentials are synced in swallow mode — a sync failure here is logged and ignored, since the local DB delete already happened.
  5. A row is written to webapp_org_admin_audit_log with action remove_integration_credentials, target_type integration, target_id = integration_key, metadata { wasNoop: boolean } — wasNoop=false means a row was actually deleted; true means the call was a no-op.

Idempotency​

The tool's idempotent design means callers can safely retry it from a cron / queue worker without worrying about double-removal failures. Both calls are audited (with wasNoop: true on the second), so the audit trail stays truthful about caller intent.

Use Cases​

  • Decommissioning an integration that's no longer needed.
  • Cleanup as part of a customer offboarding script.
  • Recovery from a leaked credential when the rotation script's PUT step has already failed and you want to revert to "no integration".

Errors​

  • 400 invalid_request — missing integration_key.
  • 403 forbidden_admin_scope — caller's API key is not admin-scoped.
  • 404 integration_not_found — integration_key is not in the catalog at all.

See also​