REST Resource: projects.scanConfigs

Ressource: ScanConfig

Eine ScanConfig-Ressource enthält die Konfigurationen zum Starten eines Scans.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "maxQps": integer,
  "startingUrls": [
    string
  ],
  "authentication": {
    object (Authentication)
  },
  "userAgent": enum (UserAgent),
  "blacklistPatterns": [
    string
  ],
  "schedule": {
    object (Schedule)
  },
  "targetPlatforms": [
    enum (TargetPlatform)
  ],
  "exportToSecurityCommandCenter": enum (ExportToSecurityCommandCenter),
  "latestRun": {
    object (ScanRun)
  },
  "riskLevel": enum (RiskLevel),
  "managedScan": boolean,
  "staticIpScan": boolean,
  "ignoreHttpStatusErrors": boolean
}
Felder
name

string

Der Ressourcenname der ScanConfig. Der Name hat das Format "projects/{projectId}/scanConfigs/{scanConfigId}". Die ScanConfig-IDs werden vom System generiert.
displayName

string

Erforderlich. Der vom Nutzer angegebene Anzeigename der ScanConfig.
maxQps

integer

Maximale Anzahl der Abfragen pro Sekunde während des Scans. Ein gültiger Wert liegt zwischen 5 und 20 (inklusive). Wenn das Feld nicht angegeben oder der Wert 0 ist, verwendet der Server standardmäßig 15. Andere Werte außerhalb des Bereichs [5, 20] werden mit dem Fehler INVALID_ARGUMENT abgewiesen.
startingUrls[]

string

Erforderlich. Die Start-URLs, von der aus der Scanner alle anderen Websites aufrufen kann.
authentication

object (Authentication)

Die Authentifizierungskonfiguration. Wenn angegeben, verwendet der Dienst während des Scans die Authentifizierungskonfiguration.
userAgent

enum (UserAgent)

Der User-Agent, der während des Scans verwendet wurde.
blacklistPatterns[]

string

Die ausgeschlossenen URL-Muster gemäß https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
schedule

object (Schedule)

Der Zeitplan der ScanConfig.
targetPlatforms[]

enum (TargetPlatform)

Google Cloud-Plattformen, auf die die Prüfung ausgerichtet ist. Wenn leer, wird APP_ENGINE als Standard verwendet.
exportToSecurityCommandCenter

enum (ExportToSecurityCommandCenter)

Steuert den Export von Scankonfigurationen und -ergebnissen in das Security Command Center.
latestRun

object (ScanRun)

Aktueller ScanRun, falls verfügbar.
riskLevel

enum (RiskLevel)

Die für den Scan ausgewählte Risikostufe
managedScan

boolean

Gibt an, ob die Scankonfiguration von Web Security Scanner verwaltet wird. Nur Ausgabe.
staticIpScan

boolean

Gibt an, ob in der Scankonfiguration die Funktion zum Scannen statischer IP-Adressen aktiviert ist. Wenn diese Option aktiviert ist, greift der Scanner von statischen IP-Adressen auf Anwendungen zu.
ignoreHttpStatusErrors

boolean

Ob der Scan fortgesetzt werden soll, auch wenn die meisten Anfragen HTTP-Fehlercodes zurückgeben.

Authentifizierung

Authentifizierungskonfiguration scannen.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld authentication Pflichtangabe. Für die Authentifizierungskonfiguration authentication ist nur einer der folgenden Werte zulässig:
googleAccount
(deprecated)

object (GoogleAccount)

Authentifizierung mit einem Google-Konto.
customAccount

object (CustomAccount)

Authentifizierung mit einem benutzerdefinierten Konto.
iapCredential

object (IapCredential)

Authentifizierung mit Identity-Aware Proxy (IAP)

Google-Konto

Beschreibt die Authentifizierungskonfiguration, die ein Google-Konto verwendet.

JSON-Darstellung 
{
  "username": string,
  "password": string
}
Felder
username

string

Erforderlich. Der Nutzername des Google-Kontos.
password

string

Pflichtangabe. Nur Eingabe. Das Passwort des Google-Kontos. Die Anmeldedaten werden verschlüsselt gespeichert und weder in einer Antwort zurückgegeben noch in Audit-Logs gespeichert.

Nutzerkonto

Beschreibt die Authentifizierungskonfiguration, die ein benutzerdefiniertes Konto verwendet.

JSON-Darstellung 
{
  "username": string,
  "password": string,
  "loginUrl": string
}
Felder
username

string

Erforderlich. Der Nutzername des benutzerdefinierten Kontos.
password

string

Pflichtangabe. Nur Eingabe. Das Passwort des benutzerdefinierten Kontos. Die Anmeldedaten werden verschlüsselt gespeichert und weder in einer Antwort zurückgegeben noch in Audit-Logs gespeichert.
loginUrl

string

Erforderlich. Die Login-URL der Website.

IapCredential

Hier wird die Authentifizierungskonfiguration für Identity-Aware Proxy (IAP) beschrieben.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld iap_credentials. Die Konfiguration der IAP-Authentifizierung (Identity-Aware Proxy) iap_credentials kann nur eine der folgenden Optionen sein:
iapTestServiceAccountInfo

object (IapTestServiceAccountInfo)

Authentifizierungskonfiguration, wenn das Web Security Scanner-Dienstkonto in den Zugriffsrichtlinien für Identity-Aware Proxy (IAP) hinzugefügt wird.

IapTestServiceAccountInfo

Hier wird die Authentifizierungskonfiguration beschrieben, wenn das Web Security Scanner-Dienstkonto in den Zugriffsrichtlinien für Identity-Aware Proxy (IAP) hinzugefügt wird.

JSON-Darstellung 
{
  "targetAudienceClientId": string
}
Felder
targetAudienceClientId

string

Pflichtangabe. Beschreibt die OAuth2-Client-ID von Ressourcen, die durch Identity-Aware Proxy(IAP) geschützt sind.

User-Agent

Arten von User-Agents, die für das Scannen verwendet werden.

Enums
USER_AGENT_UNSPECIFIED Der User-Agent ist unbekannt. Der Dienst verwendet standardmäßig CHROME_LINUX.
CHROME_LINUX Chrome unter Linux. Wenn nicht angegeben, ist dies der Standardwert des Dienstes.
CHROME_ANDROID Chrome für Android.
SAFARI_IPHONE Safari auf dem iPhone.

Planen

Zeitplan der Scankonfiguration.

JSON-Darstellung 
{
  "scheduleTime": string,
  "intervalDurationDays": integer
}
Felder
scheduleTime

string (Timestamp format)

Ein Zeitstempel zeigt an, für wann die nächste Ausführung geplant ist. Der Wert wird nach jeder Ausführung vom Server aktualisiert. Wenn nicht angegeben, wird standardmäßig die aktuelle Serverzeit verwendet. Dies bedeutet, dass der Scan planmäßig sofort gestartet wird.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
intervalDurationDays

integer

Pflichtangabe. Die Zeitspanne zwischen den Ausführungen in Tagen.

Zielplattform

Von Web Security Scanner unterstützte Google Cloud-Plattformen

Enums
TARGET_PLATFORM_UNSPECIFIED Die Zielplattform ist unbekannt. Anfragen mit diesem Enum werden mit dem Fehler INVALID_ARGUMENT abgewiesen.
APP_ENGINE Google App Engine (Dienst).
COMPUTE Google Compute Engine (Dienst).
CLOUD_RUN Google Cloud Run-Dienst
CLOUD_FUNCTIONS Google Cloud Functions-Dienst

Export in das Security Command Center

Steuert den Export von Scankonfigurationen und -ergebnissen in das Security Command Center.

Enums
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED Verwenden Sie den Standardwert AKTIVIERT.
ENABLED Exportieren Sie diese Scanergebnisse in das Security Command Center.
DISABLED Exportieren Sie keine Ergebnisse dieses Scans in das Security Command Center.

RiskLevel

Scanrisikostufen, die vom Web Security Scanner unterstützt werden. Bei einem Scan mit GERINGER Auswirkung werden Anfragen minimiert, die Daten möglicherweise ändern. Für die maximale Abdeckung wird das Risikoniveau „NORMAL“ empfohlen.

Enums
RISK_LEVEL_UNSPECIFIED Verwenden Sie den Standardwert „NORMAL“.
NORMAL Normaler Scan (empfohlen)
LOW Scannen mit geringerer Auswirkung

Methoden

create

 Erstellt eine neue ScanConfig.

delete

 Löscht eine vorhandene ScanConfig und alle untergeordneten Ressourcen.

get

 Ruft eine ScanConfig ab.

list

 Listet ScanConfigs unter einem bestimmten Projekt auf.

patch

 Aktualisiert eine ScanConfig.

start

 Startet einen ScanRun gemäß der angegebenen ScanConfig.