Paramètres disponibles dans l'API

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

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

Paramètres de sécurité

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Récupération de compte Récupération de compte super-administrateur security.super_admin_account_recovery Autoriser les super-administrateurs à récupérer leur compte enableAccountRecovery Booléen
Récupération de compte utilisateur security.user_account_recovery Autoriser les utilisateurs autres que les super-administrateurs à récupérer leur compte enableAccountRecovery Booléen
Gestion des mots de passe Gestion des mots de passe security.password Expiration expirationDuration Secondes (0 secondes signifie "Ne jamais expirer")
Reuse allowReuse Booléen
Application des règles de longueur et de niveau de sécurité des mots de passe enforceRequirementsAtLogin Booléen
Longueur (longueur maximale) maximumLength Integer
Longueur (longueur minimale) minimumLength Integer
Force allowedStrength Enum :
  • STRONG
  • WEAK
Google Session Control Contrôle de session security.session_controls Durée de la session Web webSessionDuration Secondes
Applications moins sécurisées Applications moins sécurisées security.less_secure_apps Contrôlez l'accès des utilisateurs aux applications qui utilisent une technologie de connexion moins sécurisée, qui rend les comptes plus vulnérables. allowLessSecureApps Booléen
Questions d'authentification à la connexion Questions d'authentification à la connexion security.login_challenges Utiliser l'ID des collaborateurs pour renforcer la sécurité des comptes utilisateur enableEmployeeIdChallenge Booléen
Programme Protection Avancée Inscription security.advanced_protection_program Utiliser l'ID des collaborateurs pour renforcer la sécurité des comptes utilisateur enableAdvancedProtectionSelfEnrollment Booléen
Codes de sécurité securityCodeOption Enum :
  • ALLOWED_WITH_REMOTE_ACCESS
  • ALLOWED_WITHOUT_REMOTE_ACCESS
  • CODES_NOT_ALLOWED
Validation en deux étapes Authentification security.two_step_verification_enrollment Autoriser les utilisateurs à activer la validation en deux étapes allowEnrollment Booléen
security.two_step_verification_enforcement Application enforcedFrom Horodatage
security.two_step_verification_grace_period Délai d'inscription pour les nouveaux utilisateurs enrollmentGracePeriod Durée
security.two_step_verification_device_trust Autoriser l'utilisateur à approuver l'appareil allowTrustingDevice Booléen
security.two_step_verification_enforcement_factor Méthodes allowedSignInFactorSet Enum :
  • ALL
  • PASSKEY_ONLY
  • PASSKEY_PLUS_SECURITY_CODE
  • PASSKEY_PLUS_IP_BOUND_SECURITY_CODE
  • NO_TELEPHONY
security.two_step_verification_sign_in_code Délai de grâce pour la suspension de la règle de validation en deux étapes backupCodeExceptionPeriod Durée

Paramètres UserTakeout

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Données Importation et exportation de données > Google Takeout > Accès utilisateur à Takeout pour les services Google
  • blogger.user_takeout
  • books.user_takeout
  • maps.user_takeout
  • pay.user_takeout
  • photos.user_takeout
  • play.user_takeout
  • play_console.user_takeout
  • location_history.user_takeout
  • youtube.user_takeout
 Gérer l'accès des utilisateurs à Takeout pour les services Google takeout_status Enum :
  • TAKEOUT_STATUS_UNSPECIFIED
  • ENABLED
  • DISABLED

Paramètres de Marketplace

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Liste des applications Liste des applications workspace_marketplace.apps_allowlist Affichage des applications pour les utilisateurs de toutes les unités organisationnelles d'e-commerce Liste des applications contenant application_id et dont l'état d'accès est ALLOWED ou BLOCKED.
Paramètres Gérer l'accès aux applications > Gérer l'accès à la liste d'autorisation Google Workspace Marketplace workspace_marketplace.apps_access_options Sélectionnez les applications Marketplace que les utilisateurs peuvent exécuter et installer. access_level Enum :
  • ALLOW_ALL
  • ALLOW_LISTED_APPS
  • ALLOW_NONE

Le paramètre workspace_marketplace.apps_allowlist dans la réponse de l'API expose la place de marché application_id au lieu de application_name. Le script Python suivant peut être utilisé pour convertir un ou plusieurs application_id spécifiés sur la ligne de commande en 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 du statut du service

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

L'API Policy prend en charge les paramètres d'état des services pour les services Workspace et les services supplémentaires listés dans la console d'administration sous Applications.

Nom du service dans la console d'administration Nom du service de l'API Policy
Agenda calendrier
Cloud Search cloud_search
Drive et Docs drive_and_editors
Currents courants
Groups for Business groups_for_business
Jamboard jamboard
Keep keep
Google Chat chat
Google Meet meet
Google Voice voix
Google Sites sites
Tâches tasks
Vault vault
Work Insights work_insights
AppSheet AppSheet
Applied Digital Skills applied_digital_skills
Devoirs devoirs
Blogger blogger
Comptes de marque brand_accounts
Campaign Manager 360 campaign_manager
Chrome Dessin chrome_canvas
Bureau à distance Chrome chrome_remote_desktop
Chrome Web Store chrome_web_store
En salle classroom
CS First cs_first
Applications expérimentales experimental_apps
FeedBurner feedburner
Google Ad Manager ad_manager
Google Ads ads
Google AdSense adsense
Google Alertes alertes
Google Analytics avancées
Google Arts & Culture arts_and_culture
Google Favoris Favoris
Google Livres livres
Synchronisation Google Chrome chrome_sync
Google Cloud cloud
Google Cloud Print cloud_print
Google Colab colab
Développeur Google développeurs
Google Domains domaines
Google Earth terre
Google Fi fi
Google Groupes groupes
Google Maps cartes
Google Messages messages
Google My Business my_business
Google My Maps my_maps
Google Actualités news
Google Pay payer
Google Photos photos
Google Play lire
Google Play Console play_console
Google Public Data Explorer public_data
Google Read Along read_along
Google Search Console search_console
Google Takeout à emporter
Google Traduction translate
Google Trips trajets
Location History location_history
Looker Studio data_studio
Managed Google Play managed_play
Material Gallery material_gallery
Merchant Center merchant_center
Partner Dash partner_dash
Pinpoint identifier précisément
Centre des partenaires Play Livres play_books_partner_center
Programmable Search Engine programmable_search_engine
Question Hub question_hub
Profils Google Scholar scholar_profiles
Search Ads 360 search_ads_360
Recherche et Assistant search_and_assistant
Socratic socratic
Studio studio
Sauvegardes d'applications tierces third_party_app_backups
Tour Creator tour_creator
YouTube youtube
Autres services sans contrôle individuel enterprise_service_restrictions
Application Gemini gemini
Applications en accès anticipé early_access_apps
AI Studio ai_studio
Chrome Cursive chrome_cursive
NotebookLM notebooklm

Paramètres Gmail

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Gmail Paramètres utilisateur > Modèle confidentiel gmail.confidential_mode Activer le mode confidentiel enable_confidential_mode booléen
Paramètres utilisateur > S/MIME gmail.enhanced_smime_encryption Autoriser les utilisateurs à importer leurs propres certificats allow_user_to_upload_certificates booléen
Acceptez ces autres certificats racines pour des domaines spécifiques: custom_root_certificates Liste de CustomRootCertificates contenant une liste de certificats racine, une liste de certificats d'autorité de certification intermédiaires, une liste de noms de domaine restreints, une valeur booléenne permettant d'accepter les différences d'adresse et une énumération avec différents niveaux de validation.
Spam, hameçonnage et logiciels malveillants > Analyse améliorée des messages avant distribution gmail.enhanced_pre_delivery_message_scanning Améliore la détection des contenus suspects avant leur diffusion enable_improved_suspicious_content_detection booléen
Spam, hameçonnage et logiciels malveillants > Liste d'autorisation de messagerie gmail.email_spam_filter_ip_allowlist Saisir les adresses IP pour votre liste d'autorisation de messagerie allowed_ip_addresses Une liste de chaînes
Sécurité > Spoofing et authentification gmail.spoofing_and_authentication Protéger contre le spoofing de domaine à partir de noms de domaine similaires detect_domain_name_spoofing booléen
Choisir une action domain_name_spoofing_consequence Enum :
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Choisir une zone de quarantaine domain_name_spoofing_quarantine_id entier
Protéger contre le spoofing de noms d'employés detect_employee_name_spoofing booléen
Choisir une action employee_name_spoofing_consequence Enum :
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Choisir une zone de quarantaine employee_name_spoofing_quarantine_id entier
Protéger contre le spoofing de domaine par le biais d'e-mails entrants detect_domain_spoofing_from_unauthenticated_senders booléen
Choisir une action domain_spoofing_consequence Enum :
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Choisir une zone de quarantaine domain_spoofing_quarantine_id entier
Protégez-vous contre les e-mails non authentifiés. detect_unauthenticated_emails booléen
Choisir une action unauthenticated_email_consequence Enum :
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Choisir une zone de quarantaine unauthenticated_email_quarantine_id entier
Protéger vos groupes contre le spoofing de domaine par le biais d'e-mails entrants detect_groups_spoofing booléen
Appliquer ce paramètre à groups_spoofing_visibility_type Enum :
  • PRIVATE_GROUPS_ONLY
  • ALL_GROUPS
Choisir une action groups_spoofing_consequence Enum :
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Choisir une zone de quarantaine groups_spoofing_quarantine_id entier
Appliquer automatiquement les paramètres recommandés ultérieurement apply_future_settings_automatically booléen
Sécurité > Liens et images externes gmail.links_and_external_images Identifier les liens derrière les URL raccourcies enable_shortener_scanning booléen
Analyser les images liées enable_external_image_scanning booléen
Afficher l'invite d'avertissement pour tout clic sur les liens vers des domaines non approuvés enable_aggressive_warnings_on_untrusted_links booléen
Appliquer automatiquement les paramètres recommandés ultérieurement apply_future_settings_automatically booléen
Sécurité > Pièces jointes gmail.email_attachment_safety Protéger votre messagerie contre les pièces jointes chiffrées envoyées par des expéditeurs non approuvés enable_encrypted_attachment_protection booléen
Choisir une action encrypted_attachment_protection_consequence Enum :
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
Choisir une zone de quarantaine encrypted_attachment_protection_quarantine_id entier
Protéger votre messagerie contre les pièces jointes contenant des scripts envoyés par des expéditeurs non approuvés enable_attachment_with_scripts_protection booléen
Choisir une action attachment_with_scripts_protection_consequence Enum :
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
Choisir une zone de quarantaine attachment_with_scripts_protection_quarantine_id entier
Protéger contre les types de pièces jointes anormaux dans les e-mails enable_anomalous_attachment_protection booléen
Choisir une action anomalous_attachment_protection_consequence Enum :
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
Choisir une zone de quarantaine anomalous_attachment_protection_quarantine_id entier
Ajouter les types de fichiers inhabituels suivants à la liste d'autorisation allowed_anomalous_attachment_filetypes chaîne[]
Appliquer automatiquement les paramètres recommandés ultérieurement apply_future_recommended_settings_automatically booléen
Routage > Gérer les listes d'adresses gmail.email_address_lists Gérer les listes d'adresses email_address_list EmailAddressList[]
Spam, hameçonnage et logiciels malveillants > Expéditeurs bloqués gmail.blocked_sender_lists Bloquer ou approuver certains expéditeurs en fonction de leur adresse e-mail ou de leur domaine blocked_senders BlockedSender[]
Spam, hameçonnage et logiciels malveillants > Spam gmail.spam_override_lists Créez des listes d'expéditeurs approuvés afin que les messages de ces derniers ne soient pas placés dans le dossier de spam. spam_override SpamOverride[]
Conformité > Conformité du contenu gmail.content_compliance Configurer des filtres de contenu avancés en fonction de mots, d'expressions ou de formats content_compliance_rules ContentComplianceRule[]
Conformité > Contenu répréhensible gmail.objectionable_content Configurer des filtres de contenu en fonction de listes de mots objectionable_content_rules ObjectionableContentRule[]
Conformité > Conformité des pièces jointes gmail.attachment_compliance Configurer les filtres des pièces jointes en fonction du type de fichier, de son nom et de la taille du message attachment_compliance_rules AttachmentComplianceRule[]
Conformité > Stockage complet des e-mails gmail.comprehensive_mail_storage S'assurer qu'une copie de tous les messages envoyés et reçus soit stockée dans la boîte de réception des utilisateurs rule_id chaîne
N/A (Pour toutes les règles) gmail.rule_states N/A rule_states RuleState[]
Configuration > Importations d'adresses e-mail des utilisateurs gmail.user_email_uploads Afficher sur la page "Paramètres" de Gmail l'option d'importation d'e-mails et de contacts depuis un compte Yahoo!, Hotmail, AOL ou tout autre compte POP3 ou de messagerie Web enable_mail_and_contacts_import booléen
Accès utilisateur> Accès POP et IMAP gmail.pop_access Activer l'accès POP pour tous les utilisateurs enable_pop_access booléen
gmail.imap_access Activer l'accès IMAP pour tous les utilisateurs enable_imap_access booléen
Autoriser n'importe quel client de messagerie imap_access_restriction.allow_all_mail_clients booléen
Limiter les clients de messagerie accessibles aux utilisateurs (clients de messagerie OAuth uniquement) imap_access_restriction.allowed_oauth_mail_client_list OAuthMailClientList
Accès des utilisateurs finaux > Google Workspace Sync gmail.workspace_sync_for_outlook Activer Google Workspace Sync for Microsoft Outlook pour mes utilisateurs enable_google_workspace_sync_for_microsoft_outlook booléen
Accès utilisateur > Transfert automatique gmail.auto_forwarding Autoriser les utilisateurs à transférer automatiquement les e-mails entrants vers une autre adresse enable_auto_forwarding booléen
Paramètres utilisateur > Format du nom gmail.name_format Autoriser les utilisateurs à personnaliser ce paramètre allow_custom_display_names booléen
Prénom Nom ou Nom Prénom default_display_name_format Enum :
  • FIRSTNAME_LASTNAME
  • LASTNAME_COMMA_FIRSTNAME
Accès utilisateur > Autoriser les passerelles sortantes au niveau de l'utilisateur gmail.per_user_outbound_gateway Autoriser les utilisateurs à envoyer des e-mails grâce à un serveur SMTP externe lors de la configuration d'une adresse d'expéditeur hébergée hors de votre domaine de messagerie allow_users_to_use_external_smtp_servers booléen
Accès des utilisateurs finaux > Liste d'autorisation des URL d'image pour le proxy gmail.email_image_proxy_bypass Saisissez les formats d'URL d'image. Les URL correspondantes contournent le proxy d'images. image_proxy_bypass_pattern chaîne[]
N/A enable_image_proxy booléen
Paramètres utilisateur > Délégation de messagerie gmail.mail_delegation Autoriser les utilisateurs à déléguer l'accès à leur boîte aux lettres à d'autres utilisateurs appartenant au domaine enable_mail_delegation booléen
Autoriser les utilisateurs à personnaliser ce paramètre allow_custom_delegate_attribution booléen
Afficher le titulaire du compte et le délégué qui a envoyé l'e-mail enable_delegate_attribution booléen
Afficher le titulaire du compte uniquement
Autoriser les utilisateurs à accorder l'accès à leur messagerie à un groupe Google enable_mailbox_group_delegation booléen

Sous-paramètres Gmail

Ce tableau présente les sous-paramètres Gmail référencés par d'autres paramètres Gmail.

Nom du sous-paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
EmailAddressList N/A id chaîne
Nom nom chaîne
AJOUTER UNE LISTE D'ADRESSES address_list AddressList
AJOUTER UNE LISTE D'ADRESSES BLOQUÉES blocked_address_list AddressList
AddressList Ajouter une liste d'adresses address AddressListEntry[]
AddressListEntry Adresse address chaîne
Authentification obligatoire (messages reçus uniquement) require_address_verification booléen
BlockedSender Saisissez une brève description qui apparaîtra dans le résumé du paramètre. description chaîne
Ajouter des adresses ou des domaines à partir desquels vous souhaitez rejeter automatiquement les messages sender_blocklist StringValue[]
Saisissez un avis de refus personnalisé. rejection_response chaîne
Ignorez ce paramètre pour les messages provenant d'adresses ou de domaines figurant sur la liste des expéditeurs approuvés. bypass_approved_sender booléen
N/A bypass_approved_sender_allowlist StringValue[]
N/A rule_id chaîne
SpamOverride Saisissez une brève description qui apparaîtra dans le résumé du paramètre. description chaîne
Appliquer un filtrage plus strict des spams enable_aggressive_filtering booléen
Placer le spam dans la zone de quarantaine administrative add_to_quarantine booléen
N/A quarantine_id entier
Ignorer les filtres antispam pour les expéditeurs internes bypass_internal_senders booléen
Ignorer les filtres antispam pour les messages provenant d'expéditeurs ou de domaines dans les listes sélectionnées. bypass_selected_senders booléen
N/A bypass_sender_allowlist StringValue[]
Ignorer les filtres antispam et masquer les avertissements pour les messages provenant d'expéditeurs ou de domaines dans les listes sélectionnées hide_warning_banner_from_selected_senders booléen
N/A hide_warning_banner_sender_allowlist StringValue[]
Ignorer les filtres antispam et masquer les avertissements pour tous les messages provenant d'expéditeurs internes et externes (déconseillé) hide_warning_banner_for_all booléen
N/A rule_id chaîne
ContentComplianceRule Saisissez une brève description qui apparaîtra dans le résumé du paramètre. description chaîne
E-mails concernés condition RuleConditions
Ajouter les expressions qui décrivent le contenu à rechercher dans chaque message match_expressions MatchExpression[]
Si l'UN des éléments suivants correspond au message match_any_expression booléen
Si les expressions ci-dessus correspondent, procéder comme suit conséquence RuleConsequences
N/A rule_id chaîne
ObjectionableContentRule Saisissez une brève description qui apparaîtra dans le résumé du paramètre. description chaîne
E-mails concernés condition RuleConditions
Mots répréhensibles personnalisés objectionable_content_defined booléen
Saisir des mots objectionable_words chaîne[]
Si les expressions ci-dessus correspondent, procéder comme suit conséquence RuleConsequences
N/A rule_id chaîne
AttachmentComplianceRule Saisissez une brève description qui apparaîtra dans le résumé du paramètre. description chaîne
E-mails concernés condition RuleConditions
Ajouter les expressions qui décrivent le contenu à rechercher dans chaque message match_expressions MatchExpression[]
Si l'UN des éléments suivants correspond au message match_any_expression booléen
Si les expressions ci-dessus correspondent, procéder comme suit conséquence RuleConsequences
N/A rule_id chaîne
RuleState N/A (Pour toutes les règles) activé booléen
rule_id chaîne
RuleConditions E-mails concernés Entrée affect_inbound_messages booléen
Sortie affect_outbound_messages booléen
Interne - Envoi affect_internal_sending_messages booléen
Interne - Réception affect_internal_receiving_messages booléen
Listes d'adresses Utiliser des listes d'adresses pour ignorer ce paramètre ou contrôler son application address_list_option enum :
  • NO_EFFECT
  • EXCLUDED
  • REQUIRED
Ignorer ce paramètre pour des adresses / domaines spécifiques
Appliquer ce paramètre uniquement à des adresses / domaines spécifiques
Utiliser une liste existante / Créer ou modifier une liste address_lists StringValue[]
Types de comptes concernés Utilisateurs account_type_user booléen
Groupes account_type_group booléen
Non reconnu / Collecteur account_type_unrecognized booléen
Filtre d'enveloppe Appliquer uniquement à des expéditeurs d'enveloppe spécifiques envelope_sender_filter AddressMatcher
Appliquer uniquement à des destinataires d'enveloppe spécifiques envelope_recipient_filter AddressMatcher
AddressMatcher Appliquer uniquement à des expéditeurs d'enveloppe spécifiques / Appliquer uniquement à des destinataires d'enveloppe spécifiques activé booléen
Une seule adresse e-mail N/A address_match_type enum: EXACT
Adresse e-mail exact_address_match_value chaîne
Correspondance de format N/A address_match_type enum: REGEXP
Expression régulière regexp_match_value chaîne
Membres d'un groupe (e-mails envoyés uniquement) / Membres d'un groupe (e-mails reçus uniquement) N/A address_match_type enum: GROUP_MEMBERSHIP
Sélectionner des groupes group_ids chaîne[]
MatchExpression Correspondance de contenu simple N/A match_expression_type enum: SIMPLE_CONTENT
Contenu match_content chaîne
Correspondance de contenu avancée N/A match_expression_type enum: ADVANCED_CONTENT
Contenu / Expression régulière match_content chaîne
N/A advanced_content_match AdvancedContentMatch
Correspondance des métadonnées match_expression_type enum: METADATA
metadata_match MetadataMatch
Correspondance de contenu prédéfinie match_expression_type enum: PREDEFINED_CONTENT
predefined_content_match PredefinedContentMatch
Type de fichier match_expression_type enum: FILE_TYPE
file_type_match FileTypeMatch
Nom du fichier N/A match_expression_type enum: FILE_NAME
Le nom de la pièce jointe contient file_name chaîne
Taille du message N/A match_expression_type enum: MESSAGE_SIZE
La taille totale (en Mo) du message (corps + pièce jointe) est supérieure à message_size_threshold_in_megabytes entier
AdvancedContentMatch Emplacement En-têtes + Corps advanced_content_match_location enum: HEADERS_AND_BODY
En-têtes complets enum: FULL_HEADERS
Body enum: BODY
Subject enum: SUBJECT
En-tête de l'expéditeur enum: SENDER_HEADER
En-tête destinataire enum: RECIPIENTS_HEADER
Expéditeur de l'enveloppe enum: ENVELOPE_SENDER
Tout destinataire de l'enveloppe enum: ANY_ENVELOPE_RECIPIENT
Message brut enum: RAW_MESSAGE
Type de correspondance Commence par advanced_content_match_type enum: STARTS_WITH
Se termine par enum: ENDS_WITH
Contient du texte enum: CONTAINS_TEXT
Ne contient pas de texte enum: NOT_CONTAINS_TEXT
Est égal(e) à enum: <code< code="" dir="ltr" translate="no">EQUALS </code<>
Est vide enum: IS_EMPTY
Correspond à l'expression régulière enum: MATCHES_REGEXP
Ne correspond pas à l'expression régulière enum: NOT_MATCHES_REGEXP
Correspond à n'importe quel mot enum: MATCH_ANY_WORD
Correspond à tous les mots enum: MATCH_ALL_WORDS
N/A regexp_match RegexpMatch
RegexpMatch Description de l'expression régulière description chaîne
Nombre minimal de correspondances min_match_count entier
MetadataMatch Attribut Authentification des messages metadata_match_attribute enum: MESSAGE_AUTHENTICATION
Adresse IP source enum: SOURCE_IP
Transport sécurisé (TLS) enum: TLS
Taille du message enum: MESSAGE_SIZE
Chiffrement S/MIME enum: SMIME_ENCRYPTED
Signature S/MIME enum: SMIME_SIGNED
Mode confidentiel de Gmail enum: CONFIDENTIAL_MODE
Spam enum: SPAM
Type de correspondance la plage suivante source_ip_range chaîne
les éléments suivants (Mo) : message_size_in_megabytes entier
Le message est authentifié. metadata_match_type enum: MESSAGE_AUTHENTICATED
Le message n'est pas authentifié. enum: MESSAGE_NOT_AUTHENTICATED
L'adresse IP source est comprise dans enum: SOURCE_IP_IN_RANGE
L'adresse IP source n'est pas comprise dans enum: SOURCE_IP_NOT_IN_RANGE
La connexion est chiffrée par TLS enum: TLS_ENCRYPTED
La connexion n'est pas chiffrée par TLS enum: TLS_NOT_ENCRYPTED
La taille du message est supérieure à enum: MESSAGE_SIZE_GREATER_THAN
La taille du message est inférieure à enum: MESSAGE_SIZE_LESS_THAN
Message avec chiffrement S/MIME enum: MESSAGE_IS_SMIME_ENCRYPTED
Le message n'est pas chiffré avec S/MIME enum: MESSAGE_IS_NOT_SMIME_ENCRYPTED
Le message est signé S/MIME enum: MESSAGE_IS_SMIME_SIGNED
Le message n'est pas signé S/MIME enum: MESSAGE_IS_NOT_SMIME_SIGNED
Le message est en mode confidentiel de Gmail enum: MESSAGE_IS_IN_CONFIDENTIAL_MODE
Le message n'est pas en mode confidentiel de Gmail enum: MESSAGE_IS_NOT_IN_CONFIDENTIAL_MODE
Logiciel malveillant détecté à partir du bac à sable de sécurité enum: MALWARE_DETECTED_FROM_SECURITY_SANDBOX
PredefinedContentMatch N/A (sélecteur de correspondance de contenu prédéfini) predefined_content_match_name chaîne
Nombre minimal de correspondances min_match_count entier
Seuil de confiance confidence_threshold enum :
  • MEDIUM
  • HIGH
FileTypeMatch Documents Office chiffrés encrypted_office_documents booléen
Documents Office non chiffrés unencrypted_office_documents booléen
Vidéo et multimédia vidéo booléen
Musique et son music booléen
Images image booléen
Fichiers compressés et archives chiffrées compressed_encrypted_files booléen
Fichiers compressés et archives non chiffrées compressed_unencrypted_files booléen
Types de fichiers personnalisés - Faire correspondre les fichiers en fonction de leur extension custom_file_extensions chaîne[]
Faire également correspondre les fichiers en fonction de leur format match_file_format booléen
RuleConsequences Modifier le message N/A rule_consequence_type enum: MODIFY_MESSAGE
N/A primary_delivery Diffusion
Ajouter d'autres destinataires deliver_to_additional_recipients booléen
Destinataires bcc_deliveries Livraison[]
Diffusion Ajouter l'en-tête X-Gm-Original-To add_x_gm_original_to_header booléen
Ajouter les en-têtes X-Gm-Spam et X-Gm-Phishy add_x_gm_spam_header booléen
Ajouter des en-têtes personnalisés add_custom_headers booléen
En-têtes personnalisés custom_headers chaîne[]
Ajouter un préfixe personnalisé à l'objet prepend_custom_subject booléen
Saisissez le nouveau préfixe de l'objet custom_subject chaîne
Modifier la route change_default_route booléen
Réacheminer aussi le spam reroute_spam booléen
Supprimer les avis de non-distribution de ce destinataire suppress_bounces_from_recipient booléen
N/A (sélecteur de routage) normal_routing booléen
Modifier le destinataire de l'enveloppe N/A change_envelope_recipient booléen
Remplacer le destinataire replace_envelope_recipient_type enum: REPLACE_ADDRESS
recipient_address chaîne
Remplacer le nom d'utilisateur replace_envelope_recipient_type enum: REPLACE_USER
recipient_user chaîne
Remplacer le domaine replace_envelope_recipient_type enum: REPLACE_DOMAIN
recipient_domain chaîne
Ignorer le filtre antispam pour ce message bypass_spam_filter booléen
Supprimer les pièces jointes du message remove_attachments booléen
Ajouter ce texte pour informer les destinataires de la suppression des pièces jointes attachment_removal_notice chaîne
Exiger l'utilisation du protocole TLS require_tls booléen
Chiffrer le message s'il ne l'est pas déjà (S/MIME) encrypt_outgoing_messages booléen
Rejeter le message s'il ne peut être ni signé, ni chiffré bounce_unencrypted_messages booléen
Ne pas distribuer de spam à ce destinataire do_not_deliver_spam_to_recipient booléen
OAuthMailClientList Limiter les clients de messagerie accessibles aux utilisateurs (clients de messagerie OAuth uniquement) oauth_mail_client OAuthMailClient[]
OAuthMailClient N/A oauth_mail_client_id chaîne

Paramètres de chat

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Google Chat Historique des discussions chat.chat_history Historique activé/désactivé history_on_by_default booléen
Autoriser les utilisateurs à modifier les paramètres de leur historique allow_user_modification booléen
Partage de fichiers dans Chat chat.chat_file_sharing Partage de fichiers externe external_file_sharing Enum :
  • ALL_FILES
  • IMAGES_ONLY
  • NO_FILES
  • FILE_SHARING_OPTION_UNSPECIFIED
internal_file_sharing identique
Historique des espaces chat.space_history Paramètres de l'historique des conversations pour les espaces history_state Enum :
  • DEFAULT_HISTORY_ON
  • DEFAULT_HISTORY_OFF
  • HISTORY_ALWAYS_ON
  • HISTORY_ALWAYS_OFF
  • HISTORY_STATE_UNSPECIFIED
Paramètres de discussion en externe chat.external_chat_restriction Autoriser les utilisateurs à envoyer des messages en dehors de l'organisation dans les discussions et les espaces allow_external_chat booléen
external_chat_restriction Enum :
  • NO_RESTRICTION
  • TRUSTED_DOMAINS
  • RESTRICTION_UNSPECIFIED
Applications de chat chat.chat_apps_access Autoriser les utilisateurs à installer des applications Chat enable_apps booléen
Autoriser les utilisateurs à ajouter et à utiliser des webhooks entrants enable_webhooks booléen

Paramètres de Drive et Docs

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Drive et Docs Paramètres de partage > Options de partage drive_and_docs.external_sharing Sélectionnez le niveau de partage le plus élevé en dehors de $CUSTOMER_NAME que vous souhaitez autoriser. external_sharing_mode Enum :
  • DISALLOWED
  • ALLOWLISTED_DOMAINS
  • ALLOWED
Autoriser les utilisateurs de $ORG_UNIT_NAME à recevoir des fichiers provenant d'utilisateurs ou de Drive partagés n'appartenant pas à $CUSTOMER_NAME allow_receiving_external_files Booléen
Afficher un avertissement lorsque des fichiers appartenant à des utilisateurs ou figurant dans des Drive partagés de $ORG_UNIT_NAME sont partagés avec des utilisateurs des domaines de la liste d'autorisation warn_for_sharing_outside_allowlisted_domains Booléen
Autoriser les utilisateurs de $ORG_UNIT_NAME à recevoir des fichiers provenant d'utilisateurs ou de Drive partagés n'appartenant pas à des domaines de la liste d'autorisation allow_receiving_files_outside_allowlisted_domains Booléen
Autoriser les utilisateurs ou les Drive partagés de $ORG_UNIT_NAME à partager des éléments avec des utilisateurs sans compte Google dans des domaines approuvés grâce au partage avec des visiteurs allow_non_google_invites_in_allowlisted_domains Booléen
Afficher un avertissement lorsque des fichiers appartenant à des utilisateurs ou figurant dans des Drive partagés de $ORG_UNIT_NAME sont partagés en dehors de $CUSTOMER_NAME warn_for_external_sharing Booléen
Autoriser les utilisateurs ou les Drive partagés de $ORG_UNIT_NAME à partager des éléments avec des personnes externes à $CUSTOMER_NAME qui n'utilisent pas de compte Google allow_non_google_invites Booléen
Lorsque le partage en dehors de $CUSTOMER_NAME est autorisé, les utilisateurs de $ORG_UNIT_NAME peuvent rendre des fichiers et du contenu Web publié visibles à toute personne disposant du lien allow_publishing_files Booléen
Lorsqu'un utilisateur partage un fichier via un produit Google autre que Docs ou Drive (par exemple, en collant un lien dans Gmail), Google peut vérifier que les destinataires y ont accès. Sinon, lorsque cela est possible, Google demande à l'utilisateur d'indiquer avec qui il veut partager le fichier : access_checker_suggestions Enum :
  • RECIPIENTS_OR_AUDIENCE_OR_PUBLIC
  • RECIPIENTS_OR_AUDIENCE
  • RECIPIENTS_ONLY
Sélectionnez les utilisateurs autorisés à diffuser du contenu dans $ORG_UNIT_NAME en dehors de $CUSTOMER_NAME. Cette option permet de restreindre l'importation ou le déplacement de contenu dans les Drive partagés détenus par une autre organisation. allowed_parties_for_distributing_content Enum :
  • ALL_ELIGIBLE_USERS
  • ELIGIBLE_INTERNAL_USERS
  • NONE
Paramètres de partage > Accès général par défaut drive_and_docs.general_access_default Lorsque des utilisateurs de $ORG_UNIT_NAME créent des éléments, l'accès par défaut est default_file_access Enum :
  • PRIVATE_TO_OWNER
  • PRIMARY_AUDIENCE_WITH_LINK
  • PRIMARY_AUDIENCE_WITH_LINK_OR_SEARCH
Paramètres de partage > Création d'un Drive partagé drive_and_docs.shared_drive_creation Empêcher les utilisateurs de $ORG_UNIT_NAME de créer des Drive partagés allow_shared_drive_creation Booléen (la réponse de l'API renvoie l'opposé de la valeur de l'UI)
Les Drive partagés créés par des utilisateurs de $ORG_UNIT_NAME seront associés à l'unité organisationnelle suivante org_unit_for_new_shared_drives Enum :
  • CREATOR_ORG_UNIT
  • CUSTOM_ORG_UNIT
Unité organisationnelle sélectionnée custom_org_unit Chaîne
Autoriser les membres disposant du rôle d'administrateur à remplacer les paramètres ci-dessous allow_managers_to_override_settings Booléen
Autoriser les utilisateurs en dehors de $CUSTOMER_NAME à accéder aux fichiers des Drive partagés allow_external_user_access Booléen
Autoriser l'accès aux fichiers de personnes n'appartenant pas au Drive partagé allow_non_member_access Booléen
Autoriser les lecteurs et les commentateurs à télécharger, imprimer et copier les fichiers allowed_parties_for_download_print_copy Enum :
  • ALL (lorsque la case à cocher de l'interface utilisateur est cochée)
  • EDITORS_ONLY (lorsque la case à cocher de l'UI n'est pas cochée)
Autoriser les gestionnaires de contenu à partager des dossiers allow_content_managers_to_share_folders Booléen
Paramètres de partage > Mise à jour de sécurité pour les fichiers drive_and_docs.file_security_update Une fois appliquée, cette mise à jour renforcera la sécurité des liens de fichiers. Les utilisateurs pourraient alors recevoir des demandes d'accès aux fichiers. security_update Enum :
  • APPLY_TO_IMPACTED_FILES
  • REMOVE_FROM_IMPACTED_FILES
Autoriser les utilisateurs à supprimer/appliquer la mise à jour de sécurité aux fichiers dont ils sont propriétaires ou qu'ils gèrent allow_users_to_manage_update Booléen
Fonctionnalités et applications > SDK Drive drive_and_docs.drive_sdk Autoriser les utilisateurs à accéder à Google Drive avec l'API Drive SDK enable_drive_sdk_api_access Booléen
Google Drive pour ordinateur > Activer Drive pour ordinateur drive_and_docs.drive_for_desktop Autoriser Google Drive pour ordinateur dans votre organisation allow_drive_for_desktop Booléen
Utiliser Google Drive pour ordinateur uniquement sur les appareils autorisés restrict_to_authorized_devices Booléen
Afficher le lien de téléchargement de Google Drive pour ordinateur show_download_link Booléen
Autoriser les utilisateurs à activer la présence en temps réel dans Microsoft Office depuis Google Drive pour ordinateur allow_real_time_presence Booléen

Paramètres Meet

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Google Meet Paramètres vidéo Meet > Enregistrement meet.video_recording Autoriser les utilisateurs à enregistrer leurs réunions enable_recording booléen
Paramètres de sécurité Meet > Domaine meet.safety_domain Utilisateurs autorisés à participer aux réunions créées par votre organisation users_allowed_to_join Enum :
  • SAME_ORGANIZATION_ONLY
  • LOGGED_IN
  • ALL
Paramètres de sécurité Meet > Accès meet.safety_access Réunions ou appels auxquels les utilisateurs de l'organisation peuvent participer. Il se peut que les restrictions appliquées aux appels entrants limitent davantage les appels que les utilisateurs peuvent recevoir. meetings_allowed_to_join Enum :
  • SAME_ORGANIZATION_ONLY
  • ANY_WORKSPACE_ORGANIZATION
  • ALL
Paramètres de sécurité de Meet > Gestion par l'organisateur meet.safety_host_management Gestion par l'organisateur par défaut enable_host_management Booléen
Paramètres de sécurité Meet > Avertissement de participants externes meet.safety_external_participants Indique les participants qui ne font pas partie de "Organisation" ou dont l'identité n'est pas confirmée. enable_external_label Booléen

Paramètres des sites

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Sites Nouvelle version de Sites > Création et modification des sites sites.sites_creation_and_modification Autoriser les utilisateurs à créer des sites allowSitesCreation Booléen
Les utilisateurs peuvent/ne peuvent pas modifier les sites allowSitesModification Booléen

Paramètres Groups for Business

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Groups for Business Paramètres de partage > Options de partage groups_for_business.groups_sharing Définir des règles pour modifier les paramètres de partage des groupes collaborationCapability Enum :
  • ANYONE_CAN_ACCESS
  • DOMAIN_USERS_ONLY
Créer des groupes createGroupsAccessLevel Enum :
  • ADMIN_ONLY
  • USERS_IN_DOMAIN
  • ANYONE_CAN_CREATE
Les propriétaires de groupe peuvent autoriser les membres externes ownersCanAllowExternalMembers Booléen
Les propriétaires de groupe peuvent autoriser la réception d'e-mails provenant de l'extérieur de l'organisation ownersCanAllowIncomingMailFromPublic Booléen
Paramètre d'autorisation par défaut pour la consultation des conversations viewTopicsDefaultAccessLevel Énumération :
  • OWNERS
  • MANAGERS
  • GROUP_MEMBERS
  • DOMAIN_USERS
  • ANYONE_CAN_VIEE_TOPICS
Les propriétaires de groupes peuvent masquer des groupes dans l'annuaire ownersCanHideGroups Booléen
Masquer les nouveaux groupes dans l'annuaire newGroupsAreHidden Booléen
Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Paramètres de compte Options de partage cloud_sharing_options.cloud_data_sharing Options de partage de Google Cloud Platform sharingOptions Enum :
  • UNSUPPORTED
  • ENABLED
  • DISABLED

Paramètres Classroom

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
En salle Paramètres généraux > Autorisations des enseignants classroom.teacher_permissions Qui peut créer des cours ? whoCanCreateClasses Enum :
  • ANYONE_IN_DOMAIN
  • ALL_PENDING_AND_VERIFIED_TEACHERS
  • VERIFIED_TEACHERS_ONLY
Paramètres généraux > Accès des représentants légaux classroom.guardian_access Autoriser les parents et les représentants légaux à accéder aux informations de Classroom allowAccess Booléen
Qui peut gérer les parents et les représentants légaux ? whoCanManageGuardianAccess Enum :
  • VERIFIED_TEACHERS_AND_DOMAIN_ADMINS
  • DOMAIN_ADMINS_ONLY
Paramètres du cours > À propos des inscriptions aux cours classroom.class_membership Personnes autorisées à participer aux cours de votre domaine whoCanJoinClasses Enum :
  • ANYONE_IN_DOMAIN
  • ANYONE_IN_ALLOWLISTED_DOMAINS
  • ANY_GOOGLE_WORKSPACE_USER
  • ANYONE
Cours auxquels les utilisateurs de votre domaine peuvent participer whichClassesCanUsersJoin Enum :
  • CLASSES_IN_DOMAIN
  • CLASSES_IN_ALLOWLISTED_DOMAINS
  • ANY_GOOGLE_WORKSPACE_CLASS
Accès aux données > API Classroom classroom.api_data_access Les utilisateurs peuvent autoriser les applications à accéder à leurs données Google Classroom enableApiAccess Booléen
Rapports sur le degré d'originalité > Passages communs à plusieurs travaux d'élèves classroom.originality_reports Activer les passages communs à plusieurs travaux d'élèves dans les rapports sur le degré d'originalité enableOriginalityReportsSchoolMatches Booléen
Désinscription des élèves > Autorisations de désinscription classroom.student_unenrollment Qui peut désinscrire les élèves des cours ? whoCanUnenrollStudents Enum
  • STUDENTS_AND_TEACHERS
  • TEACHERS_ONLY
Importation de la liste des joueurs > Paramètres classroom.roster_import Importer les listes d'élèves rosterImportOption Enum :
  • OFF
  • ON_CLEVER

Paramètres de l'agenda

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Agenda Paramètres avancés > Plannings des rendez-vous avec paiements calendar.appointment_schedules Autorisez les utilisateurs de plannings des rendez-vous à exiger le paiement des créneaux réservés via leur propre compte de fournisseur de services de paiement. enable_payments booléen
Paramètres de partage > Invitations externes calendar.external_invitations Avertir les utilisateurs lorsqu'ils invitent des personnes extérieures au domaine ORGANIZATION_UNIT_NAME warn_on_invite booléen
Gestion de Calendar Interop > Disponibilités Exchange dans Agenda calendar.interoperability Autoriser Google Agenda à afficher la disponibilité des utilisateurs d'Exchange enable_interoperability booléen
Afficher les détails de l'événement enable_full_event_details booléen
Gestion de Calendar Interop > Réservation de ressources Exchange calendar.interoperability Autoriser Google Agenda à réserver des salles Microsoft Exchange enable_exchange_room_booking booléen
Paramètres de partage > Options de partage externe pour les agendas principaux calendar.primary_calendar_max_allowed_external_sharing En dehors de ORGANIZATION_UNIT_NAME : définir les capacités de l'utilisateur pour les agendas principaux max_allowed_external_sharing Enum :
  • EXTERNAL_FREE_BUSY_ONLY
  • EXTERNAL_ALL_INFO_READ_ONLY
  • EXTERNAL_ALL_INFO_READ_WRITE
  • EXTERNAL_ALL_INFO_READ_WRITE_MANAGE
Paramètres de partage > Options de partage externe pour les agendas secondaires calendar.secondary_calendar_max_allowed_external_sharing En dehors de <nom de l'organisation> : définir les capacités de l'utilisateur pour les agendas secondaires max_allowed_external_sharing Enum :
  • EXTERNAL_FREE_BUSY_ONLY
  • EXTERNAL_ALL_INFO_READ_ONLY
  • EXTERNAL_ALL_INFO_READ_WRITE
  • EXTERNAL_ALL_INFO_READ_WRITE_MANAGE

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

Pour en savoir plus sur les règles et les 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.

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Protection des données Sécurité > Contrôle des accès et des données > Protection des données > Gérer les règles rule.dlp Nom display_name Chaîne
Description description Chaîne
Applications déclencheurs String[] : liste de chaînes de déclencheur spécifiques à l'application. La liste des déclencheurs d'application disponibles est fournie dans la section "Déclencheurs" suivante.
Conditions condition Chaîne : expression en langage CEL (Common Expression Language) des conditions de données que la règle recherche. La syntaxe CEL et quelques exemples courants sont fournis dans la section "Conditions" suivante.
Actions action Struct : objet imbriqué représentant les actions spécifiques à l'application à effectuer lorsque les conditions sont remplies. Les actions disponibles par déclencheur d'application sont indiquées dans la section "Actions" suivante.
État state Enum :
  • ACTIVE
  • INACTIVE
Créé create_time Horodatage
Dernière modification update_time Horodatage
Métadonnées spécifiques au type de règle rule_type_metadata Struct : objet imbriqué représentant 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é des événements déclenché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 en langage 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 contenu disponibles, correspondant aux configurations correspondantes 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
  • objet
  • suggestion
  • target_user
  • titre
  • to_header_recipients
  • url
  • url_category

Contenu à rechercher

Liste des contenus disponibles à analyser, correspondant aux configurations correspondantes du 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} indique le type de données prédéfini à rechercher, 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 la 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 du 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 dans la console d'administration.
    • {detector name} est le nom de la 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 du détecteur dans l'API.
  • matches_web_category({category})
    • Correspond à l'option Correspond à la catégorie d'URL dans la console d'administration pour le déclencheur d'URL visitée Chrome.
    • {category} indique 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 la section Catégories d'URL.

Conditions composites

Vous pouvez combiner plusieurs conditions de base 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 à la fois 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 du partage externe. Les actions spécifiques à l'application disponibles sont les suivantes:

Application Touche d'action Sous-action Sous-titres de la console d'administration
Drive driveAction blockAccess Bloquer le partage externe
warnUser Avertissement en cas de partage externe
auditOnly Aucune action
restrictCopyPrintDownload Désactiver le téléchargement, l'impression et la copie
applyLabels Appliquer des libellés de classification
Gmail gmailAction blockContent Bloquer le message
warnUser Avertir les utilisateurs
auditOnly Audit uniquement
quarantineMessage Mettre le message en quarantaine
Chat chatAction blockContent Bloquer le message
warnUser Avertir les utilisateurs
auditOnly Audit uniquement
Chrome chromeAction blockContent Bloquer
warnUser Autoriser avec avertissement

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 la gravité de l'événement d'alerte lorsqu'il est signalé dans le tableau de bord de sécurité et le centre d'alerte. Exemple de valeur des métadonnées représentant la gravité de l'alerte LOW:

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 en savoir plus sur les règles et les 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.

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Protection des données Sécurité > Contrôle des accès et des données > Protection des données > Gérer les détecteurs detector.regular_expression detector.word_list Nom display_name Chaîne
Description description Chaîne
Expression régulière expression_régulière Struct : contient la chaîne d'expression régulière. Ne définir que si le type de détecteur est detector.regular_expression.
Liste de mots word_list Chaîne : contient la liste des chaînes de mots. Ne doit être défini que si le type de détecteur est detector.word_list.
Créé create_time Horodatage
Dernière modification update_time Horodatage

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 qui sont modifiées par l'administrateur par rapport à la valeur par défaut.

Page de la console d'administration Paramètre spécifique dans la console d'administration Type de paramètre de l'API Policy Sous-titres de la console d'administration Nom du champ de l'API Policy Type de données
Protection des données Règles (pour le type de règle "défini par le système") rule.system_defined_alerts Nom display_name Chaîne
Description description Chaîne
Actions action Struct : objet imbriqué représentant les paramètres de notification lorsque l'alerte définie par le système se déclenche. Vous trouverez plus d'informations dans la section "Actions" suivante.
État state Enum :
  • ACTIVE
  • INACTIVE
Créé create_time Horodatage
Dernière modification update_time Horodatage

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.

Touche d'action Sous-action Sous-titres de la console d'administration
alertCenterAction alertCenterConfig Envoyer au centre d'alerte
destinataires Envoyer des notifications par e-mail