Paramètres disponibles dans l'API

Ce document décrit les paramètres compatibles avec l'API Policy.

Si les paramètres compatibles sont absents de la réponse de l'API Cloud Identity Policy, consultez Valeurs de champ par défaut. Si le paramètre manquant n'est pas mentionné dans Valeurs par défaut des champs, contactez le service Cloud Customer Care.

Paramètres de l'agenda

Paramètres de chat

Paramètres Classroom

Paramètres de conformité des données

Paramètres de Drive et Docs

Paramètres de Gmail

Sous-paramètres Gmail

Ce tableau fournit les sous-paramètres Gmail auxquels d'autres paramètres Gmail font référence.

Paramètres Groups for Business

Mentions légales et conformité

Paramètres de Marketplace

Sous-paramètres Marketplace

Le paramètre workspace_marketplace.apps_allowlist dans la réponse de l'API expose le application_id Marketplace au lieu de application_name. Le script Python suivant peut être utilisé pour convertir un ou plusieurs fichiers application_id spécifiés sur la ligne de commande en fichiers application_name.

import re
import requests
import sys

output = {}
app_ids = sys.argv[1:]

for id in app_ids:
  url = f"https://workspace.google.com/marketplace/app/_/{id}"
  response = requests.get(url, allow_redirects=False)
  final_url = response.headers['Location']
  pattern = f"^https://workspace.google.com/marketplace/app/(.*)/{id}$"
  a = re.search(pattern, final_url)
  output[id] = a.group(1)

# Output application name captured from returned URL
print(output)

Paramètres Meet

Paramètres des règles et des détecteurs

Paramètres des règles de protection des données

Pour obtenir une présentation des règles et des détecteurs de protection des données, consultez Créer des règles de protection contre la perte de données pour Drive et des détecteurs de contenu personnalisés.

Déclencheurs

Liste des applications disponibles et de leurs déclencheurs.

• "google.workspace.chrome.file.v1.upload"
• "google.workspace.chrome.file.v1.download"
• "google.workspace.chrome.web_content.v1.upload"
• "google.workspace.chrome.page.v1.print"
• "google.workspace.chrome.url.v1.navigation"
• "google.workspace.chromeos.file.v1.transfer"
• "google.workspace.chat.message.v1.send"
• "google.workspace.chat.attachment.v1.upload"
• "google.workspace.drive.file.v1.share"
• "google.workspace.gmail.email.v1.send"

Conditions

Pour représenter les conditions de données, l'API utilise des expressions CEL (Common Expression Language). Chaque condition suit le format {content type}.{content to scan for}({additional scan parameters}). Par exemple, all_content.contains('apple') représente une condition de données qui correspond si l'un des contenus analysés (par exemple, un document Drive, un message de chat, etc.) contient la sous-chaîne apple.

Type de contenu

Liste des types de contenus disponibles, correspondant aux configurations du même nom dans la console d'administration.

• access_levels
• all_content
• all_headers
• body
• destination_type
• destination_url
• drive_enterprise_metadata
• encryption_state
• envelope_from
• file_size_in_bytes
• file_type
• from_header
• message_security_status
• request_attributes
• sender_header
• source_chrome_context
• source_url
• source_url_category
• subject
• suggestion
• target_user
• titre
• to_header_recipients
• url
• url_category

Contenu à rechercher

Liste des contenus disponibles à analyser, correspondant aux configurations portant le même nom dans la console d'administration.

• contains({string})
• starts_with({string})
• ends_with({string})
• equals({string})
• matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
  • Correspond à l'option Correspond à un type de données prédéfini dans la console d'administration.
  • {detector name} désigne le type de données prédéfini à analyser, qui peut être l'un des infoTypes intégrés compatibles avec Cloud DLP : https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. Par exemple, CREDIT_CARD_NUMBER ou US_SOCIAL_SECURITY_NUMBER
  • {likelihood} indique le seuil de probabilité de la correspondance. Par exemple, google.privacy.dlp.v2.Likelihood.LIKELY correspond au seuil Élevé dans la console d'administration.
• matches_regex_detector({detector name}, {minimum_match_count: {count}})
  • Correspond à l'option Correspond à l'expression régulière dans la console d'administration.
  • {detector name} est le nom de ressource de la règle qui représente le détecteur d'expressions régulières. Consultez la section Détecteur de protection des données pour savoir comment interroger les règles de détecteur dans l'API.
• matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
  • Correspond à l'option Correspond aux mots d'une liste de mots de la console d'administration.
  • {detector name} est le nom de ressource de la règle qui représente le détecteur de liste de mots. Consultez la section Détecteur de protection des données pour savoir comment interroger les règles de détecteur dans l'API.
• matches_web_category({category})
  • Correspond à l'option Catégories d'URL correspondantes dans la console d'administration pour le déclencheur "URL visitée" de Chrome.
  • {category} désigne la catégorie d'URL compatible avec la configuration de la console d'administration. Pour obtenir la liste des catégories disponibles et leurs représentations d'API, consultez Catégories d'URL.

Conditions composites

Plusieurs conditions de base peuvent être combinées avec les opérateurs AND (&&), OR (||) ou NOT (!) pour former une condition composite. Par exemple, "all_content.contains('apple') && all_content.contains('banana')" représente une condition qui correspond si l'un des contenus analysés contient les sous-chaînes "pomme" et "banane".

Actions

Chaque application spécifie l'action à effectuer lorsque la condition de données correspond dans un message imbriqué. Par exemple, { "driveAction" { "warnUser" { } } } représente une action Drive qui avertit les utilisateurs lorsqu'ils partagent des fichiers en externe. Voici les actions spécifiques à l'application disponibles :

Métadonnées spécifiques au type de règle

Cet attribut contient les métadonnées spécifiques au type de règle. Pour les règles de protection des données, il contient le niveau de gravité de l'événement d'alerte lorsque l'événement est signalé dans le tableau de bord de sécurité et le centre d'alerte. Voici un exemple de valeur de métadonnées représentant le niveau de gravité "FAIBLE" :

fields {
  key: "ruleTypeMetadata"
  value {
    struct_value {
      fields {
        key: "dlpRuleMetadata"
        value {
          struct_value {
            fields {
              key: "alertSeverity"
              value {
                string_value: "LOW"
              }
            }
          }
        }
      }
    }
  }
}

Paramètres des détecteurs de protection des données

Pour obtenir une présentation des règles et des détecteurs de protection des données, consultez Créer des règles de protection contre la perte de données pour Drive et des détecteurs de contenu personnalisés.

Paramètres des règles d'alerte définies par le système

Cette section décrit les règles d'alerte définies par le système Google Workspace. L'API ne renvoie que les alertes définies par le système et modifiées par l'administrateur par rapport à leur valeur par défaut.

Actions

Les règles d'alerte définies par le système comportent une seule action qui indique les paramètres de notification de l'alerte.

Paramètres de sécurité

Paramètres de l'état du service

Le paramètre service_status contient une valeur booléenne indiquant si un service est activé pour un certain OrgUnit ou Group.

L'API Policy est compatible avec les paramètres d'état du service pour les services Google Workspace, Services Google supplémentaires et IA générative listés dans la console d'administration.

Google Workspace

Services Google supplémentaires

IA générative

Paramètres de Google Sites

Paramètres UserTakeout