| <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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.securityAssessmentResults.html">securityAssessmentResults</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#batchCompute">batchCompute(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Compute RAV2 security scores for a set of resources.</p> |
| <p class="toc_element"> |
| <code><a href="#batchCompute_next">batchCompute_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="batchCompute">batchCompute(name, body=None, x__xgafv=None)</code> |
| <pre>Compute RAV2 security scores for a set of resources. |
| |
| Args: |
| name: string, Required. Name of the organization for which the score needs to be computed in the following format: `organizations/{org}/securityAssessmentResults` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for BatchComputeSecurityAssessmentResults. |
| "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources. |
| "resources": [ # Required. The array of resources. For Apigee, the proxies are resources. |
| { # Resource for which we are computing security assessment. |
| "name": "A String", # Required. Name of this resource. |
| "type": "A String", # Required. Type of this resource. |
| }, |
| ], |
| }, |
| "includeAllResources": { # Message for include_all_resources option. # Include all resources under the scope. |
| }, |
| "pageSize": 42, # Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 50 results will be returned. |
| "pageToken": "A String", # Optional. A page token, received from a previous `BatchComputeSecurityAssessmentResults` call. Provide this to retrieve the subsequent page. |
| "profile": "A String", # Required. Name of the profile that is used for computation. |
| "scope": "A String", # Optional. Scope of the resources for the computation. For Apigee, the environment is the scope of the resources. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for BatchComputeSecurityAssessmentResults. |
| "assessmentTime": "A String", # The time of the assessment api call. |
| "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is blank, there are no subsequent pages. |
| "securityAssessmentResults": [ # Default sort order is by resource name in alphabetic order. |
| { # The security assessment result for one resource. |
| "createTime": "A String", # The time of the assessment of this resource. This could lag behind `assessment_time` due to caching within the backend. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status if scoring fails. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "resource": { # Resource for which we are computing security assessment. # The assessed resource. |
| "name": "A String", # Required. Name of this resource. |
| "resourceRevisionId": "A String", # The revision id for the resource. In case of Apigee, this is proxy revision id. |
| "type": "A String", # Required. Type of this resource. |
| }, |
| "scoringResult": { # The result of the assessment. # The result of the assessment. |
| "assessmentRecommendations": { # The recommendations of the assessment. The key is the "name" of the assessment (not display_name), and the value are the recommendations. |
| "a_key": { # The message format of a recommendation from the assessment. |
| "displayName": "A String", # The display name of the assessment. |
| "recommendations": [ # The recommended steps of the assessment. |
| { # The format of the assessment recommendation. |
| "description": "A String", # The description of the recommendation. |
| "link": { # The format for a link in the recommendation. # The link for the recommendation. |
| "text": "A String", # The text of the url. (ie: "Learn more") |
| "uri": "A String", # The link itself. |
| }, |
| }, |
| ], |
| "scoreImpact": 42, # Score impact indicates the impact on the overall score if the assessment were to pass. |
| "verdict": "A String", # Verdict indicates the assessment result. |
| "weight": "A String", # The weight of the assessment which was set in the profile. |
| }, |
| }, |
| "dataUpdateTime": "A String", # The time when resource data was last fetched for this resource. This time may be different than when the resource was actually updated due to lag in data collection. |
| "failedAssessmentPerWeight": { # The number of failed assessments grouped by its weight. Keys are one of the following: "MAJOR", "MODERATE", "MINOR". |
| "a_key": 42, |
| }, |
| "score": 42, # The security score of the assessment. |
| "severity": "A String", |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="batchCompute_next">batchCompute_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> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| </body></html> |
