REST Resource: projects.scanConfigs

Ressource : ScanConfig

Une ressource ScanConfig contient les configurations pour lancer une analyse.

Représentation 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
}
Champs
name

string

Nom de la ressource ScanConfig. Le nom suit le format "projects/{projectId}/scanConfigs/{scanConfigId}". Les ID de ressources ScanConfig sont générés par le système.
displayName

string

Obligatoire. Nom d'affichage fourni par l'utilisateur d'une ressource ScanConfig.
maxQps

integer

RPS maximal pendant l'analyse. Une valeur valide est comprise entre 5 et 20 inclus. Si le champ n'est pas spécifié ou si sa valeur est définie sur 0, le serveur définit la valeur par défaut sur 15. Les autres valeurs en dehors de la plage [5, 20] seront rejetées avec l'erreur INVALID_ARGUMENT.
startingUrls[]

string

Obligatoire. URL de démarrage à partir desquelles l'outil d'analyse trouve les pages du site.
authentication

object (Authentication)

Configuration de l'authentification. Si spécifié, le service utilisera la configuration d'authentification lors de l'analyse.
userAgent

enum (UserAgent)

User-agent utilisé lors de l'analyse.
blacklistPatterns[]

string

Formats d'URL exclus décrits dans la page https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls.
schedule

object (Schedule)

Calendrier de la ressource ScanConfig.
exportToSecurityCommandCenter

enum (ExportToSecurityCommandCenter)

Contrôle l'exportation des configurations et des résultats des analyses vers Security Command Center.
riskLevel

enum (RiskLevel)

Niveau de risque sélectionné pour l'analyse
managedScan

boolean

Indique si la configuration de l'analyse est gérée par Web Security Scanner (sortie uniquement).
staticIpScan

boolean

Indique si la configuration de l'analyse a activé la fonctionnalité d'analyse des adresses IP statiques. Si cette option est activée, l'outil d'analyse accède aux applications à partir d'adresses IP statiques.
ignoreHttpStatusErrors

boolean

Indique si l'analyse doit se poursuivre même si la plupart des requêtes renvoient des codes d'erreur HTTP.

Authentification

Analyse la configuration de l'authentification.

Représentation 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.
}
Champs
Champ d'union authentication. Obligatoire. La configuration de l'authentification authentication ne peut être que l'une des valeurs suivantes:
googleAccount
(deprecated)

object (GoogleAccount)

Authentification à l'aide d'un compte Google.
customAccount

object (CustomAccount)

Authentification à l'aide d'un compte personnalisé.
iapCredential

object (IapCredential)

Authentification à l'aide d'Identity-Aware Proxy (IAP)

GoogleAccount

Décrit la configuration de l'authentification utilisant un compte Google.

Représentation JSON 
{
  "username": string,
  "password": string
}
Champs
username

string

Obligatoire. Nom d'utilisateur du compte Google.
password

string

Obligatoire. Uniquement en entrée. Mot de passe du compte Google. Les identifiants sont stockés chiffrés et ne sont renvoyés dans aucune réponse, et ne sont pas inclus dans les journaux d'audit.

CustomAccount

Décrit la configuration de l'authentification utilisant un compte personnalisé.

Représentation JSON 
{
  "username": string,
  "password": string,
  "loginUrl": string
}
Champs
username

string

Obligatoire. Nom d'utilisateur du compte personnalisé.
password

string

Obligatoire. Uniquement en entrée. Mot de passe du compte personnalisé. Les identifiants sont stockés chiffrés et ne sont renvoyés dans aucune réponse, et ne sont pas inclus dans les journaux d'audit.
loginUrl

string

Obligatoire. URL du formulaire de connexion du site Web.

IapCredential

Décrit la configuration de l'authentification pour Identity-Aware Proxy (IAP).

Représentation 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.
}
Champs
Champ d'union iap_credentials. La configuration d'authentification Identity-Aware Proxy (IAP) iap_credentials ne peut être que l'un des éléments suivants:
iapTestServiceAccountInfo

object (IapTestServiceAccountInfo)

Configuration de l'authentification lorsque le compte de service Web-Security-Scanner est ajouté aux règles d'accès Identity-Aware-Proxy (IAP).

IapTestServiceAccountInfo

Décrit la configuration de l'authentification lorsque le compte de service Web-Security-Scanner est ajouté aux règles d'accès Identity-Aware-Proxy (IAP).

Représentation JSON 
{
  "targetAudienceClientId": string
}
Champs
targetAudienceClientId

string

Obligatoire. Décrit l'ID client OAuth2 des ressources protégées par Identity-Aware Proxy (IAP).

UserAgent

Type de user-agents utilisés pour l'analyse.

Enums
USER_AGENT_UNSPECIFIED Le user-agent est inconnu. Le service appliquera la valeur par défaut CHROME_LINUX.
CHROME_LINUX Chrome pour Linux. Ceci est le service par défaut si non spécifié.
CHROME_ANDROID Chrome pour Android.
SAFARI_IPHONE Safari pour iPhone.

Schedule

Configuration du calendrier d'analyse.

Représentation JSON 
{
  "scheduleTime": string,
  "intervalDurationDays": integer
}
Champs
scheduleTime

string (Timestamp format)

Horodatage indiquant l'heure à laquelle la prochaine exécution est programmée. La valeur est actualisée par le serveur après chaque exécution. Si elle n'est pas spécifiée, l'heure actuelle du serveur sera appliquée par défaut, ce qui signifie que l'analyse sera programmée pour démarrer immédiatement.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
intervalDurationDays

integer

Obligatoire. Durée entre les exécutions en jours.

ExportToSecurityCommandCenter

Contrôle l'exportation des configurations et des résultats des analyses vers Security Command Center.

Enums
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED Utilisez la valeur par défaut, qui est "ENABLED" (ACTIVATÉ).
ENABLED Exportez les résultats de cette analyse vers Security Command Center.
DISABLED N'exportez pas les résultats de cette analyse vers Security Command Center.

RiskLevel

Niveaux de risque d'analyse compatibles avec Web Security Scanner. L'analyse à faible impact minimise les requêtes susceptibles de modifier les données. Pour obtenir une couverture de numérisation maximale, nous vous recommandons de choisir le niveau de risque NORMAL.

Enums
RISK_LEVEL_UNSPECIFIED Utilisez la valeur par défaut, qui est "NORMAL".
NORMAL Analyse normale (recommandée)
LOW Analyse à faible impact

Méthodes

create

 Crée un ScanConfig.

delete

 Supprime une instance ScanConfig existante et ses ressources enfants.

get

 Permet d'obtenir une instance ScanConfig.

list

 Répertorie les ScanConfig dans un projet donné.

patch

 Met à jour un ScanConfig.

start

 Démarre un ScanRun en fonction de l'instance ScanConfig donnée.