REST Resource: projects.scanConfigs

Risorsa: ScanConfig

Una risorsa ScanConfig contiene le configurazioni per avviare una scansione.

Rappresentazione 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
}
Campi
name

string

Il nome della risorsa di ScanConfig. Il nome segue il formato "projects/{projectId}/scanConfigs/{scanConfigId}". Gli ID ScanConfig vengono generati dal sistema.
displayName

string

Obbligatorio. Il nome visualizzato della ScanConfig fornito dall'utente.
maxQps

integer

Il QPS massimo durante la scansione. Un valore valido va da 5 a 20 inclusi. Se il campo non è specificato o il relativo valore è impostato su 0, il server avrà un valore predefinito di 15. Gli altri valori al di fuori dell'intervallo [5, 20] verranno rifiutati con l'errore INVALID_ARGUMENT.
startingUrls[]

string

Obbligatorio. Gli URL di partenza da cui lo scanner trova le pagine del sito.
authentication

object (Authentication)

La configurazione dell'autenticazione. Se specificato, il servizio utilizzerà la configurazione di autenticazione durante la scansione.
userAgent

enum (UserAgent)

Lo user agent utilizzato durante la scansione.
blacklistPatterns[]

string

I pattern URL esclusi come descritto in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
schedule

object (Schedule)

La pianificazione di ScanConfig.
exportToSecurityCommandCenter

enum (ExportToSecurityCommandCenter)

Controlla l'esportazione delle configurazioni e dei risultati delle scansioni in Security Command Center.
riskLevel

enum (RiskLevel)

Il livello di rischio selezionato per la scansione
managedScan

boolean

Indica se la configurazione della scansione è gestita da Web Security Scanner, solo output.
staticIpScan

boolean

Indica se la configurazione della scansione ha attivato la funzionalità di scansione degli indirizzi IP statici. Se abilitato, lo scanner accederà alle applicazioni da indirizzi IP statici.
ignoreHttpStatusErrors

boolean

Indica se continuare la scansione anche se la maggior parte delle richieste restituisce codici di errore HTTP.

Autenticazione

Configura l'autenticazione della scansione.

Rappresentazione 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.
}
Campi
Campo unione authentication. Obbligatorio. La configurazione di autenticazione authentication può essere solo una delle seguenti:
googleAccount
(deprecated)

object (GoogleAccount)

Autenticazione tramite un Account Google.
customAccount

object (CustomAccount)

Autenticazione utilizzando un account personalizzato.
iapCredential

object (IapCredential)

Autenticazione tramite Identity-Aware Proxy (IAP).

AccountGoogle

Descrive la configurazione di autenticazione che utilizza un Account Google.

Rappresentazione JSON 
{
  "username": string,
  "password": string
}
Campi
username

string

Obbligatorio. Il nome utente dell'Account Google.
password

string

Obbligatorio. Solo input. La password dell'Account Google. La credenziale viene archiviata sotto forma criptata e non viene restituita in nessuna risposta né inclusa nei log di controllo.

CustomAccount

Descrive la configurazione di autenticazione che utilizza un account personalizzato.

Rappresentazione JSON 
{
  "username": string,
  "password": string,
  "loginUrl": string
}
Campi
username

string

Obbligatorio. Il nome utente dell'account personalizzato.
password

string

Obbligatorio. Solo input. La password dell'account personalizzato. La credenziale viene archiviata sotto forma criptata e non viene restituita in nessuna risposta né inclusa nei log di controllo.
loginUrl

string

Obbligatorio. L'URL del modulo di accesso del sito web.

IapCredential

Descrive la configurazione dell'autenticazione per Identity-Aware-Proxy (IAP).

Rappresentazione 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.
}
Campi
Campo unione iap_credentials. La configurazione dell'autenticazione Identity-Aware Proxy (IAP) iap_credentials può essere solo una delle seguenti:
iapTestServiceAccountInfo

object (IapTestServiceAccountInfo)

Configurazione dell'autenticazione quando l'account di servizio Web-Security-Scanner viene aggiunto nei criteri di accesso Identity-Aware-Proxy (IAP).

IapTestServiceAccountInfo

Descrive la configurazione dell'autenticazione quando l'account di servizio Web-Security-Scanner viene aggiunto nei criteri di accesso Identity-Aware-Proxy (IAP).

Rappresentazione JSON 
{
  "targetAudienceClientId": string
}
Campi
targetAudienceClientId

string

Obbligatorio. Descrive l'ID client OAuth2 delle risorse protette da Identity-Aware-Proxy (IAP).

UserAgent

Tipo di user agent utilizzati per la scansione.

Enum
USER_AGENT_UNSPECIFIED L'user agent è sconosciuto. Per impostazione predefinita, il servizio sarà CHROME_LINUX.
CHROME_LINUX Chrome su Linux. Si tratta del valore predefinito del servizio se non specificato.
CHROME_ANDROID Chrome su Android.
SAFARI_IPHONE Safari su iPhone.

Pianificazione

Configurazione della pianificazione della scansione.

Rappresentazione JSON 
{
  "scheduleTime": string,
  "intervalDurationDays": integer
}
Campi
scheduleTime

string (Timestamp format)

Un timestamp indica quando verrà pianificata la successiva esecuzione. Il valore viene aggiornato dal server dopo ogni esecuzione. Se non specificato, verrà utilizzato l'ora corrente del server, il che significa che la scansione verrà pianificata per iniziare immediatamente.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
intervalDurationDays

integer

Obbligatorio. La durata del tempo tra le esecuzioni in giorni.

ExportToSecurityCommandCenter

Controlla l'esportazione delle configurazioni e dei risultati delle scansioni in Security Command Center.

Enum
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED Utilizza il valore predefinito, ovvero ENABLED.
ENABLED Esporta i risultati di questa scansione in Security Command Center.
DISABLED Non esportare i risultati di questa scansione in Security Command Center.

RiskLevel

Livelli di rischio di scansione supportati da Web Security Scanner. La scansione con IMPATTO BASSO riduce al minimo le richieste con il potenziale di modificare i dati. Per ottenere la massima copertura della ricerca, è consigliato il livello di rischio NORMALE.

Enum
RISK_LEVEL_UNSPECIFIED Utilizza l'impostazione predefinita, che è NORMALE.
NORMAL Scansione normale (consigliata)
LOW Scansione a basso impatto

Metodi

create

 Crea un nuovo ScanConfig.

delete

 Consente di eliminare una ScanConfig esistente e le relative risorse figlio.

get

 Recupera un ScanConfig.

list

 Elenca ScanConfig in un determinato progetto.

patch

 Aggiorna un ScanConfig.

start

 Avvia una ScanRun in base alla ScanConfig specificata.