REST Resource: projects.scanConfigs

Recurso: ScanConfig

Un recurso ScanConfig contiene las configuraciones para iniciar un análisis.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "maxQps": integer,
  "startingUrls": [
    string
  ],
  "authentication": {
    object (Authentication)
  },
  "userAgent": enum (UserAgent),
  "blacklistPatterns": [
    string
  ],
  "schedule": {
    object (Schedule)
  },
  "exportToSecurityCommandCenter": enum (ExportToSecurityCommandCenter),
  "riskLevel": enum (RiskLevel),
  "managedScan": boolean,
  "staticIpScan": boolean,
  "ignoreHttpStatusErrors": boolean
}
Campos
name

string

Es el nombre del recurso de ScanConfig. El nombre sigue el formato "projects/{projectId}/scanConfigs/{scanConfigId}". El sistema genera los IDs de ScanConfig.
displayName

string

Obligatorio. El nombre visible que el usuario proporcionó para ScanConfig.
maxQps

integer

Es la QPS máxima durante el análisis. Un valor válido varía de 5 a 20 inclusive. Si no se especifica el campo o se establece su valor en 0, el servidor se establecerá de forma predeterminada en 15. Los demás valores fuera del rango [5, 20] se rechazarán con el error INVALID_ARGUMENT.
startingUrls[]

string

Obligatorio. Son las URLs de inicio desde las que el escáner encuentra las páginas del sitio.
authentication

object (Authentication)

La configuración de autenticación Si se especifica, el servicio usará la configuración de autenticación durante el análisis.
userAgent

enum (UserAgent)

Es el usuario-agente que se usa durante el análisis.
blacklistPatterns[]

string

Los patrones de URL excluidos, como se describe en https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
schedule

object (Schedule)

Es el programa de ScanConfig.
exportToSecurityCommandCenter

enum (ExportToSecurityCommandCenter)

Controla la exportación de configuraciones y resultados de análisis a Security Command Center.
riskLevel

enum (RiskLevel)

El nivel de riesgo seleccionado para el análisis
managedScan

boolean

Indica si Web Security Scanner administra la configuración del análisis, solo salida.
staticIpScan

boolean

Indica si la configuración del análisis habilitó la función de análisis de direcciones IP estáticas. Si está habilitado, el escáner accederá a las aplicaciones desde direcciones IP estáticas.
ignoreHttpStatusErrors

boolean

Indica si se debe seguir realizando el análisis, incluso si la mayoría de las solicitudes muestran códigos de error HTTP.

Autenticación

Analiza la configuración de autenticación.

Representación JSON 
{

  // Union field authentication can be only one of the following:
  "googleAccount": {
    object (GoogleAccount)
  },
  "customAccount": {
    object (CustomAccount)
  },
  "iapCredential": {
    object (IapCredential)
  }
  // End of list of possible types for union field authentication.
}
Campos
Campo de unión authentication. Obligatorio. La configuración de autenticación authentication solo puede ser una de las siguientes opciones:
googleAccount
(deprecated)

object (GoogleAccount)

Autenticación con una Cuenta de Google
customAccount

object (CustomAccount)

Autenticación con una cuenta personalizada
iapCredential

object (IapCredential)

Autenticación con Identity-Aware-Proxy (IAP).

GoogleAccount

Describe la configuración de autenticación que usa una Cuenta de Google.

Representación JSON 
{
  "username": string,
  "password": string
}
Campos
username

string

Obligatorio. Es el nombre de usuario de la Cuenta de Google.
password

string

Obligatorio. Solo entrada. La contraseña de la Cuenta de Google. La credencial se almacena encriptada y no se muestra en ninguna respuesta ni se incluye en los registros de auditoría.

CustomAccount

Describe la configuración de autenticación que usa una cuenta personalizada.

Representación JSON 
{
  "username": string,
  "password": string,
  "loginUrl": string
}
Campos
username

string

Obligatorio. Es el nombre de usuario de la cuenta personalizada.
password

string

Obligatorio. Solo entrada. La contraseña de la cuenta personalizada. La credencial se almacena encriptada y no se muestra en ninguna respuesta ni se incluye en los registros de auditoría.
loginUrl

string

Obligatorio. La URL del formulario de acceso del sitio web.

IapCredential

Describe la configuración de autenticación para Identity-Aware-Proxy (IAP).

Representación JSON 
{

  // Union field iap_credentials can be only one of the following:
  "iapTestServiceAccountInfo": {
    object (IapTestServiceAccountInfo)
  }
  // End of list of possible types for union field iap_credentials.
}
Campos
Campo de unión iap_credentials. La configuración de autenticación de Identity-Aware-Proxy (IAP) iap_credentials solo puede ser una de las siguientes:
iapTestServiceAccountInfo

object (IapTestServiceAccountInfo)

Configuración de autenticación cuando se agrega la cuenta de servicio de Web-Security-Scanner en las políticas de acceso de Identity-Aware-Proxy (IAP).

IapTestServiceAccountInfo

Describe la configuración de autenticación cuando se agrega la cuenta de servicio de Web-Security-Scanner en las políticas de acceso de Identity-Aware-Proxy (IAP).

Representación JSON 
{
  "targetAudienceClientId": string
}
Campos
targetAudienceClientId

string

Obligatorio. Describe el ID de cliente de OAuth2 de los recursos protegidos por Identity-Aware-Proxy (IAP).

UserAgent

Es el tipo de usuario-agente que se usa para el análisis.

Enums
USER_AGENT_UNSPECIFIED El usuario-agente es desconocido. El servicio se establecerá de forma predeterminada en CHROME_LINUX.
CHROME_LINUX Chrome en Linux Esta es la configuración predeterminada del servicio si no se especifica.
CHROME_ANDROID Chrome en Android
SAFARI_IPHONE Safari en iPhone

Programar

Configuración del programa de análisis

Representación JSON 
{
  "scheduleTime": string,
  "intervalDurationDays": integer
}
Campos
scheduleTime

string (Timestamp format)

Una marca de tiempo indica cuándo se programará la próxima ejecución. El servidor actualiza el valor después de cada ejecución. Si no se especifica, se usará la hora actual del servidor, lo que significa que el análisis se programará para comenzar de inmediato.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
intervalDurationDays

integer

Obligatorio. Es la duración del tiempo entre ejecuciones en días.

ExportToSecurityCommandCenter

Controla la exportación de configuraciones y resultados de análisis a Security Command Center.

Enums
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED Usa la opción predeterminada, que está Habilitada.
ENABLED Exporta los resultados de este análisis a Security Command Center.
DISABLED No exportes los resultados de este análisis a Security Command Center.

RiskLevel

Niveles de riesgo de análisis compatibles con Web Security Scanner. El análisis de impacto BAJO minimizará las solicitudes con el potencial de modificar los datos. Para lograr la máxima cobertura de análisis, se recomienda el nivel de riesgo NORMAL.

Enums
RISK_LEVEL_UNSPECIFIED Usa la opción predeterminada, que es NORMAL.
NORMAL Análisis normal (recomendado)
LOW Análisis de menor impacto

Métodos

create

 Crea un nuevo ScanConfig.

delete

 Borra un ScanConfig existente y sus recursos secundarios.

get

 Obtiene un ScanConfig.

list

 Muestra una lista de ScanConfigs de un proyecto determinado.

patch

 Actualiza un ScanConfig.

start

 Inicia un ScanRun según la ScanConfig proporcionada.