Successful Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/updateSecretResolutions",
  "title": "Successful Response",
  "type": "object",
  "properties": {
    "secretHash": {
      "type": "string",
      "description": "The SHA-256 hash of the detected secret.",
      "example": "50dbd2..."
    },
    "workspaceId": {
      "type": "string",
      "description": "The ID of the workspace that contains the secret.",
      "example": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9"
    },
    "resolution": {
      "type": "string",
      "description": "The secret's current resolution status:\n- `ACTIVE` \u2014 The secret is active.\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",
      "example": "FALSE_POSITIVE",
      "enum": [
        "FALSE_POSITIVE",
        "ACCEPTED_RISK",
        "REVOKED",
        "ACTIVE"
      ]
    },
    "history": {
      "type": "array",
      "description": "The history of the secret's resolution status changes.",
      "items": {
        "type": "object",
        "properties": {
          "actor": {
            "type": "number",
            "description": "The ID of the user that updated the secret's resolution status.",
            "example": 12345678
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time at which the resolution status was updated.",
            "example": "2024-09-18T18:46:26.000Z"
          },
          "resolution": {
            "type": "string",
            "description": "The secret's updated resolution status:\n- `ACTIVE` \u2014 The secret is active.\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",
              "ACCEPTED_RISK",
              "REVOKED",
              "ACTIVE"
            ],
            "example": "FALSE_POSITIVE"
          }
        }
      }
    }
  }
}