Configurações disponíveis na API

Este documento descreve as configurações compatíveis com a API Policy.

Se as configurações com suporte não estiverem na resposta da API Cloud Identity Policy, consulte Valores de campo padrão. Se a configuração ausente não for mencionada em Valores de campo padrão, entre em contato com o Suporte do Cloud.

Configurações de segurança

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Recuperação de conta Recuperação de conta de superadministrador security.super_admin_account_recovery Permitir que os superadministradores recuperem a conta enableAccountRecovery Booleano
Recuperação de conta de usuário security.user_account_recovery Permitir que usuários e administradores (exceto superadministradores) recuperem as contas enableAccountRecovery Booleano
Gerenciamento de senhas Gerenciamento de senhas security.password Expiração expirationDuration Segundos (0 segundos significa "nunca expira")
Reutilização allowReuse Booleano
Aplicação de nível de segurança e de tamanho da senha enforceRequirementsAtLogin Booleano
Comprimento (comprimento máximo) maximumLength Número inteiro
Comprimento (comprimento mínimo) minimumLength Número inteiro
Força allowedStrength Enum:
  • STRONG
  • WEAK
Google Session Control Controle da sessão security.session_controls Duração da sessão da Web webSessionDuration Segundos
Apps menos seguros Apps menos seguros security.less_secure_apps Controle o acesso dos usuários a apps que usam tecnologias de login menos seguras e deixam as contas mais vulneráveis. allowLessSecureApps Booleano
Desafios de login Desafios de login security.login_challenges Usar o ID de funcionário para aumentar a proteção dos meus usuários enableEmployeeIdChallenge Booleano
Programa Proteção Avançada Inscrição security.advanced_protection_program Usar o ID de funcionário para aumentar a proteção dos meus usuários enableAdvancedProtectionSelfEnrollment Booleano
Códigos de segurança securityCodeOption Enum:
  • ALLOWED_WITH_REMOTE_ACCESS
  • ALLOWED_WITHOUT_REMOTE_ACCESS
  • CODES_NOT_ALLOWED
Verificação em duas etapas Authentication security.two_step_verification_enrollment Permitir que os usuários ativem a verificação em duas etapas allowEnrollment Booleano
security.two_step_verification_enforcement Aplicação enforcedFrom Carimbo de data/hora
security.two_step_verification_grace_period Período de inscrição de novos usuários enrollmentGracePeriod Duração
security.two_step_verification_device_trust Permitir que o usuário confie no dispositivo allowTrustingDevice Booleano
security.two_step_verification_enforcement_factor Métodos allowedSignInFactorSet Enum:
  • ALL
  • PASSKEY_ONLY
  • PASSKEY_PLUS_SECURITY_CODE
  • PASSKEY_PLUS_IP_BOUND_SECURITY_CODE
  • NO_TELEPHONY
security.two_step_verification_sign_in_code Período de carência da suspensão da política de verificação em duas etapas backupCodeExceptionPeriod Duração

Configurações do UserTakeout

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Dados Importação e exportação de dados > Google Takeout > Acesso do usuário ao Takeout para Serviços do 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
Gerenciar o acesso do usuário ao Takeout para Serviços do Google takeout_status Enum:
  • TAKEOUT_STATUS_UNSPECIFIED
  • ENABLED
  • DISABLED

Configurações do Marketplace

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Lista de apps Lista de apps workspace_marketplace.apps_allowlist Mostrando apps para usuários em todas as unidades organizacionais apps Lista de apps que contêm "application_id" e o status de acesso como "ALLOWED" ou "BLOCKED".
Configurações Gerenciar o acesso a apps > Gerenciar o acesso à lista de permissões do Google Workspace Marketplace workspace_marketplace.apps_access_options Selecione os apps do Marketplace que os usuários podem executar e instalar. access_level Enum:
  • ALLOW_ALL
  • ALLOW_LISTED_APPS
  • ALLOW_NONE

A configuração workspace_marketplace.apps_allowlist na resposta da API expõe o application_id do Marketplace em vez de application_name. O script Python a seguir pode ser usado para converter um ou mais application_id especificados na linha de comando em 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)

Configurações de status do serviço

A configuração service_status contém um valor booleano que implica que um serviço está ativado para um determinado OrgUnit ou Group.

A API Policy oferece suporte a configurações de status de serviço para serviços do Workspace e serviços adicionais listados no Admin Console em Apps.

Nome do serviço no Admin Console Nome do serviço da API Policy
Agenda agenda
Cloud Search cloud_search
Drive e Documentos drive_and_editors
Currents correntes
Grupos para empresas groups_for_business
Jamboard jamboard
Keep keep
Google Chat chat
Google Meet encontro
Google Voice voz
Google Sites sites
Tarefas tasks
Vault vault
Work Insights work_insights
AppSheet appsheet
Habilidades digitais aplicadas applied_digital_skills
Atividades atividades
Blogger blogueiro
Contas de marca brand_accounts
Campaign Manager 360 campaign_manager
Chrome Canvas chrome_canvas
Área de trabalho remota do Google Chrome chrome_remote_desktop
Chrome Web Store chrome_web_store
Sala de Aula classroom
CS First cs_first
Apps experimentais experimental_apps
FeedBurner feedburner
Google Ad Manager ad_manager
Google Ads ads
Google AdSense adsense
Alertas do Google alertas
Google Analytics analytics
Google Arts & Culture arts_and_culture
Favoritos do Google favoritos
Google Livros livros
Sincronização do Google Chrome chrome_sync
Google Cloud nuvem
Google Cloud Print cloud_print
Google Colab colab
Google Developers desenvolvedores
Google Domains domínios
Google Earth Terra
Google Fi fi
Grupos do Google grupos
Google Maps mapas
Google Mensagens mensagens
Google Meu Negócio my_business
Google My Maps my_maps
Google Notícias notícias
Google Pay pagar
Google Fotos fotos
Google Play reproduzir
Google Play Console play_console
Pesquisa de Dados Públicos do Google public_data
Leitura Guiada do Google read_along
Google Search Console search_console
Google Takeout para comer depois
Google Tradutor traduzir
Google Trips viagens
Histórico de localização location_history
Looker Studio data_studio
Google Play gerenciado managed_play
Material Gallery material_gallery
Merchant Center merchant_center
Painel do parceiro partner_dash
Pinpoint apontar
Central de parceiros do Play Livros play_books_partner_center
Mecanismo de Pesquisa Programável programmable_search_engine
QuestionHub question_hub
Perfis do Google Acadêmico scholar_profiles
Search Ads 360 search_ads_360
Pesquisa e Assistente search_and_assistant
Socrática socratic
Studio studio
Backups de apps de terceiros third_party_app_backups
Criador de Tours Virtuais tour_creator
YouTube YouTube
Serviços adicionais sem controle individual enterprise_service_restrictions
App Gemini gemini
Apps com acesso antecipado early_access_apps
AI Studio ai_studio
Cursivo do Chrome chrome_cursive
NotebookLM notebooklm

Configurações do Gmail

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Gmail Configurações do usuário > Modelo confidencial gmail.confidential_mode Ativar o modo confidencial enable_confidential_mode boolean
Configurações do usuário > S/MIME gmail.enhanced_smime_encryption Permitir que os usuários façam upload dos próprios certificados allow_user_to_upload_certificates boolean
Aceite estes certificados raiz adicionais para domínios específicos: custom_root_certificates Uma lista de CustomRootCertificates que contém uma lista de certificados raiz, uma lista de certificados de AC intermediários, uma lista de nomes de domínio restritos, um booleano para permitir incompatibilidade de endereço e um tipo enumerado com diferentes níveis de validação.
Spam, phishing e malware > Verificação de mensagem de pré-entrega aprimorada gmail.enhanced_pre_delivery_message_scanning Melhora a detecção de conteúdo suspeito antes da entrega enable_improved_suspicious_content_detection boolean
Spam, phishing e malware > Lista de e-mails permitidos gmail.email_spam_filter_ip_allowlist Digite os endereços IP da sua lista de e-mails permitidos allowed_ip_addresses Uma lista de strings
Segurança > Spoofing e autenticação gmail.spoofing_and_authentication Proteger contra spoofing de domínio com base em nomes de domínio semelhantes detect_domain_name_spoofing boolean
Escolher uma ação domain_name_spoofing_consequence Enum:
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Escolher uma quarentena domain_name_spoofing_quarantine_id integer
Proteger contra spoofing de nomes de funcionários detect_employee_name_spoofing boolean
Escolher uma ação employee_name_spoofing_consequence Enum:
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Escolher uma quarentena employee_name_spoofing_quarantine_id integer
Proteger contra o recebimento de e-mails que façam spoofing do seu domínio detect_domain_spoofing_from_unauthenticated_senders boolean
Escolher uma ação domain_spoofing_consequence Enum:
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Escolher uma quarentena domain_spoofing_quarantine_id integer
Proteger contra e-mails não autenticados detect_unauthenticated_emails boolean
Escolher uma ação unauthenticated_email_consequence Enum:
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Escolher uma quarentena unauthenticated_email_quarantine_id integer
Proteger seus Grupos contra o recebimento de e-mails que façam spoofing do domínio detect_groups_spoofing boolean
Aplicar essa configuração a groups_spoofing_visibility_type Enum:
  • PRIVATE_GROUPS_ONLY
  • ALL_GROUPS
Escolher uma ação groups_spoofing_consequence Enum:
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
  • NO_ACTION
Escolher uma quarentena groups_spoofing_quarantine_id integer
Aplicar automaticamente as futuras configurações recomendadas apply_future_settings_automatically boolean
Segurança > Links e imagens externas gmail.links_and_external_images Identificar links em URLs abreviados enable_shortener_scanning boolean
Verificar imagens de links enable_external_image_scanning boolean
Mostrar avisos quando alguém clicar em qualquer link de domínios não confiáveis enable_aggressive_warnings_on_untrusted_links boolean
Aplicar automaticamente as futuras configurações recomendadas apply_future_settings_automatically boolean
Segurança > Anexos gmail.email_attachment_safety Proteger contra anexos criptografados de remetentes não confiáveis enable_encrypted_attachment_protection boolean
Escolher uma ação encrypted_attachment_protection_consequence Enum:
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
Escolher uma quarentena encrypted_attachment_protection_quarantine_id integer
Proteger contra anexos com scripts de remetentes não confiáveis enable_attachment_with_scripts_protection boolean
Escolher uma ação attachment_with_scripts_protection_consequence Enum:
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
Escolher uma quarentena attachment_with_scripts_protection_quarantine_id integer
Proteger contra tipos de anexo anômalos em e-mails enable_anomalous_attachment_protection boolean
Escolher uma ação anomalous_attachment_protection_consequence Enum:
  • WARNING
  • SPAM_FOLDER
  • QUARANTINE
Escolher uma quarentena anomalous_attachment_protection_quarantine_id integer
Colocar os seguintes tipos de arquivo incomuns na lista de permissões allowed_anomalous_attachment_filetypes string[]
Aplicar automaticamente as futuras configurações recomendadas apply_future_recommended_settings_automatically boolean
Roteamento > Gerenciar listas de endereços gmail.email_address_lists Gerenciar listas de endereços email_address_list EmailAddressList[]
Spam, phishing e malware > remetentes bloqueados gmail.blocked_sender_lists Bloquear ou aprovar remetentes específicos com base no endereço de e-mail ou no domínio blocked_senders BlockedSender[]
Spam, phishing e malware > Spam gmail.spam_override_lists Criar listas de remetentes aprovados que ignoram a caixa de spam. spam_override SpamOverride[]
Compliance > Compliance do conteúdo gmail.content_compliance Configurar filtros de conteúdo avançados com base em palavras, frases ou padrões content_compliance_rules ContentComplianceRule[]
Compliance > Conteúdo censurável gmail.objectionable_content Configurar filtros de conteúdo com base em listas de palavras objectionable_content_rules ObjectionableContentRule[]
Compliance > Compliance para anexos gmail.attachment_compliance Configurar filtros de anexo com base no tipo, nome e tamanho da mensagem attachment_compliance_rules AttachmentComplianceRule[]
Compliance > Armazenamento de e-mails abrangente gmail.comprehensive_mail_storage Verifique se as cópias de todos os e-mails enviados e recebidos estão armazenadas nas caixas de e-mail dos usuários associados rule_id string
N/A (para todas as regras) gmail.rule_states N/A rule_states RuleState[]
Configuração > Uploads de e-mail do usuário gmail.user_email_uploads Mostrar para os usuários a opção de importar e-mails do Yahoo!, Hotmail, AOL ou de outras contas de webmail ou POP3 na página de configurações do Gmail enable_mail_and_contacts_import boolean
Acesso do usuário final > Acesso POP e IMAP gmail.pop_access Ativar o acesso POP para todos os usuários enable_pop_access boolean
gmail.imap_access Ativar o acesso IMAP para todos os usuários enable_imap_access boolean
Permitir qualquer cliente de e-mail imap_access_restriction.allow_all_mail_clients boolean
Restringir os clientes de e-mail permitidos (somente OAuth) imap_access_restriction.allowed_oauth_mail_client_list OAuthMailClientList
Acesso do usuário final > Sincronização do Google Workspace gmail.workspace_sync_for_outlook Ativar o Google Workspace Sync for Microsoft Outlook para meus usuários enable_google_workspace_sync_for_microsoft_outlook boolean
Acesso do usuário final > Encaminhamento automático gmail.auto_forwarding Permitir que os usuários encaminhem automaticamente os e-mails recebidos para outro endereço enable_auto_forwarding boolean
Configurações do usuário > Formato de nome gmail.name_format Permitir que os usuários personalizem essa configuração allow_custom_display_names boolean
Nome Sobrenome ou Sobrenome Nome default_display_name_format Enum:
  • FIRSTNAME_LASTNAME
  • LASTNAME_COMMA_FIRSTNAME
Acesso do usuário final > Permitir gateways de saída por usuário gmail.per_user_outbound_gateway Permitir que os usuários enviem e-mails por um servidor SMTP externo ao configurar um endereço "De" hospedado fora do domínio do e-mail allow_users_to_use_external_smtp_servers boolean
Acesso do usuário final > Lista de permissões de proxy de URL de imagem gmail.email_image_proxy_bypass Digite os padrões de URL de imagem. Os URLs correspondentes ignoram o proxy de imagem. image_proxy_bypass_pattern string[]
N/A enable_image_proxy boolean
User Settings > Mail Delegation gmail.mail_delegation Permitir que os usuários deleguem o acesso às caixas de correio a outros usuários no domínio enable_mail_delegation boolean
Permitir que os usuários personalizem essa configuração allow_custom_delegate_attribution boolean
Mostrar o proprietário da conta e o delegado que enviou o e-mail enable_delegate_attribution boolean
Mostrar apenas o proprietário da conta
Os usuários podem permitir que um grupo do Google acesse a caixa de e-mails enable_mailbox_group_delegation boolean

Subconfigurações do Gmail

Esta tabela mostra as subconfigurações do Gmail que são referenciadas por outras configurações do Gmail.

Nome da subconfiguração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
EmailAddressList N/A id string
Nome nome string
ADICIONAR LISTA DE ENDEREÇOS address_list AddressList
ADICIONAR LISTA BLOQUEADA blocked_address_list AddressList
AddressList Adicionar lista de endereços address AddressListEntry[]
AddressListEntry Endereço address string
Autenticação necessária (somente e-mails recebidos) require_address_verification boolean
BlockedSender Digite uma breve descrição que vai aparecer no resumo da configuração description string
Adicionar endereços ou domínios cujas mensagens você quer rejeitar automaticamente sender_blocklist StringValue[]
Digitar um aviso de rejeição personalizado rejection_response string
Ignorar esta configuração para mensagens recebidas de endereços ou domínios dentro destas listas de remetentes aprovados. bypass_approved_sender boolean
N/A bypass_approved_sender_allowlist StringValue[]
N/A rule_id string
SpamOverride Digite uma breve descrição que vai aparecer no resumo da configuração description string
Ser mais rigoroso ao filtrar spam. enable_aggressive_filtering boolean
Colocar spam na quarentena administrativa add_to_quarantine boolean
N/A quarantine_id integer
Ignorar filtros de spam para remetentes internos. bypass_internal_senders boolean
Ignorar filtros de spam para mensagens de remetentes ou domínios nas listas selecionadas. bypass_selected_senders boolean
N/A bypass_sender_allowlist StringValue[]
Ignorar filtros de spam e ocultar alertas para mensagens de remetentes ou domínios nas listas selecionadas. hide_warning_banner_from_selected_senders boolean
N/A hide_warning_banner_sender_allowlist StringValue[]
Ignorar filtros de spam e ocultar alertas para todas as mensagens de remetentes internos e externos (não recomendado). hide_warning_banner_for_all boolean
N/A rule_id string
ContentComplianceRule Digite uma breve descrição que vai aparecer no resumo da configuração description string
Mensagens de e-mail afetadas transição RuleConditions
Adicione expressões que descrevam o conteúdo que você quer pesquisar em cada mensagem match_expressions MatchExpression[]
Se QUALQUER UMA das seguintes opções coincidir com a mensagem match_any_expression boolean
Se as expressões acima corresponderem, faça o seguinte consequência RuleConsequences
N/A rule_id string
ObjectionableContentRule Digite uma breve descrição que vai aparecer no resumo da configuração description string
Mensagens de e-mail afetadas transição RuleConditions
Palavras censuráveis personalizadas objectionable_content_defined boolean
Digitar palavras objectionable_words string[]
Se as expressões acima corresponderem, faça o seguinte consequência RuleConsequences
N/A rule_id string
AttachmentComplianceRule Digite uma breve descrição que vai aparecer no resumo da configuração description string
Mensagens de e-mail afetadas transição RuleConditions
Adicione expressões que descrevam o conteúdo que você quer pesquisar em cada mensagem match_expressions MatchExpression[]
Se QUALQUER UMA das seguintes opções coincidir com a mensagem match_any_expression boolean
Se as expressões acima corresponderem, faça o seguinte consequência RuleConsequences
N/A rule_id string
RuleState N/A (para todas as regras) ativado boolean
rule_id string
RuleConditions Mensagens de e-mail afetadas Entrada affect_inbound_messages boolean
Saída affect_outbound_messages boolean
Interno - enviando affect_internal_sending_messages boolean
Interno - recebendo affect_internal_receiving_messages boolean
Listas de endereços Usar listas de endereços para ignorar ou controlar a aplicação desta configuração address_list_option enum:
  • NO_EFFECT
  • EXCLUDED
  • REQUIRED
Ignorar esta configuração para endereços / domínios específicos
Aplicar esta configuração apenas a endereços / domínios específicos
Usar lista existente / Criar ou editar lista address_lists StringValue[]
Tipos de contas afetadas Usuários account_type_user boolean
Grupos account_type_group boolean
Não reconhecida / pega-tudo account_type_unrecognized boolean
Filtro de envelope Afetar apenas remetentes de envelopes específicos envelope_sender_filter AddressMatcher (link em inglês)
Afetar apenas destinatários de envelopes específicos envelope_recipient_filter AddressMatcher (link em inglês)
AddressMatcher (link em inglês) Afetar apenas remetentes de envelopes específicos / Afetar apenas destinatários de envelopes específicos ativado boolean
Um único endereço de e-mail N/A address_match_type enum: EXACT
Endereço de e-mail exact_address_match_value string
Correspondência de padrão N/A address_match_type enum: REGEXP
Regexp regexp_match_value string
Associação a grupos (somente e-mails enviados) / Associação a grupos (somente e-mails recebidos) N/A address_match_type enum: GROUP_MEMBERSHIP
Selecionar grupos group_ids string[]
MatchExpression Correspondência de conteúdo simples N/A match_expression_type enum: SIMPLE_CONTENT
Conteúdo match_content string
Correspondência de conteúdo avançada N/A match_expression_type enum: ADVANCED_CONTENT
Conteúdo / Regex match_content string
N/A advanced_content_match AdvancedContentMatch
Correspondência de metadados match_expression_type enum: METADATA
metadata_match MetadataMatch
Correspondência de conteúdo predefinida match_expression_type enum: PREDEFINED_CONTENT
predefined_content_match PredefinedContentMatch
Tipo de arquivo match_expression_type enum: FILE_TYPE
file_type_match FileTypeMatch
Nome do arquivo N/A match_expression_type enum: FILE_NAME
O nome do arquivo de anexo contém file_name string
Tamanho da mensagem N/A match_expression_type enum: MESSAGE_SIZE
A mensagem geral (corpo + anexo) é maior do que (MB) message_size_threshold_in_megabytes integer
AdvancedContentMatch Local Cabeçalhos + corpo advanced_content_match_location enum: HEADERS_AND_BODY
Cabeçalhos completos enum: FULL_HEADERS
Body enum: BODY
Assunto enum: SUBJECT
Cabeçalho do remetente enum: SENDER_HEADER
Cabeçalho de destinatários enum: RECIPIENTS_HEADER
Remetente do envelope enum: ENVELOPE_SENDER
Qualquer destinatário do envelope enum: ANY_ENVELOPE_RECIPIENT
Mensagem bruta enum: RAW_MESSAGE
Tipo de correspondência Começa com advanced_content_match_type enum: STARTS_WITH
Termina com enum: ENDS_WITH
Contém texto enum: CONTAINS_TEXT
Não contém texto enum: NOT_CONTAINS_TEXT
Igual a enum: <code< code="" dir="ltr" translate="no">EQUALS </code<>
Está vazio enum: IS_EMPTY
Corresponde à regex enum: MATCHES_REGEXP
Não corresponde à regex enum: NOT_MATCHES_REGEXP
Corresponde a qualquer palavra enum: MATCH_ANY_WORD
Corresponde a todas as palavras enum: MATCH_ALL_WORDS
N/A regexp_match RegexpMatch
RegexpMatch Descrição do Regex description string
Número mínimo de correspondências min_match_count integer
MetadataMatch Atributo Autenticação de mensagens metadata_match_attribute enum: MESSAGE_AUTHENTICATION
IP de origem enum: SOURCE_IP
Transporte seguro (TLS) enum: TLS
Tamanho da mensagem enum: MESSAGE_SIZE
Criptografado com S/MIME enum: SMIME_ENCRYPTED
Assinadas pelo S/MIME enum: SMIME_SIGNED
Modo confidencial do Gmail enum: CONFIDENTIAL_MODE
Spam enum: SPAM
Tipo de correspondência o intervalo a seguir source_ip_range string
O seguinte (MB) message_size_in_megabytes integer
A mensagem está autenticada metadata_match_type enum: MESSAGE_AUTHENTICATED
A mensagem não está autenticada enum: MESSAGE_NOT_AUTHENTICATED
O IP de origem está dentro de enum: SOURCE_IP_IN_RANGE
O IP de origem não está dentro enum: SOURCE_IP_NOT_IN_RANGE
A conexão está criptografada via TLS enum: TLS_ENCRYPTED
A conexão não está criptografada via TLS enum: TLS_NOT_ENCRYPTED
O tamanho da mensagem é maior que enum: MESSAGE_SIZE_GREATER_THAN
O tamanho da mensagem é menor que enum: MESSAGE_SIZE_LESS_THAN
A mensagem foi criptografada com S/MIME enum: MESSAGE_IS_SMIME_ENCRYPTED
A mensagem não foi criptografada com S/MIME enum: MESSAGE_IS_NOT_SMIME_ENCRYPTED
A mensagem é assinada pelo S/MIME enum: MESSAGE_IS_SMIME_SIGNED
A mensagem não está assinada pelo S/MIME enum: MESSAGE_IS_NOT_SMIME_SIGNED
A mensagem está no modo confidencial do Gmail enum: MESSAGE_IS_IN_CONFIDENTIAL_MODE
A mensagem não está no modo confidencial do Gmail enum: MESSAGE_IS_NOT_IN_CONFIDENTIAL_MODE
Malware detectado no sandbox de segurança enum: MALWARE_DETECTED_FROM_SECURITY_SANDBOX
PredefinedContentMatch N/A (seletor de correspondência de conteúdo predefinido) predefined_content_match_name string
Número mínimo de correspondências min_match_count integer
Limite de confiança confidence_threshold enum:
  • MEDIUM
  • HIGH
FileTypeMatch Documentos do Office criptografados encrypted_office_documents boolean
Documentos do Office que não estão criptografados unencrypted_office_documents boolean
Vídeo e multimídia vídeo boolean
Música e som música boolean
Imagens imagem boolean
Arquivos compactados e criptografados compressed_encrypted_files boolean
Arquivos compactados e arquivados que não estão criptografados compressed_unencrypted_files boolean
Tipos de arquivo personalizados: fazer a correspondência de arquivos com base na extensão do nome custom_file_extensions string[]
Também fazer a correspondência de arquivos com base no formato match_file_format boolean
RuleConsequences Modificar mensagem N/A rule_consequence_type enum: MODIFY_MESSAGE
N/A primary_delivery Entrega
Adicionar mais destinatários deliver_to_additional_recipients boolean
Destinatários bcc_deliveries Entrega[]
Entrega Adicionar cabeçalho X-Gm-Original-To add_x_gm_original_to_header boolean
Adicionar os cabeçalhos X-Gm-Spam e X-Gm-Phishy add_x_gm_spam_header boolean
Adicionar cabeçalhos personalizados add_custom_headers boolean
Cabeçalhos personalizados custom_headers string[]
Adicionar um assunto personalizado prepend_custom_subject boolean
Digitar um novo prefixo de assunto custom_subject string
Mudar rota change_default_route boolean
Também redirecionar spam reroute_spam boolean
Suprimir devoluções deste destinatário suppress_bounces_from_recipient boolean
N/A (seletor de roteamento) normal_routing boolean
Alterar destinatário do envelope N/A change_envelope_recipient boolean
Substituir destinatário replace_envelope_recipient_type enum: REPLACE_ADDRESS
recipient_address string
Substituir nome de usuário replace_envelope_recipient_type enum: REPLACE_USER
recipient_user string
Substituir domínio replace_envelope_recipient_type enum: REPLACE_DOMAIN
recipient_domain string
Ignorar o filtro de spam para esta mensagem bypass_spam_filter boolean
Remover anexos da mensagem remove_attachments boolean
Adicione este texto para avisar aos destinatários que os anexos foram removidos aviso_de_remoção_de_anexo string
Exigir transporte seguro (TLS) require_tls boolean
Criptografar a mensagem se ela não estiver criptografada (S/MIME) encrypt_outgoing_messages boolean
Rejeitar mensagem se não for possível assinar e criptografar bounce_unencrypted_messages boolean
Não enviar spam para este destinatário do_not_deliver_spam_to_recipient boolean
OAuthMailClientList Restringir os clientes de e-mail permitidos (somente OAuth) oauth_mail_client OAuthMailClient[]
OAuthMailClient N/A oauth_mail_client_id string

Configurações do chat

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Google Chat Histórico de chats chat.chat_history O histórico está ATIVADO/DESATIVADO history_on_by_default boolean
Permitir que os usuários mudem a configuração do histórico allow_user_modification boolean
Compartilhamento de arquivos do chat chat.chat_file_sharing Compartilhamento externo de arquivos external_file_sharing Enum:
  • ALL_FILES
  • IMAGES_ONLY
  • NO_FILES
  • FILE_SHARING_OPTION_UNSPECIFIED
internal_file_sharing mesmo
Histórico de espaços chat.space_history Configurações do histórico de conversas nos espaços history_state Enum:
  • DEFAULT_HISTORY_ON
  • DEFAULT_HISTORY_OFF
  • HISTORY_ALWAYS_ON
  • HISTORY_ALWAYS_OFF
  • HISTORY_STATE_UNSPECIFIED
Configurações de chat externo chat.external_chat_restriction Permitir que os usuários enviem mensagens fora da organização em chats e espaços allow_external_chat boolean
external_chat_restriction Enum:
  • NO_RESTRICTION
  • TRUSTED_DOMAINS
  • RESTRICTION_UNSPECIFIED
Apps de chat chat.chat_apps_access Permitir que os usuários instalem apps do Chat enable_apps boolean
Permitir que os usuários adicionem e usem webhooks de entrada enable_webhooks boolean

Configurações do Drive e dos Documentos

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Drive e Documentos Configurações de compartilhamento > Opções de compartilhamento drive_and_docs.external_sharing Selecione o nível mais alto de compartilhamento fora de $CUSTOMER_NAME que você quer permitir external_sharing_mode Enum:
  • DISALLOWED
  • ALLOWLISTED_DOMAINS
  • ALLOWED
Permitir que os usuários em $ORG_UNIT_NAME recebam arquivos de usuários ou drives compartilhados fora de $CUSTOMER_NAME allow_receiving_external_files Booleano
Avisar quando arquivos de usuários ou drives compartilhados em $ORG_UNIT_NAME forem compartilhados com usuários em domínios na lista de permissões warn_for_sharing_outside_allowlisted_domains Booleano
Permitir que os usuários em $ORG_UNIT_NAME recebam arquivos de usuários ou drives compartilhados fora dos domínios na lista de permissões allow_receiving_files_outside_allowlisted_domains Booleano
Permitir que usuários ou drives compartilhados em $ORG_UNIT_NAME compartilhem itens com usuários que não são do Google em domínios confiáveis usando o compartilhamento com visitantes allow_non_google_invites_in_allowlisted_domains Booleano
Avisar quando arquivos que pertencem a usuários ou drives compartilhados em $ORG_UNIT_NAME forem compartilhados fora de $CUSTOMER_NAME warn_for_external_sharing Booleano
Permitir que usuários ou drives compartilhados em $ORG_UNIT_NAME compartilhem itens com pessoas fora de $CUSTOMER_NAME que não usam uma Conta do Google allow_non_google_invites Booleano
Quando o compartilhamento fora de $CUSTOMER_NAME é permitido, os usuários de $ORG_UNIT_NAME podem tornar os arquivos e o conteúdo da Web publicado visível para qualquer pessoa com o link allow_publishing_files Booleano
Quando um usuário compartilha um arquivo por meio de um produto do Google que não seja o Documentos nem o Drive (por exemplo, colando um link no Gmail), o Google verifica se os destinatários têm acesso. Se eles não tiverem acesso, quando for possível, o Google perguntará se o usuário quer compartilhar o arquivo com access_checker_suggestions Enum:
  • RECIPIENTS_OR_AUDIENCE_OR_PUBLIC
  • RECIPIENTS_OR_AUDIENCE
  • RECIPIENTS_ONLY
Selecione quem terá permissão para distribuir o conteúdo na unidade organizacional $ORG_UNIT_NAME fora do cliente $CUSTOMER_NAME. Isso restringe quem pode fazer upload ou mover conteúdo para drives compartilhados de outra organização allowed_parties_for_distributing_content Enum:
  • ALL_ELIGIBLE_USERS
  • ELIGIBLE_INTERNAL_USERS
  • NONE
Configurações de compartilhamento > Padrão de acesso geral drive_and_docs.general_access_default Quando os usuários em $ORG_UNIT_NAME criarem itens, o acesso padrão será default_file_access Enum:
  • PRIVATE_TO_OWNER
  • PRIMARY_AUDIENCE_WITH_LINK
  • PRIMARY_AUDIENCE_WITH_LINK_OR_SEARCH
Configurações de compartilhamento > Criação do drive compartilhado drive_and_docs.shared_drive_creation Impedir que os usuários na unidade organizacional $ORG_UNIT_NAME criem novos drives compartilhados allow_shared_drive_creation Booleano (a resposta da API retorna o oposto do valor da interface)
Quando os usuários em $ORG_UNIT_NAME criarem um drive compartilhado, ele será atribuído à unidade organizacional a seguir org_unit_for_new_shared_drives Enum:
  • CREATOR_ORG_UNIT
  • CUSTOM_ORG_UNIT
Unidade organizacional selecionada custom_org_unit String
Permitir que os participantes com acesso de administrador substituam as configurações abaixo allow_managers_to_override_settings Booleano
Permitir que usuários fora de $CUSTOMER_NAME acessem arquivos em drives compartilhados allow_external_user_access Booleano
Permitir que pessoas que não são participantes do drive compartilhado sejam adicionadas a arquivos allow_non_member_access Booleano
Permitir que leitores e comentaristas façam o download, a impressão e a cópia de arquivos allowed_parties_for_download_print_copy Enum:
  • ALL (quando a caixa de seleção na interface está marcada)
  • EDITORS_ONLY (quando a caixa de seleção na interface está desmarcada)
Permitir que administradores de conteúdo compartilhem pastas allow_content_managers_to_share_folders Booleano
Configurações de compartilhamento > Atualização de segurança para arquivos drive_and_docs.file_security_update Aplicar esta atualização torna os links de arquivo mais seguros. Isso talvez faça com que os usuários recebam solicitações de acesso aos arquivos. security_update Enum:
  • APPLY_TO_IMPACTED_FILES
  • REMOVE_FROM_IMPACTED_FILES
Permitir que os usuários removam/apliquem a atualização de segurança para os próprios arquivos ou arquivos que eles gerenciam allow_users_to_manage_update Booleano
Recursos e aplicativos > SDK do Drive drive_and_docs.drive_sdk Permitir que os usuários acessem o Google Drive com a API Drive SDK enable_drive_sdk_api_access Booleano
Google Drive para computador > Ativar o Drive para computador drive_and_docs.drive_for_desktop Permitir o Google Drive para computador na sua organização allow_drive_for_desktop Booleano
Permitir o Google Drive para computador apenas em dispositivos autorizados restrict_to_authorized_devices Booleano
Mostrar o link de download do Google Drive para computador show_download_link Booleano
Permitir que os usuários ativem o acesso em tempo real no Microsoft Office usando o Google Drive para computador allow_real_time_presence Booleano

Configurações do Meet

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Google Meet Configurações de vídeo do Meet > Gravação meet.video_recording Permitir que as pessoas gravem as reuniões. enable_recording boolean
Configurações de segurança do Meet > Domínio meet.safety_domain Quem pode participar de reuniões criadas pela sua organização. users_allowed_to_join Enum:
  • SAME_ORGANIZATION_ONLY
  • LOGGED_IN
  • ALL
Configurações de segurança do Meet > Acesso meet.safety_access As reuniões ou ligações de que os usuários na organização podem participar. As "Restrições de chamadas recebidas" podem limitar ainda mais as chamadas que os usuários podem receber. meetings_allowed_to_join Enum:
  • SAME_ORGANIZATION_ONLY
  • ANY_WORKSPACE_ORGANIZATION
  • ALL
Configurações de segurança do Meet > Gerenciamento de organizadores meet.safety_host_management Gerenciamento de organizadores padrão enable_host_management Booleano
Configurações de segurança do Meet > Aviso para identificar participantes externos meet.safety_external_participants Indica quem não faz parte da "Organização" ou não teve a identidade confirmada. enable_external_label Booleano

Configurações de sites

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Sites Novo Sites > Criação e edição de sites sites.sites_creation_and_modification Permitir que os usuários criem novos sites allowSitesCreation Booleano
Os usuários podem/não podem editar sites allowSitesModification Booleano

Configurações do Grupos para empresas

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Grupos para empresas Configurações de compartilhamento > Opções de compartilhamento groups_for_business.groups_sharing Definir políticas para mudar as configurações de compartilhamento de grupos collaborationCapability Enum:
  • ANYONE_CAN_ACCESS
  • DOMAIN_USERS_ONLY
Como criar grupos createGroupsAccessLevel Enum:
  • ADMIN_ONLY
  • USERS_IN_DOMAIN
  • ANYONE_CAN_CREATE
Os proprietários de grupos podem permitir participantes externos ownersCanAllowExternalMembers Booleano
Os proprietários de grupos podem permitir o recebimento de e-mails de fora da organização ownersCanAllowIncomingMailFromPublic Booleano
Padrão de permissão para ver conversas viewTopicsDefaultAccessLevel Enum:
  • OWNERS
  • MANAGERS
  • GROUP_MEMBERS
  • DOMAIN_USERS
  • ANYONE_CAN_VIEE_TOPICS
Os proprietários de grupos podem ocultar grupos do diretório ownersCanHideGroups Booleano
Ocultar grupos recém-criados do diretório newGroupsAreHidden Booleano
Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Ajustes da conta Opções de compartilhamento cloud_sharing_options.cloud_data_sharing Opções de compartilhamento do Google Cloud Platform sharingOptions Enum:
  • UNSUPPORTED
  • ENABLED
  • DISABLED

Configurações da Sala de Aula

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Sala de Aula Configurações gerais > Permissões para professores classroom.teacher_permissions Quem pode criar turmas whoCanCreateClasses Enum:
  • ANYONE_IN_DOMAIN
  • ALL_PENDING_AND_VERIFIED_TEACHERS
  • VERIFIED_TEACHERS_ONLY
Configurações gerais > Acesso dos responsáveis classroom.guardian_access Permitir que familiares e responsáveis acessem informações do Google Sala de Aula allowAccess Booleano
Quem pode gerenciar familiares e responsáveis whoCanManageGuardianAccess Enum:
  • VERIFIED_TEACHERS_AND_DOMAIN_ADMINS
  • DOMAIN_ADMINS_ONLY
Configurações da turma > Sobre a participação em turmas classroom.class_membership Quem pode participar de turmas no seu domínio whoCanJoinClasses Enum:
  • ANYONE_IN_DOMAIN
  • ANYONE_IN_ALLOWLISTED_DOMAINS
  • ANY_GOOGLE_WORKSPACE_USER
  • ANYONE
Turmas das quais os usuários no seu domínio podem participar whichClassesCanUsersJoin Enum:
  • CLASSES_IN_DOMAIN
  • CLASSES_IN_ALLOWLISTED_DOMAINS
  • ANY_GOOGLE_WORKSPACE_CLASS
Acesso aos dados > API Classroom classroom.api_data_access Os usuários podem autorizar apps a acessar os dados deles no Google Sala de Aula enableApiAccess Booleano
Relatórios de originalidade > Correspondências na escola classroom.originality_reports Ativar correspondências na escola dos relatórios de originalidade enableOriginalityReportsSchoolMatches Booleano
Cancelamento de inscrição de estudante > Permissões de cancelamento de inscrição classroom.student_unenrollment Quem pode cancelar a inscrição de estudantes em turmas whoCanUnenrollStudents Enum
  • STUDENTS_AND_TEACHERS
  • TEACHERS_ONLY
Importação de escala > Configurações classroom.roster_import Importação de listas de estudantes rosterImportOption Enum:
  • OFF
  • ON_CLEVER

Configurações da agenda

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Agenda Configurações avançadas > Agendamentos de horários com pagamentos calendar.appointment_schedules Permitir que os usuários do agendamento de horários solicitem pagamento por agendamentos usando as contas do provedor de pagamento. enable_payments boolean
Configurações de compartilhamento > Convites externos calendar.external_invitations Avisar os usuários quando convidar convidados de fora do domínio ORGANIZATION_UNIT_NAME warn_on_invite boolean
Gerenciamento de interoperabilidade do Agenda > Disponibilidade do Exchange na Agenda calendar.interoperability Permitir que o Google Agenda mostre a disponibilidade dos usuários do Exchange enable_interoperability boolean
Mostrar detalhes do evento enable_full_event_details boolean
Gerenciamento do Calendar Interop > Reserva de recursos do Exchange calendar.interoperability Ativar o Google Agenda para reservar salas do Microsoft Exchange enable_exchange_room_booking boolean
Configurações de compartilhamento > Opções de compartilhamento externo para agendas principais calendar.primary_calendar_max_allowed_external_sharing Fora de ORGANIZATION_UNIT_NAME: definir o que o usuário pode fazer nas agendas principais 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
Configurações de compartilhamento > Opções de compartilhamento externo para agendas secundárias calendar.secondary_calendar_max_allowed_external_sharing Fora de <Org name>: definir o que o usuário pode fazer nas agendas secundárias 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

Configurações de regras de proteção de dados

Para ter uma visão geral das regras e dos detectores de proteção de dados, consulte Criar regras e detectores de conteúdo personalizados para a DLP do Drive.

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Proteção de dados Segurança > Controle de dados e acesso > Proteção de dados > Gerenciar regras rule.dlp Nome display_name String
Descrição description String
Apps gatilhos String[]: lista de strings de acionadores específicas do app. A lista de acionadores de app disponíveis está disponível na seção "Acionadores" a seguir.
Condições transição String: expressão da Common Expression Language (CEL) das condições de dados que a regra verifica. A sintaxe do CEL e alguns exemplos comuns são fornecidos na seção "Condições" a seguir.
Actions ação Estrutura: objeto aninhado que representa ações específicas do app a serem realizadas quando as condições forem atendidas. As ações disponíveis por acionador de app são fornecidas na seção "Ações" a seguir.
Estado estado Enum:
  • ACTIVE
  • INACTIVE
Criada create_time Carimbo de data/hora
Última modificação update_time Carimbo de data/hora
Metadados específicos do tipo de regra rule_type_metadata Struct: objeto aninhado que representa metadados específicos do tipo de regra. Para regras de proteção de dados, contém o nível de gravidade dos eventos acionados.

Gatilhos

A lista de aplicativos disponíveis e os gatilhos deles.

  • "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"

Condições

Para representar condições de dados, a API usa expressões da Common Expression Language (CEL). Cada condição segue o padrão de {content type}.{content to scan for}({additional scan parameters}). Por exemplo, all_content.contains('apple') representa uma condição de dados que corresponde se algum do conteúdo verificado (por exemplo, documento do Drive, mensagem de chat etc.) contém a subsequência apple.

Tipo de conteúdo

A lista de tipos de conteúdo disponíveis, correspondentes às configurações correspondentes de nomes iguais no Admin Console.

  • 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
  • assunto
  • sugestão
  • target_user
  • título
  • to_header_recipients
  • url
  • url_category

Conteúdo a ser verificado

Lista de conteúdo disponível para verificação, correspondente às configurações correspondentes de nomes iguais no Admin Console.

  • 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}})
    • Corresponde à opção corresponde a um tipo de dados predefinido no Admin Console.
    • {detector name} indica o tipo de dados predefinido a ser verificado, que pode ser um dos tipos de informações integrados compatíveis com o Cloud DLP: https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. Por exemplo, CREDIT_CARD_NUMBER ou US_SOCIAL_SECURITY_NUMBER
    • {likelihood} indica o limite de probabilidade da correspondência. Por exemplo, google.privacy.dlp.v2.Likelihood.LIKELY corresponde ao limite Alto no Admin Console.
  • matches_regex_detector({detector name}, {minimum_match_count: {count}})
    • Corresponde à opção corresponde à expressão regular no Admin Console.
    • {detector name} é o nome do recurso da política que representa o detector de expressão regular. Consulte a seção Detector de proteção de dados para saber como consultar políticas do detector na API.
  • matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
    • Corresponde à opção corresponde às palavras da lista de palavras no Admin Console.
    • {detector name} é o nome do recurso da política que representa o detector de lista de palavras. Consulte a seção Detector de proteção de dados para saber como consultar políticas do detector na API.
  • matches_web_category({category})
    • Corresponde à opção Categoria de URL correspondente no Admin Console para o acionador de URL visitado do Chrome.
    • {category} indica a categoria de URL aceita pela configuração do Admin Console. Para conferir a lista de categorias disponíveis e as representações de API, consulte Categorias de URL.

Condições compostas

Várias condições básicas podem ser misturadas com os operadores AND (&&), OR (||) ou NOT (!) para formar uma condição composta. Por exemplo, "all_content.contains('apple') && all_content.contains('banana')" representa uma condição que corresponde se algum do conteúdo digitalizado contém as substrings "maçã" e "banana".

Ações

Cada aplicativo especifica a ação a ser realizada quando a condição de dados corresponder a uma mensagem aninhada. Por exemplo, { "driveAction" { "warnUser" { } } } representa uma ação do Drive que avisa os usuários sobre o compartilhamento externo. As ações específicas do aplicativo disponíveis são as seguintes:

Aplicativo Tecla de ação Subação Legenda do Admin Console
Drive driveAction blockAccess Bloquear o compartilhamento externo
warnUser Alertar sobre compartilhamento externo
auditOnly Nenhuma ação
restrictCopyPrintDownload Desativar o download, a impressão e a cópia
applyLabels Aplicar rótulos de classificação
Gmail gmailAction blockContent Bloquear mensagem
warnUser Alertar os usuários
auditOnly Somente auditoria
quarantineMessage Colocar mensagem em quarentena
Chat chatAction blockContent Bloquear mensagem
warnUser Alertar os usuários
auditOnly Somente auditoria
Chrome chromeAction blockContent Bloquear
warnUser Permitir com aviso

Metadados específicos do tipo de regra

Esse atributo contém os metadados específicos do tipo de regra. Para regras de proteção de dados, ele contém a gravidade do evento de alerta quando o evento é informado no painel de segurança e na Central de alertas. Exemplo de valor dos metadados que representa a gravidade de alerta BAIXO:

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

Configurações dos detectores de proteção de dados

Para ter uma visão geral das regras e dos detectores de proteção de dados, consulte Criar regras e detectores de conteúdo personalizados para a DLP do Drive.

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Proteção de dados Segurança > Acesso e controle de dados > Proteção de dados > Gerenciar detectores detector.regular_expression detector.word_list Nome display_name String
Descrição description String
Expressão regular regular_expression Struct: contém a string de expressão regular. Só defina se o tipo de detector for detector.regular_expression.
Lista de palavras word_list String: contém a lista de strings de palavras. Só será definido se o tipo de detector for detector.word_list.
Criada create_time Carimbo de data/hora
Última modificação update_time Carimbo de data/hora

Configurações de regras de alerta definidas pelo sistema

Esta seção descreve as regras de alerta definidas pelo sistema do Google Workspace. A API retorna apenas alertas definidos pelo sistema que são modificados do valor padrão pelo administrador.

Página no Admin Console Configuração específica no Admin Console Tipo de configuração da API Policy Legenda do Admin Console Nome do campo da API Policy Tipo de dado
Proteção de dados Regras (para o tipo de regra "definida pelo sistema") rule.system_defined_alerts Nome display_name String
Descrição description String
Actions ação Estrutura: objeto aninhado que representa as configurações de notificação quando o alerta definido pelo sistema é acionado. Confira os detalhes na seção "Ações" a seguir.
Estado estado Enum:
  • ACTIVE
  • INACTIVE
Criada create_time Carimbo de data/hora
Última modificação update_time Carimbo de data/hora

Ações

As regras de alerta definidas pelo sistema têm uma única ação que indica as configurações de notificação do alerta.

Tecla de ação Subação Legenda do Admin Console
alertCenterAction alertCenterConfig Enviar para a Central de alertas
destinatários Enviar notificações por e-mail