2023-12-13
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.validateCustomModule
Path: v1/{+parent}:validateCustomModule
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings:validateCustomModule
HTTP Method: POST
Parameters:
parent
Description: Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Validates the given Event Threat Detection custom module.
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.customModules.create
Path: v1/{+parent}/customModules
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings/customModules
HTTP Method: POST
Parameters:
parent
Description: Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.customModules.delete
Path: v1/{+name}
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.customModules.get
Path: v1/{+name}
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets an Event Threat Detection custom module.
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.customModules.listDescendant
Path: v1/{+parent}/customModules:listDescendant
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings/customModules:listDescendant
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
pageToken
Description: A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
Location: query
Type: string
pageSize
Description: The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.customModules.list
Path: v1/{+parent}/customModules
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings/customModules
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
pageToken
Description: A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
Location: query
Type: string
pageSize
Description: The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.customModules.patch
Path: v1/{+name}
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: The list of fields to be updated. If empty all mutable fields will be updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.effectiveCustomModules.get
Path: v1/{+name}
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets an effective Event Threat Detection custom module at the given level.
▼ ▲ securitycenter.folders.eventThreatDetectionSettings.effectiveCustomModules.list
Path: v1/{+parent}/effectiveCustomModules
Flat Path: v1/folders/{foldersId}/eventThreatDetectionSettings/effectiveCustomModules
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^folders/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
pageToken
Description: A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
Location: query
Type: string
pageSize
Description: The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.validateCustomModule
Path: v1/{+parent}:validateCustomModule
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings:validateCustomModule
HTTP Method: POST
Parameters:
parent
Description: Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Validates the given Event Threat Detection custom module.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.customModules.create
Path: v1/{+parent}/customModules
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings/customModules
HTTP Method: POST
Parameters:
parent
Description: Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.customModules.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.customModules.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets an Event Threat Detection custom module.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.customModules.listDescendant
Path: v1/{+parent}/customModules:listDescendant
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings/customModules:listDescendant
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
pageToken
Description: A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
Location: query
Type: string
pageSize
Description: The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.customModules.list
Path: v1/{+parent}/customModules
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings/customModules
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
pageToken
Description: A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
Location: query
Type: string
pageSize
Description: The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.customModules.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: The list of fields to be updated. If empty all mutable fields will be updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.effectiveCustomModules.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets an effective Event Threat Detection custom module at the given level.
▼ ▲ securitycenter.projects.eventThreatDetectionSettings.effectiveCustomModules.list
Path: v1/{+parent}/effectiveCustomModules
Flat Path: v1/projects/{projectsId}/eventThreatDetectionSettings/effectiveCustomModules
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^projects/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
pageToken
Description: A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
Location: query
Type: string
pageSize
Description: The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
▼ ▲ securitycenter.organizations.eventThreatDetectionSettings.customModules.listDescendant
Path: v1/{+parent}/customModules:listDescendant
Flat Path: v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules:listDescendant
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^organizations/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
pageToken
Description: A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
Location: query
Type: string
pageSize
Description: The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
▼ ▲ securitycenter.organizations.eventThreatDetectionSettings.effectiveCustomModules.get
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
Pattern: ^organizations/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets an effective Event Threat Detection custom module at the given level.
▼ ▲ securitycenter.organizations.eventThreatDetectionSettings.effectiveCustomModules.list
Path: v1/{+parent}/effectiveCustomModules
Flat Path: v1/organizations/{organizationsId}/eventThreatDetectionSettings/effectiveCustomModules
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".
Pattern: ^organizations/[^/]+/eventThreatDetectionSettings$
Location: path
Required: Yes
Type: string
pageToken
Description: A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
Location: query
Type: string
pageSize
Description: The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.