detectedSecretsQueriesRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/postman/main/json-schema/postman-detected-secrets-queries-request-schema.json",
  "title": "detectedSecretsQueriesRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/postman-secret-scanner-api-openapi.yml#/components/schemas/detectedSecretsQueriesRequest",
  "type": "object",
  "properties": {
    "resolved": {
      "type": "boolean",
      "description": "If true, return secrets with a `resolved` status."
    },
    "secretTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of secrets types to query. For a list of valid IDs, use the GET `/secret-types` endpoint."
    },
    "statuses": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DetectedSecretsQueriesRequestStatusesItems"
      },
      "description": "A list of the types of resolution statuses to query."
    },
    "resources": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DetectedSecretsQueriesRequestResourcesItems"
      },
      "description": "A list of resources to query. If you use this query, you cannot also pass the `workspaceIds` query."
    },
    "workspaceIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of workspaces IDs to query. If you use this query, you cannot also pass the `resources` query."
    },
    "workspaceVisibilities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DetectedSecretsQueriesRequestWorkspaceVisibilitiesItems"
      },
      "description": "A list of workspace [visibility settings](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) to query. This currently supports the `team` and `public` settings."
    }
  },
  "$defs": {
    "DetectedSecretsQueriesRequestResourcesItems": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/DetectedSecretsQueriesRequestResourcesItemsType",
          "description": "The type of resource."
        },
        "ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of resource IDs."
        }
      },
      "title": "DetectedSecretsQueriesRequestResourcesItems"
    },
    "DetectedSecretsQueriesRequestResourcesItemsType": {
      "type": "string",
      "enum": [
        "collection",
        "environment",
        "extensible-collection",
        "globals",
        "example",
        "request",
        "folder",
        "extensible-collection-meta",
        "extensible-request",
        "extensible-folder",
        "extensible-example",
        "extensible-message"
      ],
      "description": "The type of resource.",
      "title": "DetectedSecretsQueriesRequestResourcesItemsType"
    },
    "DetectedSecretsQueriesRequestStatusesItems": {
      "type": "string",
      "enum": [
        "FALSE_POSITIVE",
        "ACCEPTED_RISK",
        "REVOKED"
      ],
      "description": "The secret resolution status type:\n- `FALSE_POSITIVE` — The discovered secret is not an actual secret.\n- `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.\n- `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.\n",
      "title": "DetectedSecretsQueriesRequestStatusesItems"
    },
    "DetectedSecretsQueriesRequestWorkspaceVisibilitiesItems": {
      "type": "string",
      "enum": [
        "team",
        "public"
      ],
      "description": "The type of visibility setting.",
      "title": "DetectedSecretsQueriesRequestWorkspaceVisibilitiesItems"
    }
  }
}