REST Resource: projects.scanConfigs

リソース: ScanConfig

ScanConfig リソースには、スキャンを開始する構成が含まれています。

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
}
フィールド
name

string

ScanConfig のリソース名。名前は「projects/{projectId}/scanConfigs/{scanConfigId}」の形式に従います。ScanConfig ID はシステムによって生成されます。
displayName

string

必須。ユーザーが指定する ScanConfig の表示名。
maxQps

integer

スキャン中の最大 QPS。有効な値の範囲は 5〜20 です。フィールドが指定されていないか、値が 0 に設定されている場合、サーバーのデフォルトは 15 になります。[5, 20] の範囲外となる他の値は INVALID_ARGUMENT エラーで拒否されます。
startingUrls[]

string

必須。スキャナがサイトページを検出する開始 URL。
authentication

object (Authentication)

認証構成。指定されている場合、サービスはスキャン中に認証構成を使用します。
userAgent

enum (UserAgent)

スキャン時に使用されたユーザー エージェント。
blacklistPatterns[]

string

https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls で説明されている除外 URL パターン。
schedule

object (Schedule)

ScanConfig のスケジュール。
exportToSecurityCommandCenter

enum (ExportToSecurityCommandCenter)

スキャン構成と結果を Security Command Center にエクスポートするかどうかを制御します。
riskLevel

enum (RiskLevel)

スキャンに選択したリスクレベル
managedScan

boolean

スキャン構成が Web Security Scanner によって管理されているかどうか。出力のみ。
staticIpScan

boolean

スキャン構成で静的 IP アドレス スキャン機能が有効になっているかどうか。有効にすると、スキャナは静的 IP アドレスからアプリケーションにアクセスします。
ignoreHttpStatusErrors

boolean

ほとんどのリクエストが HTTP エラーコードを返してもスキャンを続行するかどうか。

認証

認証構成をスキャンします。

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.
}
フィールド
共用体フィールド authentication。必須。認証構成 authentication は次のいずれかになります。
googleAccount
(deprecated)

object (GoogleAccount)

Google アカウントを使用した認証。
customAccount

object (CustomAccount)

カスタム アカウントを使用した認証。
iapCredential

object (IapCredential)

Identity-Aware-Proxy（IAP）を使用した認証。

GoogleAccount

Google アカウントを使用する認証構成を説明します。

JSON 表現 
{
  "username": string,
  "password": string
}
フィールド
username

string

必須。Google アカウントのユーザー名。
password

string

必須。入力のみのGoogle アカウントのパスワード。認証情報は暗号化されて保存され、レスポンスで返されたり監査ログに含まれたりはしません。

CustomAccount

カスタム アカウントを使用する認証構成を説明します。

JSON 表現 
{
  "username": string,
  "password": string,
  "loginUrl": string
}
フィールド
username

string

必須。カスタム アカウントのユーザー名。
password

string

必須。入力のみのカスタム アカウントのパスワード。認証情報は暗号化されて保存され、レスポンスで返されたり監査ログに含まれたりはしません。
loginUrl

string

必須。ウェブサイトのログイン フォームの URL。

IapCredential

Identity-Aware Proxy（IAP）の認証構成について説明します。

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.
}
フィールド
共用体フィールド iap_credentials。Identity-Aware-Proxy（IAP）認証構成 iap_credentials は、次のいずれかになります。
iapTestServiceAccountInfo

object (IapTestServiceAccountInfo)

Identity-Aware-Proxy（IAP）アクセス ポリシーに Web-Security-Scanner サービス アカウントが追加された場合の認証構成。

IapTestServiceAccountInfo

Identity-Aware-Proxy（IAP）アクセス ポリシーで Web-Security-Scanner サービス アカウントが追加された場合の認証構成について説明します。

JSON 表現 
{
  "targetAudienceClientId": string
}
フィールド
targetAudienceClientId

string

必須。Identity-Aware-Proxy（IAP）で保護されたリソースの OAuth2 クライアント ID について説明します。

UserAgent

スキャンに使用されるユーザー エージェントのタイプ。

列挙値
USER_AGENT_UNSPECIFIED ユーザー エージェントは不明です。サービスはデフォルトで CHROME_LINUX になります。
CHROME_LINUX Chrome（Linux）。指定されていない場合のサービスのデフォルトです。
CHROME_ANDROID Chrome（Android）。
SAFARI_IPHONE Safari（iPhone）。

Schedule

スキャン スケジュールの構成。

JSON 表現 
{
  "scheduleTime": string,
  "intervalDurationDays": integer
}
フィールド
scheduleTime

string (Timestamp format)

次の実行がいつスケジュールされるかを示すタイムスタンプ。値は、各実行後にサーバーによって更新されます。指定されていない場合は、デフォルトで現在のサーバー時間になります。つまり、スキャンはすぐに開始されるようスケジュールされます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
intervalDurationDays

integer

必須。実行の間隔（日数）。

ExportToSecurityCommandCenter

スキャン構成と結果を Security Command Center にエクスポートするかどうかを制御します。

列挙型
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED デフォルト（ENABLED）を使用します。
ENABLED このスキャンの結果を Security Command Center にエクスポートします。
DISABLED このスキャンの結果を Security Command Center にエクスポートしないでください。

RiskLevel

Web Security Scanner でサポートされているスキャン リスクレベル。影響の少ないスキャンでは、データを変更する可能性のあるリクエストを最小限に抑えます。スキャン範囲を最大限にするには、リスクレベルを [NORMAL] にすることをおすすめします。

列挙型
RISK_LEVEL_UNSPECIFIED デフォルト（NORMAL）を使用します。
NORMAL 通常のスキャン（推奨）
LOW 影響の少ないスキャン

メソッド

create

 新しい ScanConfig を作成します。

delete

 既存の ScanConfig とその子リソースを削除します。

get

 ScanConfig を取得します。

list

 指定されたプロジェクトの ScanConfigs を一覧表示します。

patch

 ScanConfig を更新します。

start

 指定された ScanConfig に従って ScanRun を開始します。