REST Resource: projects.scanConfigs

Resource: ScanConfig

Resource ScanConfig berisi konfigurasi untuk meluncurkan pemindaian.

Representasi 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
}
Kolom
name

string

Nama resource ScanConfig. Nama mengikuti format 'projects/{projectId}/scanConfigs/{scanConfigId}'. ID ScanConfig dibuat oleh sistem.
displayName

string

Wajib. Nama tampilan ScanConfig yang diberikan pengguna.
maxQps

integer

QPS maksimum selama pemindaian. Nilai yang valid berkisar antara 5 hingga 20 secara inklusif. Jika kolom tidak ditentukan atau nilainya ditetapkan ke 0, server akan ditetapkan secara default ke 15. Nilai lain di luar rentang [5, 20] akan ditolak dengan error INVALID_ARGUMENT.
startingUrls[]

string

Wajib. URL awal tempat pemindai menemukan halaman situs.
authentication

object (Authentication)

Konfigurasi autentikasi. Jika ditentukan, layanan akan menggunakan konfigurasi autentikasi selama pemindaian.
userAgent

enum (UserAgent)

Agen pengguna yang digunakan selama pemindaian.
blacklistPatterns[]

string

Pola URL yang dikecualikan seperti yang dijelaskan di https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
schedule

object (Schedule)

Jadwal ScanConfig.
exportToSecurityCommandCenter

enum (ExportToSecurityCommandCenter)

Mengontrol ekspor konfigurasi dan hasil pemindaian ke Security Command Center.
riskLevel

enum (RiskLevel)

Tingkat risiko yang dipilih untuk pemindaian
managedScan

boolean

Apakah konfigurasi pemindaian dikelola oleh Web Security Scanner, hanya output.
staticIpScan

boolean

Apakah konfigurasi pemindaian telah mengaktifkan fitur pemindaian alamat IP statis. Jika diaktifkan, pemindai akan mengakses aplikasi dari alamat IP statis.
ignoreHttpStatusErrors

boolean

Apakah akan terus memindai meskipun sebagian besar permintaan menampilkan kode error HTTP.

Autentikasi

Memindai konfigurasi autentikasi.

Representasi 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.
}
Kolom
Kolom union authentication. Wajib. Konfigurasi autentikasi authentication hanya dapat berupa salah satu dari hal berikut:
googleAccount
(deprecated)

object (GoogleAccount)

Autentikasi menggunakan Akun Google.
customAccount

object (CustomAccount)

Autentikasi menggunakan akun kustom.
iapCredential

object (IapCredential)

Autentikasi menggunakan Identity-Aware-Proxy (IAP).

GoogleAccount

Menjelaskan konfigurasi autentikasi yang menggunakan Akun Google.

Representasi JSON 
{
  "username": string,
  "password": string
}
Kolom
username

string

Wajib. Nama pengguna akun Google.
password

string

Wajib. Hanya input. Sandi Akun Google. Kredensial disimpan dalam bentuk terenkripsi dan tidak ditampilkan dalam respons apa pun atau disertakan dalam log audit.

CustomAccount

Menjelaskan konfigurasi autentikasi yang menggunakan akun kustom.

Representasi JSON 
{
  "username": string,
  "password": string,
  "loginUrl": string
}
Kolom
username

string

Wajib. Nama pengguna akun kustom.
password

string

Wajib. Hanya input. Sandi akun kustom. Kredensial disimpan dalam bentuk terenkripsi dan tidak ditampilkan dalam respons apa pun atau disertakan dalam log audit.
loginUrl

string

Wajib. URL formulir login situs.

IapCredential

Menjelaskan konfigurasi autentikasi untuk Identity-Aware-Proxy (IAP).

Representasi 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.
}
Kolom
Kolom union iap_credentials. Konfigurasi Autentikasi Identity-Aware-Proxy (IAP) iap_credentials hanya dapat berupa salah satu dari berikut ini:
iapTestServiceAccountInfo

object (IapTestServiceAccountInfo)

Konfigurasi autentikasi saat akun layanan Web-Security-Scanner ditambahkan dalam kebijakan akses Identity-Aware-Proxy (IAP).

IapTestServiceAccountInfo

Menjelaskan konfigurasi autentikasi saat akun layanan Web-Security-Scanner ditambahkan dalam kebijakan akses Identity-Aware-Proxy (IAP).

Representasi JSON 
{
  "targetAudienceClientId": string
}
Kolom
targetAudienceClientId

string

Wajib. Menjelaskan client ID OAuth2 dari resource yang dilindungi oleh Identity-Aware-Proxy (IAP).

UserAgent

Jenis agen pengguna yang digunakan untuk pemindaian.

Enum
USER_AGENT_UNSPECIFIED Agen pengguna tidak diketahui. Layanan akan ditetapkan secara default ke CHROME_LINUX.
CHROME_LINUX Chrome di Linux. Ini adalah setelan default layanan jika tidak ditentukan.
CHROME_ANDROID Chrome di Android.
SAFARI_IPHONE Safari di iPhone.

Jadwal

Memindai konfigurasi jadwal.

Representasi JSON 
{
  "scheduleTime": string,
  "intervalDurationDays": integer
}
Kolom
scheduleTime

string (Timestamp format)

Stempel waktu menunjukkan kapan operasi berikutnya akan dijadwalkan. Nilai diperbarui oleh server setelah setiap operasi dijalankan. Jika tidak ditentukan, setelan default-nya adalah waktu server saat ini, yang berarti pemindaian akan dijadwalkan untuk segera dimulai.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
intervalDurationDays

integer

Wajib. Durasi waktu antar-eksekusi dalam hari.

ExportToSecurityCommandCenter

Mengontrol ekspor konfigurasi dan hasil pemindaian ke Security Command Center.

Enum
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED Gunakan default, yang DIAKTIFKAN.
ENABLED Mengekspor hasil pemindaian ini ke Security Command Center.
DISABLED Jangan ekspor hasil pemindaian ini ke Security Command Center.

RiskLevel

Tingkat risiko pemindaian yang didukung oleh Web Security Scanner. Pemindaian dampak RENDAH akan meminimalkan permintaan dengan potensi untuk mengubah data. Untuk mencapai cakupan pemindaian maksimum, sebaiknya gunakan tingkat risiko NORMAL.

Enum
RISK_LEVEL_UNSPECIFIED Gunakan default, yaitu NORMAL.
NORMAL Pemindaian normal (Direkomendasikan)
LOW Pemindaian dengan dampak lebih rendah

Metode

create

 Membuat ScanConfig baru.

delete

 Menghapus ScanConfig yang ada dan resource turunannya.

get

 Mendapatkan ScanConfig.

list

 Mencantumkan ScanConfigs dalam project tertentu.

patch

 Memperbarui ScanConfig.

start

 Memulai Proses Pemindaian sesuai dengan ScanConfig yang diberikan.