{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/getSecretsLocations",
"title": "Successful Response",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"description": "Information about the secret finding locations.",
"properties": {
"isResourceDeleted": {
"type": "boolean",
"description": "If true, the resource in which the secret was found was deleted.",
"example": false
},
"leakedBy": {
"type": "integer",
"description": "The ID of the user who exposed the secret.",
"example": 12345678
},
"location": {
"type": "string",
"description": "The location where the secret was found.",
"example": "Headers"
},
"occurrences": {
"type": "integer",
"description": "The number of times the secret occurs in the location.",
"example": 1
},
"parentResourceId": {
"type": "string",
"format": "uid",
"description": "The parent resource's unique ID. If the resource is a request, folder, or example, this value is a collection ID. If the resource is a collection, globals, or environment, this is the resource's ID.",
"example": "12345678-14728df4-c7af-424f-b665-5047b7d25866"
},
"resourceId": {
"type": "string",
"format": "uid",
"description": "The unique ID of the resource where the secret was detected.",
"example": "12345678-e0df25e0-d245-40dd-89b5-68720d186d3f"
},
"resourceType": {
"type": "string",
"description": "The type of resource in which the secret was detected.",
"enum": [
"collection",
"folder",
"request",
"example",
"environment",
"globals",
"api"
],
"example": "example"
},
"detectedAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the secret was detected.",
"example": "2023-04-25T08:13:48.000Z"
},
"url": {
"type": "string",
"description": "The URL to the resource that contains the secret.",
"example": "https://go.postman-beta.co/build/workspace/80ab14ae-c17d-4fd6-88d5-99bf13f0b7f0/example/12345678-e0df25e0-d245-40dd-89b5-68720d186d3f"
}
}
}
},
"meta": {
"type": "object",
"properties": {
"activityFeed": {
"type": "array",
"description": "The history of the secret's resolution status changes.",
"items": {
"type": "object",
"properties": {
"resolvedAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the resolution status was last updated.",
"example": "2023-04-25T11:18:07.000Z"
},
"resolvedBy": {
"type": "integer",
"description": "The ID of the user that updated the secret's resolution status.",
"example": 12345678
},
"status": {
"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",
"enum": [
"FALSE_POSITIVE",
"ACCEPTED_RISK",
"REVOKED",
"ACTIVE"
],
"example": "FALSE_POSITIVE"
}
}
}
},
"cursor": {
"type": "string",
"description": "The pointer to the first record of the set of paginated results.",
"example": "MTIyNjY5Nw=="
},
"limit": {
"type": "integer",
"description": "The maximum number of rows to return in the response.",
"example": 2
},
"nextCursor": {
"type": "string",
"nullable": true,
"description": "The Base64-encoded value that points to the next record in the results set.",
"example": null
},
"obfuscatedSecret": {
"type": "string",
"description": "The secret's obfuscated value.",
"example": "PMAK-644781584627df042afa6655-******ba"
},
"secretHash": {
"type": "string",
"description": "The secret's SHA-256 hash.",
"example": "0096b35ef6621d7571f106fefee5b10e8ed360cc9bf04f343f267ca4ff65bb5d"
},
"secretType": {
"type": "string",
"description": "The type of thesecret.",
"example": "Postman API Key"
},
"total": {
"type": "integer",
"description": "The total number of discovered secret locations.",
"example": 3
}
}
}
}
}