| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="securitycenter_v1.html">Security Command Center API</a> . <a href="securitycenter_v1.organizations.html">organizations</a> . <a href="securitycenter_v1.organizations.simulations.html">simulations</a> . <a href="securitycenter_v1.organizations.simulations.attackPaths.html">attackPaths</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists the attack paths for a set of simulation results or valued resources and filter.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next()</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Lists the attack paths for a set of simulation results or valued resources and filter. | |
| Args: | |
| parent: string, Required. Name of parent to list attack paths. Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}" "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}" (required) | |
| filter: string, The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports = | |
| pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. | |
| pageToken: string, The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response message for listing the attack paths for a given simulation or valued resource. | |
| "attackPaths": [ # The attack paths that the attack path simulation identified. | |
| { # A path that an attacker could take to reach an exposed resource. | |
| "edges": [ # A list of the edges between nodes in this attack path. | |
| { # Represents a connection between a source node and a destination node in this attack path. | |
| "destination": "A String", # The attack node uuid of the destination node. | |
| "source": "A String", # The attack node uuid of the source node. | |
| }, | |
| ], | |
| "name": "A String", # The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78` | |
| "pathNodes": [ # A list of nodes that exist in this attack path. | |
| { # Represents one point that an attacker passes through in this attack path. | |
| "associatedFindings": [ # The findings associated with this node in the attack path. | |
| { # A finding that is associated with this node in the attack path. | |
| "canonicalFinding": "A String", # Canonical name of the associated findings. Example: organizations/123/sources/456/findings/789 | |
| "findingCategory": "A String", # The additional taxonomy group within findings from a given source. | |
| "name": "A String", # Full resource name of the finding. | |
| }, | |
| ], | |
| "attackSteps": [ # A list of attack step nodes that exist in this attack path node. | |
| { # Detailed steps the attack can take between path nodes. | |
| "description": "A String", # Attack step description | |
| "displayName": "A String", # User friendly name of the attack step | |
| "labels": { # Attack step labels for metadata | |
| "a_key": "A String", | |
| }, | |
| "type": "A String", # Attack step type. Can be either AND, OR or DEFENSE | |
| "uuid": "A String", # Unique ID for one Node | |
| }, | |
| ], | |
| "displayName": "A String", # Human-readable name of this resource. | |
| "resource": "A String", # The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format]("https://cloud.google.com/asset-inventory/docs/resource-name-format") | |
| "resourceType": "A String", # The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types") | |
| "uuid": "A String", # Unique id of the attack path node. | |
| }, | |
| ], | |
| }, | |
| ], | |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next()</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| </body></html> |