Search Detected Secrets Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/detectedSecretsQueries",
  "title": "Search Detected Secrets Request",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Information about the secret finding.",
        "properties": {
          "obfuscatedSecret": {
            "type": "string",
            "description": "The secret's obfuscated value.",
            "example": "keyTF2WAH******"
          },
          "occurrences": {
            "type": "number",
            "description": "The number of times the secret was found in the workspace.",
            "example": 3
          },
          "resolution": {
            "type": "string",
            "description": "The secret's current 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"
          },
          "secretHash": {
            "type": "string",
            "description": "The SHA-256 hash of the detected secret.",
            "example": "07afd1f787f3555d441b04870dbe1025db8309fbeb31f25b3a20f2f1241478b3"
          },
          "secretId": {
            "type": "string",
            "description": "The detected secret's ID.",
            "example": "OTI3OTYx"
          },
          "secretType": {
            "type": "string",
            "description": "The type of the secret.",
            "example": "Airtable API Key"
          },
          "detectedAt": {
            "type": "string",
            "format": "date-time",
            "example": "2023-05-19T02:45:31.000Z",
            "description": "The date and time at which the secret was first detected."
          },
          "workspaceId": {
            "type": "string",
            "description": "The ID of the workspace that contains the secret.",
            "example": "e361eeb4-00dd-4225-9774-6146a2555999"
          },
          "workspaceVisibility": {
            "type": "string",
            "description": "The workspace's [visibility setting](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility).",
            "enum": [
              "personal",
              "private",
              "team",
              "public"
            ],
            "example": "team"
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "description": "The response's meta information for paginated results.",
      "properties": {
        "limit": {
          "type": "number",
          "description": "The maximum number of records in the paginated response.",
          "example": 2
        },
        "nextCursor": {
          "type": "string",
          "nullable": true,
          "format": "base64",
          "description": "The pagination cursor that points to the next record in the results set.",
          "example": "M2JmMWI2YWJiNTFlMjIyOGRiZTk4OWEzNjNjZmMxYjI4YjUxNTRjZGJiMmFiMTk4YTNjMjc2YjU4ZDVlODJiZHw1Y2M1MDZmNS0xMWQzLTQxM2QtYjBmNy1jZjk1OTIxZjRlNDE="
        },
        "total": {
          "type": "number",
          "description": "The number of records that match the defined criteria. This will only be present if the `include` query parameter is specified with the `meta.total` value.",
          "example": 20
        }
      }
    }
  }
}