REST Resource: projects.scanConfigs

Recurso: ScanConfig

Um recurso ScanConfig contém as configurações para iniciar uma verificação.

Representação 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

O nome do recurso do ScanConfig. O nome segue o formato de 'projects/{projectId}/scanConfigs/{scanConfigId}'. Os códigos do ScanConfig são gerados pelo sistema.
displayName

string

Obrigatório. O usuário indicou o nome de exibição do ScanConfig.
maxQps

integer

O QPS máximo durante a verificação. Um valor válido entre 5 a 20, inclusive. Se o campo não for especificado ou seu valor for definido como 0, o servidor terá como padrão 15. Outros valores fora do intervalo [5, 20] serão rejeitados com o erro INVALID_ARGUMENT.
startingUrls[]

string

Obrigatório. Os URLs iniciais a partir de onde o scanner encontra as páginas do site.
authentication

object (Authentication)

A configuração de autenticação. Se especificada, o serviço usará a configuração de autenticação durante a verificação.
userAgent

enum (UserAgent)

O agente do usuário usado durante a verificação.
blacklistPatterns[]

string

Os padrões de URL excluídos, conforme descrito em https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
schedule

object (Schedule)

A programação do ScanConfig.
exportToSecurityCommandCenter

enum (ExportToSecurityCommandCenter)

Controla a exportação de configurações e resultados de verificação para o Security Command Center.
riskLevel

enum (RiskLevel)

O nível de risco selecionado para a verificação
managedScan

boolean

Indica se a configuração da verificação é gerenciada pelo Web Security Scanner, somente saída.
staticIpScan

boolean

Se a configuração de verificação ativou o recurso de verificação de endereço IP estático. Se ativada, o scanner vai acessar aplicativos de endereços IP estáticos.
ignoreHttpStatusErrors

boolean

Se a verificação deve continuar mesmo que a maioria das solicitações retorne códigos de erro HTTP.

Autenticação

Verifica a configuração de autenticação.

Representação 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ão authentication. Obrigatório. A configuração de autenticação authentication pode ser apenas uma das seguintes opções:
googleAccount
(deprecated)

object (GoogleAccount)

Autenticação usando uma conta do Google.
customAccount

object (CustomAccount)

Autenticação usando uma conta personalizada.
iapCredential

object (IapCredential)

Autenticação usando o Identity-Aware-Proxy (IAP).

GoogleAccount

Descreve a configuração de autenticação que usa uma conta do Google.

Representação JSON 
{
  "username": string,
  "password": string
}
Campos
username

string

Obrigatório. O nome de usuário da conta do Google.
password

string

Obrigatório. Somente entrada. A senha da conta do Google. A credencial é armazenada criptografada e não é retornada em respostas nem incluída em registros de auditoria.

CustomAccount

Descreve a configuração de autenticação que usa uma conta personalizada.

Representação JSON 
{
  "username": string,
  "password": string,
  "loginUrl": string
}
Campos
username

string

Obrigatório. O nome de usuário da conta personalizada.
password

string

Obrigatório. Somente entrada. A senha da conta personalizada. A credencial é armazenada criptografada e não é retornada em respostas nem incluída em registros de auditoria.
loginUrl

string

Obrigatório. O URL do formulário de login do site.

IapCredential

Descreve a configuração de autenticação para o Identity-Aware Proxy (IAP).

Representação 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ão iap_credentials. A configuração de autenticação do Identity-Aware Proxy (IAP) iap_credentials só pode ser uma das seguintes:
iapTestServiceAccountInfo

object (IapTestServiceAccountInfo)

Configuração de autenticação quando a conta de serviço do Web-Security-Scanner é adicionada às políticas de acesso do Identity-Aware-Proxy (IAP).

IapTestServiceAccountInfo

Descreve a configuração de autenticação quando a conta de serviço do Web-Security-Scanner é adicionada às políticas de acesso do Identity-Aware-Proxy (IAP).

Representação JSON 
{
  "targetAudienceClientId": string
}
Campos
targetAudienceClientId

string

Obrigatório. Descreve o ID do cliente OAuth2 de recursos protegidos pelo Identity-Aware Proxy (IAP).

UserAgent

Tipo de agentes do usuário usados para verificação.

Enums
USER_AGENT_UNSPECIFIED O agente do usuário é desconhecido. Por padrão, o serviço será padronizado em CHROME_LINUX.
CHROME_LINUX Chrome no Linux. Este é o padrão do serviço, se não for especificado.
CHROME_ANDROID Chrome no Android.
SAFARI_IPHONE Safari no iPhone.

Schedule

Verifica a configuração da programação.

Representação JSON 
{
  "scheduleTime": string,
  "intervalDurationDays": integer
}
Campos
scheduleTime

string (Timestamp format)

Um carimbo de data/hora indica quando a próxima execução será programada. O valor é atualizado pelo servidor após cada execução. Se não for especificado, o padrão será o horário atual do servidor, o que significa que a verificação será programada para iniciar imediatamente.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
intervalDurationDays

integer

Obrigatório. A duração entre as execuções em dias.

ExportToSecurityCommandCenter

Controla a exportação de configurações e resultados de verificação para o Security Command Center.

Enums
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED Use o padrão, que é ATIVADO.
ENABLED Exporte os resultados dessa verificação para o Security Command Center.
DISABLED Não exporte os resultados dessa verificação para o Security Command Center.

RiskLevel

Níveis de risco de verificação aceitos pelo Web Security Scanner. A verificação de impacto BAIXO minimiza as solicitações com potencial de modificar dados. Para alcançar a cobertura máxima de verificação, recomendamos o nível de risco NORMAL.

Enums
RISK_LEVEL_UNSPECIFIED Use o padrão, que é NORMAL.
NORMAL Verificação normal (recomendada)
LOW Verificação de baixo impacto

Métodos

create

 Cria um novo ScanConfig.

delete

 Exclui um ScanConfig existente e seus recursos filho.

get

 Recebe um ScanConfig.

list

 Lista ScanConfigs em um determinado projeto.

patch

 Atualiza um ScanConfig.

start

 Inicia um ScanRun de acordo com o ScanConfig fornecido.