Detected Secrets Query Request

APIs.ioEngineeringPlatform

Properties

Name Type Description
resolved boolean If true, return secrets with a `resolved` status.
secretTypes array A list of secrets types to query. For a list of valid IDs, use the GET `/secret-types` endpoint.
statuses array A list of the types of resolution statuses to query.
workspaceIds array A list of workspaces IDs to query.
workspaceVisiblities array 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 suppo
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-detectedsecretsqueriesrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/detectedSecretsQueriesRequest",
  "title": "Detected Secrets Query Request",
  "type": "object",
  "properties": {
    "resolved": {
      "type": "boolean",
      "description": "If true, return secrets with a `resolved` status.",
      "example": true
    },
    "secretTypes": {
      "type": "array",
      "description": "A list of secrets types to query. For a list of valid IDs, use the GET `/secret-types` endpoint.",
      "items": {
        "type": "string",
        "description": "The secret type ID.",
        "example": "1a7ec5d1-dcba-4ec7-8220-3c1ee490416b"
      }
    },
    "statuses": {
      "type": "array",
      "description": "A list of the types of resolution statuses to query.",
      "items": {
        "type": "string",
        "description": "The secret resolution status type:\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"
        ],
        "example": "ACCEPTED_RISK"
      }
    },
    "workspaceIds": {
      "type": "array",
      "description": "A list of workspaces IDs to query.",
      "items": {
        "type": "string",
        "description": "The workspace ID.",
        "example": "0fe6c2f2-022d-48f7-8e7e-3244369445b0"
      }
    },
    "workspaceVisiblities": {
      "type": "array",
      "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.",
      "items": {
        "type": "string",
        "description": "The type of visibility setting.",
        "enum": [
          "team",
          "public"
        ],
        "example": "team"
      }
    }
  }
}