Update Secret Resolution Request

APIs.ioEngineeringPlatform

Properties

Name Type Description
resolution string The secret's updated resolution status: - `FALSE_POSITIVE` — The discovered secret is not an actual secret. - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue. - `A
workspaceId string The ID of the workspace that contains the secret.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-updatesecretresolutionsrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/updateSecretResolutionsRequest",
  "title": "Update Secret Resolution Request",
  "required": [
    "resolution",
    "workspaceId"
  ],
  "type": "object",
  "properties": {
    "resolution": {
      "type": "string",
      "description": "The secret's updated resolution status:\n- `FALSE_POSITIVE` \u2014 The discovered secret is not an actual secret.\n- `REVOKED` \u2014 The secret is valid, but the user rotated their key to resolve the issue.\n- `ACCEPTED_RISK` \u2014 The Secret Scanner found the secret, but user accepts the risk of publishing it.\n",
      "enum": [
        "FALSE_POSITIVE",
        "REVOKED",
        "ACCEPTED_RISK"
      ],
      "example": "ACCEPTED_RISK"
    },
    "workspaceId": {
      "type": "string",
      "description": "The ID of the workspace that contains the secret.",
      "example": "e361eeb4-00dd-4225-9774-6146a2555999"
    }
  }
}