Method: organizations.eventThreatDetectionSettings.validateCustomModule

Validates the given Event Threat Detection custom module.

HTTP request

POST https://securitycenter.googleapis.com/v1/{parent=organizations/*/eventThreatDetectionSettings}:validateCustomModule

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of the parent to validate the Custom Module under.

Its format is:

  • "organizations/{organization}/eventThreatDetectionSettings".

Request body

The request body contains data with the following structure:

JSON representation 
{
  "rawText": string,
  "type": string
}
Fields
rawText

string

Required. The raw text of the module's contents. Used to generate error messages.
type

string

Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).

Response body

Response to validating an Event Threat Detection custom module.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "errors": {
    object (CustomModuleValidationErrors)
  }
}
Fields
errors

object (CustomModuleValidationErrors)

A list of errors returned by the validator. If the list is empty, there were no errors.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CustomModuleValidationErrors

A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.

JSON representation 
{
  "errors": [
    {
      object (CustomModuleValidationError)
    }
  ]
}
Fields
errors[]

object (CustomModuleValidationError)

CustomModuleValidationError

An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.

JSON representation 
{
  "description": string,
  "fieldPath": string,
  "start": {
    object (Position)
  },
  "end": {
    object (Position)
  }
}
Fields
description

string

A description of the error, suitable for human consumption. Required.
fieldPath

string

The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected.
start

object (Position)

The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed.
end

object (Position)

The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed..

Position

A position in the uploaded text version of a module.

JSON representation 
{
  "lineNumber": integer,
  "columnNumber": integer
}
Fields
lineNumber

integer
columnNumber

integer