FruxonDocs
ApiSecrets

Updates description or sensitivity.

Sensitivity can be upgraded but not downgraded — relaxing the audit policy on a secret that already saw stricter handling returns 400. The key itself is immutable on purpose (resolver references would break).

PATCH
/v1/tenants/{tenant}/secrets/{secret}

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

secret*string

The secret identifier (Guid).

Formatuuid
tenant*string

The tenant identifier

Request Body

The patch payload.

description?string|null

New description, or null to leave unchanged. Cannot be used to rename the secret key — keys are stable on purpose so resolver references in agent definitions don't break.

sensitivity?string

Sensitivity tier of a stored credential. Drives the per-operation audit policy (best-effort logging for Fruxon.Model.Encryption.Audit.CredentialSensitivity.Standard, fail-closed DB writes for Fruxon.Model.Encryption.Audit.CredentialSensitivity.Phi / Fruxon.Model.Encryption.Audit.CredentialSensitivity.Financial / Fruxon.Model.Encryption.Audit.CredentialSensitivity.Regulated) and is declared per integration class on its IntegrationAuthMetadata.

Values are ordered by stringency — higher numbers carry stricter defaults. A credential subject to multiple regimes is tagged its strictest applicable label.

Value in"UNSPECIFIED" | "STANDARD" | "PII" | "PHI" | "FINANCIAL" | "REGULATED"
[key: string]?never

Response Body

curl -X PATCH "https://api.fruxon.com/v1/tenants/string/secrets/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "key": "string",
  "description": "string",
  "sensitivity": "STANDARD",
  "publishedRevisionId": "00000000-0000-0000-0000-000000000000",
  "publishedVersion": 0,
  "createdBy": "string",
  "createdAt": 0,
  "modifiedAt": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}