Apigee API . organizations . environments . securityIncidents

batchUpdate(parent, body=None, x__xgafv=None)

BatchUpdateSecurityIncident updates multiple existing security incidents.

Args:
  parent: string, Optional. The parent resource shared by all security incidents being updated. If this is set, the parent field in the UpdateSecurityIncidentRequest messages must either be empty or match this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for BatchUpdateSecurityIncident.
  "requests": [ # Optional. Required. The request message specifying the resources to update. A maximum of 1000 can be modified in a batch.
    { # Request for UpdateSecurityIncident.
      "securityIncident": { # Represents an SecurityIncident resource. # Required. The security incident to update. Must contain all existing populated fields of the current incident.
        "detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
          "A String",
        ],
        "displayName": "A String", # Optional. Display name of the security incident.
        "firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
        "lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
        "lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
        "name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
        "observability": "A String", # Optional. Indicates if the user archived this incident.
        "riskLevel": "A String", # Output only. Risk level of the incident.
        "trafficCount": "A String", # Total traffic detected as part of the incident.
      },
      "updateMask": "A String", # Required. The list of fields to update. Allowed fields are: LINT.IfChange(allowed_update_fields_comment) - observability LINT.ThenChange()
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for BatchUpdateSecurityIncident.
  "securityIncidents": [ # Output only. Updated security incidents
    { # Represents an SecurityIncident resource.
      "detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
        "A String",
      ],
      "displayName": "A String", # Optional. Display name of the security incident.
      "firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
      "lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
      "lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
      "name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
      "observability": "A String", # Optional. Indicates if the user archived this incident.
      "riskLevel": "A String", # Output only. Risk level of the incident.
      "trafficCount": "A String", # Total traffic detected as part of the incident.
    },
  ],
}

close()

Close httplib2 connections.

get(name, x__xgafv=None)

GetSecurityIncident gets the specified security incident. Returns NOT_FOUND if security incident is not present for the specified organization and environment.

Args:
  name: string, Required. Security incident in the following format: `organizations/{org}/environments/{environment}/securityIncidents/{incident}'. Example: organizations/testOrg/environments/testEnv/securityIncidents/1234-4567-890-111 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an SecurityIncident resource.
  "detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
    "A String",
  ],
  "displayName": "A String", # Optional. Display name of the security incident.
  "firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
  "lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
  "lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
  "name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
  "observability": "A String", # Optional. Indicates if the user archived this incident.
  "riskLevel": "A String", # Output only. Risk level of the incident.
  "trafficCount": "A String", # Total traffic detected as part of the incident.
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

ListSecurityIncidents lists all the security incident associated with the environment.

Args:
  parent: string, Required. For a specific organization, list of all the security incidents. Format: `organizations/{org}/environments/{environment}` (required)
  filter: string, The filter expression to be used to get the list of security incidents, where filtering can be done on API Proxies. Example: filter = "api_proxy = /", "first_detected_time >", "last_detected_time <"
  pageSize: integer, Optional. The maximum number of incidents to return. The service may return fewer than this value. If unspecified, at most 50 incidents will be returned.
  pageToken: string, Optional. A page token, received from a previous `ListSecurityIncident` call. Provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListSecurityIncidents.
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "securityIncidents": [ # List of security incidents in the organization
    { # Represents an SecurityIncident resource.
      "detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
        "A String",
      ],
      "displayName": "A String", # Optional. Display name of the security incident.
      "firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
      "lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
      "lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
      "name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
      "observability": "A String", # Optional. Indicates if the user archived this incident.
      "riskLevel": "A String", # Output only. Risk level of the incident.
      "trafficCount": "A String", # Total traffic detected as part of the incident.
    },
  ],
}

list_next()

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.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

UpdateSecurityIncidents updates an existing security incident.

Args:
  name: string, Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an SecurityIncident resource.
  "detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
    "A String",
  ],
  "displayName": "A String", # Optional. Display name of the security incident.
  "firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
  "lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
  "lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
  "name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
  "observability": "A String", # Optional. Indicates if the user archived this incident.
  "riskLevel": "A String", # Output only. Risk level of the incident.
  "trafficCount": "A String", # Total traffic detected as part of the incident.
}

  updateMask: string, Required. The list of fields to update. Allowed fields are: LINT.IfChange(allowed_update_fields_comment) - observability LINT.ThenChange()
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an SecurityIncident resource.
  "detectionTypes": [ # Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
    "A String",
  ],
  "displayName": "A String", # Optional. Display name of the security incident.
  "firstDetectedTime": "A String", # Output only. The time when events associated with the incident were first detected.
  "lastDetectedTime": "A String", # Output only. The time when events associated with the incident were last detected.
  "lastObservabilityChangeTime": "A String", # Output only. The time when the incident observability was last changed.
  "name": "A String", # Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
  "observability": "A String", # Optional. Indicates if the user archived this incident.
  "riskLevel": "A String", # Output only. Risk level of the incident.
  "trafficCount": "A String", # Total traffic detected as part of the incident.
}