Method: folders.locations.securityHealthAnalyticsCustomModules.simulate

Simulates the result of using a SecurityHealthAnalyticsCustomModule to check a resource.

HTTP request

POST https://securitycentermanagement.googleapis.com/v1/{parent=folders/*/locations/*}/securityHealthAnalyticsCustomModules:simulate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see AIP-122: Resource names. Example: organizations/{organization_id}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "customConfig": {
    object (CustomConfig)
  },
  "resource": {
    object (SimulatedResource)
  }
}
Fields
customConfig

object (CustomConfig)

Required. The custom configuration that you need to test.

resource

object (SimulatedResource)

Required. Resource data to simulate custom module against.

Response body

If successful, the response body contains an instance of SimulateSecurityHealthAnalyticsCustomModuleResponse.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • securitycentermanagement.securityHealthAnalyticsCustomModules.simulate

For more information, see the IAM documentation.