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)
  },
  "targetPlatforms": [
    enum (TargetPlatform)
  ],
  "exportToSecurityCommandCenter": enum (ExportToSecurityCommandCenter),
  "latestRun": {
    object (ScanRun)
  },
  "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의 일정입니다.
targetPlatforms[]

enum (TargetPlatform)

스캔의 대상이 되는 Google Cloud Platform의 집합입니다. 비워 두면 APP_ENGINE이 기본값으로 사용됩니다.
exportToSecurityCommandCenter

enum (ExportToSecurityCommandCenter)

Security Command Center로의 스캔 구성 및 결과 내보내기를 제어합니다.
latestRun

object (ScanRun)

가능한 경우 최신 ScanRun입니다.
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)

IAP (Identity-Aware Proxy)를 사용한 인증

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

IAP (Identity-Aware Proxy)의 인증 구성을 설명합니다.

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. IAP (Identity-Aware Proxy) 인증 구성 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 Linux용 Chrome 지정하지 않으면 서비스 기본값입니다.
CHROME_ANDROID Android의 Chrome
SAFARI_IPHONE iPhone의 Safari

일정

스캔 일정 구성

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

필수 입력란입니다. 실행 간격(일 수)입니다.

TargetPlatform

Web Security Scanner에서 지원하는 Google Cloud 플랫폼

열거형
TARGET_PLATFORM_UNSPECIFIED 대상 플랫폼을 알 수 없습니다. 이 enum 값이 포함된 요청은 INVALID_ARGUMENT 오류와 함께 거부됩니다.
APP_ENGINE Google App Engine 서비스
COMPUTE Google Compute Engine 서비스
CLOUD_RUN Google Cloud Run 서비스
CLOUD_FUNCTIONS Google Cloud 함수 서비스

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을 시작합니다.