Integre o Google Workspace com o Google SecOps

Este documento explica como integrar o Google Workspace com o Google Security Operations (Google SecOps).

Versão da integração: 19.0

Exemplos de utilização

A integração do Google Workspace com o Google SecOps pode ajudar a resolver o seguinte exemplo de utilização:

  • Desativação de utilizadores e segurança da conta: use as capacidades do Google SecOps para acionar um fluxo de trabalho para revogar o acesso ao Google Workspace, suspender contas e encaminhar emails de utilizadores desativados para outro funcionário.

Antes de começar

Antes de configurar a integração do Google Workspace no Google SecOps, conclua os seguintes passos pré-requisitos:

  1. Crie uma conta de serviço.
  2. Crie uma chave JSON.
  3. Crie uma função personalizada para a integração.
  4. Atribua a função personalizada a um utilizador.
  5. Delegue autoridade ao nível do domínio na sua conta de serviço.
  6. Ative a API Admin SDK para o seu projeto.

Criar uma conta de serviço

Para criar uma conta de serviço, conclua os passos seguintes:

  1. Na Google Cloud consola, aceda à página Credenciais.

    Aceder a Credenciais

  2. No menu Criar credenciais, selecione Conta de serviço.

  3. Em Detalhes da conta de serviço, introduza um nome no campo Nome da conta de serviço.

  4. Opcional: edite o ID da conta de serviço.

  5. Clique em Criar e continuar. É apresentado um ecrã Autorizações.

  6. Clique em Continuar. É apresentado um ecrã Principais com acesso.

  7. Clique em Concluído.

Conceda funções do Google Cloud IAM à conta de serviço

Para garantir que a conta de serviço tem todas as autorizações necessárias no seu projeto, atribua as seguintes funções de IAM: Google Cloud

  1. Na Google Cloud consola, aceda a IAM e administrador > IAM.

  2. Clique em Conceder acesso.

  3. No campo Novos membros, introduza o endereço de email da conta de serviço que criou.

  4. Na lista Selecionar uma função, pesquise e selecione a função Service Account Token Creator (roles/iam.serviceAccountTokenCreator).

  5. Clique em Guardar.

Crie uma chave JSON

Para criar uma chave JSON, conclua os seguintes passos:

  1. Selecione a sua conta de serviço e aceda a Chaves.
  2. Clique em Adicionar chave.
  3. Selecione Criar nova chave.
  4. Para o tipo de chave, selecione JSON e clique em Criar. É apresentada uma caixa de diálogo Chave privada guardada no seu computador e uma cópia da chave privada é transferida para o seu computador.

Crie uma função personalizada para a integração

  1. Na consola do administrador Google, aceda a Conta > Funções de administrador.
  2. Clique em Criar nova função.
  3. Atribua um nome à nova função personalizada e clique em Continuar.
  4. Na página Selecionar privilégios, aceda à secção de privilégios da API Admin.

  5. Em Privilégios da API do gestor, selecione os seguintes privilégios:

    • Unidades organizacionais
    • Utilizadores
    • Grupos

  6. Clique em Continuar.

  7. Para criar uma nova função personalizada, clique em Criar função.

Atribua a função personalizada a um utilizador

  1. Para criar um novo utilizador, aceda à página Diretório > Utilizadores.
  2. Adicione um novo utilizador associado à conta de serviço.
  3. Abra as definições do utilizador recém-criado. O separador da conta de utilizador é aberto.
  4. Clique em Funções e privilégios de administrador.
  5. Clique em editar Editar.
  6. Selecione a função personalizada que criou.
  7. Para a função selecionada, altere o botão para Atribuído.

Delegue autoridade ao nível do domínio na sua conta de serviço

  1. Na consola do administrador Google do seu domínio, aceda a Menu principal > Segurança > Acesso e controlo de dados > Controlos de API.
  2. No painel Delegação ao nível do domínio, selecione Gerir delegação ao nível do domínio.
  3. Clique em Adicionar novo.
  4. No campo ID de cliente, introduza o ID de cliente obtido nos passos de criação da conta de serviço anteriores.

  5. No campo Âmbitos de OAuth, introduza a seguinte lista de âmbitos separados por vírgulas necessários para a sua aplicação:

    https://mail.google.com/,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/admin.directory.user,
https://www.googleapis.com/auth/admin.directory.group.member,
https://www.googleapis.com/auth/admin.directory.customer.readonly,
https://www.googleapis.com/auth/admin.directory.domain.readonly,
https://www.googleapis.com/auth/admin.directory.group,
https://www.googleapis.com/auth/admin.directory.orgunit,
https://www.googleapis.com/auth/admin.directory.user.alias,
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly,
https://www.googleapis.com/auth/apps.groups.settings,
https://www.googleapis.com/auth/admin.directory.user.security,
https://www.googleapis.com/auth/admin.reports.audit.readonly,
https://www.googleapis.com/auth/admin.directory.device.chromebrowsers.readonly,
https://www.googleapis.com/auth/chrome.management.policy,
https://www.googleapis.com/auth/chrome.management.appdetails.readonly

  6. Clique em Autorizar.

Ative a API Admin SDK para o seu projeto

  1. Na Google Cloud consola, aceda a APIs e serviços.

    Aceda a APIs e serviços

  2. Clique em Ativar APIs e serviços.

  3. Ative a API do SDK de administrador para o seu projeto.

Parâmetros de integração

A integração do Google Workspace requer os seguintes parâmetros:

Parâmetro Descrição
Verify SSL

Opcional.

Se esta opção estiver selecionada, a integração valida o certificado SSL quando se liga ao Google Workspace.

Selecionado por predefinição.
User's Service Account JSON

Opcional.

O conteúdo do ficheiro JSON da chave da conta de serviço.

Pode configurar este parâmetro ou o parâmetro Workload Identity Email.

Para configurar este parâmetro, forneça o conteúdo completo do ficheiro JSON da chave da conta de serviço que transferiu quando criou uma conta de serviço.
Delegated Email

Obrigatório.

O endereço de email que a integração deve usar.
Workload Identity Email

Opcional.

O endereço de email do cliente da sua conta de serviço.

Pode configurar este parâmetro ou o parâmetro User's Service Account JSON.

Para usar a identidade de contas de serviço com a federação de identidades da carga de trabalho, conceda a função Service Account Token Creator à sua conta de serviço. Para mais detalhes sobre as identidades de cargas de trabalho e como trabalhar com elas, consulte Identidades para cargas de trabalho.

Para obter instruções sobre como configurar uma integração no Google SecOps, consulte o artigo Configurar integrações.

Se necessário, pode fazer alterações numa fase posterior. Depois de configurar uma instância de integração, pode usá-la em manuais de soluções. Para mais informações sobre como configurar e suportar várias instâncias, consulte o artigo Suporte de várias instâncias.

Ações

Para mais informações sobre ações, consulte os artigos Responda a ações pendentes a partir de O seu espaço de trabalho e Realize uma ação manual.

Adicione membros ao grupo

Use a ação Adicionar membros ao grupo para adicionar utilizadores a um grupo.

Esta ação é executada na entidade User.

A ação Adicionar membros ao grupo resolve os seguintes exemplos de utilização:

  • Admissão e exclusão automatizadas.
  • Resposta a incidentes através da concessão de acesso temporário.
  • Colaboração dinâmica em projetos.

Dados de ações

A ação Adicionar membros ao grupo requer os seguintes parâmetros:

Parâmetro Descrição
Group Email Address

Obrigatório.

Um endereço de email do grupo ao qual adicionar novos membros.

User Email Addresses

Opcional.

Uma lista separada por vírgulas de utilizadores a adicionar ao grupo.

A ação executa valores que configura para este parâmetro juntamente com a entidade User.

Resultados da ação

A ação Adicionar membros ao grupo fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Resultado do script Disponível
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Adicionar membros ao grupo:

Nome do resultado do script Valor
is_success True ou False

Bloquear extensão

Use a ação Bloquear extensão para bloquear uma extensão do Chrome especificada numa unidade organizacional.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Bloquear extensão requer os seguintes parâmetros:

Parâmetro Descrição
Organization Unit Name

Obrigatório.

O nome da unidade organizacional na qual bloquear a extensão.
Extension ID

Obrigatório.

O ID da extensão a bloquear.

Resultados da ação

A ação Bloquear extensão fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte mostra as saídas de resultados JSON recebidas quando usa a ação Bloquear extensão:

[
        {
            "targetKey": {
                "targetResource": "orgunits/example-org-unit-id",
                "additionalTargetKeys": {
                    "app_id": "chrome:exampleextensionid"
                }
            },
            "value": {
                "policySchema": "chrome.users.apps.InstallType",
                "value": {
                    "appInstallType": "BLOCKED"
                }
            },
            "sourceKey": {
                "targetResource": "orgunits/example-org-unit-id"
            },
            "addedSourceKey": {
                "targetResource": "orgunits/example-org-unit-id"
            }
        }
]
Mensagens de saída

A ação Bloquear extensão pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully blocked extension EXTENSION_ID in Organization Unit ORGANIZATION_NAME using Google Workspace.

 A ação foi bem-sucedida.
Error executing action "Block Extension". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte indica o valor da saída do resultado do script quando usa a ação Bloquear extensão:

Nome do resultado do script Valor
is_success True ou False

Criar grupo

Use a ação Criar grupo para criar grupos para a sua organização na consola do administrador Google, na API Groups ou na Sincronização de diretórios do Google Cloud como administrador do Grupos do Google Workspace.

Se usar o Groups for Business, também pode criar grupos para a sua organização no Grupos do Google.

Esta ação é executada em todas as entidades do Google SecOps.

Pode usar a ação Criar grupo nos seguintes exemplos de utilização:

  • Crie equipas de resposta a incidentes.
  • Conter campanhas de phishing.
  • Integre novos utilizadores e grupos de utilizadores.
  • Colaborar em projetos.
  • Configure o controlo de acesso para dados confidenciais.

Dados de ações

A ação Create Group requer os seguintes parâmetros:

Parâmetro Descrição
Email Address

Obrigatório.

Um endereço de email do novo grupo.
Name

Opcional.

Um nome do novo grupo.
Description

Opcional.

Uma descrição do novo grupo.

Resultados da ação

A ação Criar grupo fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Create Group:

[
   {
      "kind":"admin#directory#group",
      "id":"ID",
      "etag":"TAG/var>",
      "email":"user@example.com",
      "name":"example",
      "description":"",
      "adminCreated":"True"
   }
]
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Create Group:

Nome do resultado do script Valor
is_success True ou False

Criar UO

Use a ação Criar UO para criar uma nova unidade organizacional (UO).

Esta ação é executada em todas as entidades do Google SecOps.

Pode usar a ação Criar UO para resolver os seguintes exemplos de utilização:

  • Integre novos departamentos.
  • Isolar contas comprometidas.
  • Implemente políticas baseadas na geografia para a residência dos dados.

Dados de ações

A ação Create OU requer os seguintes parâmetros:

Parâmetro Descrição
Customer ID

Obrigatório.

Um ID exclusivo da conta do Google Workspace do cliente.

Para configurar a conta customerId, também pode usar o seguinte marcador de posição: my_customer.
Name

Opcional.

Um nome da nova UO.
Description

Opcional.

Uma descrição da nova UO.
Parent OU Path

Obrigatório.

Um caminho completo para a UO principal de uma nova UO.

Resultados da ação

A ação Create OU fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Create OU:

[
   {
      "kind":"admin#directory#orgUnit",
      "etag":"TAG",
      "name":"example",
      "orgUnitPath":"/example_folder",
      "orgUnitId":"id:ID",
      "parentOrgUnitPath":"/",
      "parentOrgUnitId":"id:ID"
   }
]
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Create OU:

Nome do resultado do script Valor
is_success True ou False

Criar utilizador

Use a ação Criar utilizador para criar um novo utilizador.

Quando adiciona um utilizador à sua conta do Google Workspace, atribui-lhe um endereço de email integrado no domínio da sua empresa e uma conta que pode usar para aceder aos serviços do Google Workspace.

Esta ação é executada em todas as entidades do Google SecOps.

Pode usar a ação Criar utilizador para resolver os seguintes exemplos de utilização:

  • Automatizar a integração dos novos utilizadores.
  • Disponibilize acesso temporário para funcionários contratados.
  • Use as caixas de areia para a resposta a incidentes.

Dados de ações

A ação Criar utilizador requer os seguintes parâmetros:

Parâmetro Descrição
Given Name

Obrigatório.

O nome próprio do utilizador.
Family Name

Obrigatório.

O apelido do utilizador.
Password

Obrigatório.

A palavra-passe do novo utilizador.
Email Address

Obrigatório.

O endereço de email principal do utilizador.
Phone

Opcional.

O número de telefone do utilizador.
Gender

Opcional.

O género do utilizador.

Os valores válidos são os seguintes: female, male, other, unknown.
Department

Opcional.

O nome do departamento do utilizador.
Organization

Opcional.

O nome da organização do utilizador.
Change Password At Next Login

Opcional.

Se esta opção estiver selecionada, o sistema exige que o utilizador altere a respetiva palavra-passe na próxima tentativa de início de sessão.

Não selecionado por predefinição.

Resultados da ação

A ação Criar utilizador fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Criar utilizador:

[
   {
      "kind":"admin#directory#user",
      "id":"ID",
      "etag":"TAG",
      "primaryEmail":"example@example.com",
      "name":{
         "givenName":"FIRST_NAME",
         "familyName":"LAST_NAME"
      },
      "isAdmin":"False",
      "isDelegatedAdmin":"False",
      "creationTime":"2020-12-22T13:44:29.000Z",
      "organizations":[
         {
            "name":"ExampleOrganization"
         }
      ],
      "phones":[
         {
            "value":"(800) 555‑0175"
         }
      ],
      "gender":{
         "type":"male"
      },
      "customerId":"ID",
      "orgUnitPath":"/",
      "isMailboxSetup":"False"
   }
]
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Criar utilizador:

Nome do resultado do script Valor
is_success True ou False

Eliminar extensão

Pré-visualizar. Use a ação Eliminar extensão para eliminar uma extensão do Chrome especificada de uma lista de bloqueios de uma unidade organizacional.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Eliminar extensão requer os seguintes parâmetros:

Parâmetro Descrição
Organization Unit Name

Obrigatório.

O nome da unidade organizacional a partir da qual eliminar a extensão.
Extension ID

Obrigatório.

O ID da extensão a eliminar.

Resultados da ação

A ação Delete Extension (Eliminar extensão) fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte mostra as saídas de resultados JSON recebidas quando usa a ação Eliminar extensão:

[
  {
    "deleted_extensions": ["chrome:exampleextensionid"]
  }
]
Mensagens de saída

A ação Delete Extension pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully deleted extension EXTENSION_ID from Organization Unit ORGANIZATION_NAME using Google Workspace.

 A ação foi bem-sucedida.
Error executing action "Delete Extension". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte indica o valor do resultado do script quando usa a ação Delete Extension:

Nome do resultado do script Valor
is_success True ou False

Eliminar grupo

Use a ação Eliminar grupo para eliminar um grupo do diretório do Google Workspace.

Esta ação não é executada em entidades do Google SecOps.

Pode usar a ação Eliminar grupo para resolver os seguintes exemplos de utilização:

  • Automatize a desvinculação de utilizadores.
  • Corrigir incidentes de segurança.
  • Realize limpezas de grupos desatualizados.

Dados de ações

A ação Delete Group requer os seguintes parâmetros:

Parâmetro Descrição
Group Email Address

Obrigatório.

Um endereço de email do grupo a eliminar.

Resultados da ação

A ação Eliminar grupo fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Eliminar grupo fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Google Workspace group GROUP_EMAIL deleted.

Action was not able to find Google Workspace group for deletion.

A ação foi bem-sucedida.
Failed to connect to the Google Workspace! Error is ERROR_DESCRIPTION

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Delete Group:

Nome do resultado do script Valor
is_success True ou False

Eliminar UO

Use a ação Eliminar UO para eliminar uma unidade organizacional.

Não pode eliminar uma organização se tiver utilizadores, dispositivos ou organizações secundárias. Antes de eliminar uma organização, mova todos os utilizadores e dispositivos para outras organizações e remova todas as organizações secundárias.

Esta ação é executada em todas as entidades do Google SecOps.

Pode usar a ação Eliminar UO para resolver os seguintes exemplos de utilização:

  • Automatize a desvinculação de utilizadores.
  • Corrigir incidentes de segurança.
  • Faça a gestão dos recursos do projeto e execute limpezas do projeto.

Dados de ações

A ação Delete OU requer os seguintes parâmetros:

Parâmetro Descrição
Customer ID

Obrigatório.

Um ID exclusivo da conta do Google Workspace do cliente.

Para configurar a conta customerId, também pode usar o seguinte marcador de posição: my_customer.
OU Path

Obrigatório.

Um caminho completo para a unidade organizacional.

Se a unidade organizacional estiver localizada num caminho de raiz (/), indique o nome da unidade organizacional sem um caminho.

Resultados da ação

A ação Eliminar UO fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Resultado do script Disponível
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Eliminar UO:

Nome do resultado do script Valor
is_success True ou False

Eliminar utilizador

Use a ação Eliminar utilizador para eliminar contas de utilizador.

Depois de eliminar um utilizador, este não pode aceder nem utilizar nenhum serviço do Google Workspace da sua organização.

Pode usar a ação Eliminar utilizador para resolver os seguintes exemplos de utilização:

  • Desintegre funcionários que estão a sair.
  • Corrija contas comprometidas.
  • Automatize a limpeza de contas temporárias.

Esta ação é executada em todas as entidades do Google SecOps.

Dados de ações

A ação Eliminar utilizador requer os seguintes parâmetros:

Parâmetro Descrição
Email Address

Obrigatório.

Um endereço de email do utilizador a eliminar.

Resultados da ação

A ação Eliminar utilizador fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Resultado do script Disponível
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Eliminar utilizador:

Nome do resultado do script Valor
is_success True ou False

Enriquecer entidades

Use a ação Enrich Entities para enriquecer as entidades do Google SecOps com informações do Google Workspace.

Esta ação é executada na entidade User.

Pode usar a ação Enrich Entities para resolver os seguintes exemplos de utilização:

  • Investigue utilizadores.
  • Analise emails de phishing.
  • Investigue tentativas de exfiltração de dados.
  • Detetar software malicioso.

Dados de ações

Nenhum.

Resultados da ação

A ação Enrich Entities fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento de entidades Disponível
Resultado JSON Disponível
Resultado do script Disponível
Enriquecimento de entidades

A ação Enriquecer entidades suporta o seguinte enriquecimento de entidades:

Nome do campo de enriquecimento Lógica de enriquecimento
Phones Devolve se existir num resultado JSON.
isDelegatedAdmin Devolve se existir num resultado JSON.
suspended Devolve se existir num resultado JSON.
id Devolve se existir num resultado JSON.
nonEditableAliases Devolve se existir num resultado JSON.
archived Devolve se existir num resultado JSON.
isEnrolledIn2Sv Devolve se existir num resultado JSON.
includeInGlobalAddressList Devolve se existir num resultado JSON.
Relations Devolve se existir num resultado JSON.
isAdmin Devolve se existir num resultado JSON.
etag Devolve se existir num resultado JSON.
lastLoginTime Devolve se existir num resultado JSON.
orgUnitPath Devolve se existir num resultado JSON.
agreedToTerms Devolve se existir num resultado JSON.
externalIds Devolve se existir num resultado JSON.
ipWhitelisted Devolve se existir num resultado JSON.
kind Devolve se existir num resultado JSON.
isEnforcedIn2Sv Devolve se existir num resultado JSON.
isMailboxSetup Devolve se existir num resultado JSON.
emails Devolve se existir num resultado JSON.
organizations Devolve se existir num resultado JSON.
primaryEmail Devolve se existir num resultado JSON.
name Devolve se existir num resultado JSON.
gender Devolve se existir num resultado JSON.
creationTime Devolve se existir num resultado JSON.
changePasswordAtNextLogin Devolve se existir num resultado JSON.
customerId Devolve se existir num resultado JSON.
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Enrich Entities:

[{
    "Phones":
       [{
          "customType": "",
          "type": "custom",
          "value": "(800) 555‑0175"
       }],
   "isDelegatedAdmin": false,
   "suspended": false,
   "id": "ID",
   "nonEditableAliases": ["user@example.com"],
   "archived": false,
   "isEnrolledIn2Sv": true,
   "includeInGlobalAddressList": true,
   "Relations":
        [{
          "type": "manager",
          "value": "user@example.com"
        }],
   "isAdmin": false,
   "etag": "E_TAG_VALUE",
   "lastLoginTime": "2019-02-11T12:24:41.000Z",
   "orgUnitPath": "/OU-1",
   "agreedToTerms": true,
   "externalIds": [{"type": "organization",
                    "value": ""}],
   "ipWhitelisted": false,
   "kind": "admin#directory#user",
   "isEnforcedIn2Sv": true,
   "isMailboxSetup": true,
   "emails":
       [{
          "primary": true,
          "address": "user@example.com"
        },
        {
          "address": "user@example.com"
        }],
    "organizations":
        [{
           "department": "R&D",
           "customType": "", "name": "Company"
         }],
     "primaryEmail": "user@example.com",
     "name":
         {
            "fullName": "NAME SURNAME",
            "givenName": "NAME",
            "familyName": "SURNAME"
         },
     "gender": {"type": "male"},
     "creationTime": "2017-10-26T06:57:13.000Z",
     "changePasswordAtNextLogin": false,
     "customerId": "CUSTOMER_ID"
}]
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Enrich Entities:

Nome do resultado do script Valor
is_success True ou False

Obtenha detalhes da extensão

Use a ação Get Extension Details para obter informações sobre uma extensão do Chrome específica.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Get Extension Details requer os seguintes parâmetros:

Parâmetro Descrição
Extension ID

Obrigatório.

Uma lista de IDs de extensões a enriquecer separada por vírgulas.
Max Requesting Users To Return

Obrigatório.

O número máximo de utilizadores a devolver que pediram a instalação da extensão.

O valor máximo é 1000.
Max Requesting Devices To Return

Obrigatório.

O número máximo de dispositivos a devolver onde a instalação da extensão foi pedida.

O valor máximo é 1000.

Resultados da ação

A ação Get Extension Details (Obter detalhes da extensão) fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte mostra o resultado JSON recebido quando usa a ação Get Extension Details:

[
  {
    "Entity": "Example Extension Name",
    "EntityResult": {
      "name": "customers/example-customer-id/apps/chrome/exampleextensionid",
      "displayName": "Example Extension Name",
      "description": "A description for an example extension.",
      "appId": "exampleextensionid",
      "revisionId": "11.3.0.0",
      "type": "CHROME",
      "iconUri": "https://lh3.googleusercontent.com/KxYKwMcAzhn_DBMVIb0mtvIOsAME2d8-csv5d_vnKYX6PL3D6BGbVy3hH68ky8nM9yTDGAPl6B77pA7tpu4_jeUkXw",
      "detailUri": "https://chromewebstore.google.com/detail/exampleextensionid",
      "firstPublishTime": "2011-12-14T06:57:01.918Z",
      "latestPublishTime": "2025-07-01T02:05:04.252Z",
      "publisher": "example-publisher",
      "reviewNumber": "5423",
      "reviewRating": 4,
      "chromeAppInfo": {
        "supportEnabled": true,
        "minUserCount": 3000000,
        "permissions": [
          {
            "type": "offscreen"
          },
          {
            "type": "scripting",
            "documentationUri": "https://developer.chrome.com/docs/extensions/reference/scripting/",
            "accessUserData": false
          },
          {
            "type": "storage",
            "documentationUri": "https://developer.chrome.com/docs/extensions/reference/storage/",
            "accessUserData": false
          },
          {
            "type": "tabs",
            "documentationUri": "https://developer.chrome.com/docs/extensions/reference/tabs#type-Tab",
            "accessUserData": true
          }
        ],
        "siteAccess": [
          {
            "hostMatch": "https://*/*"
          },
          {
            "hostMatch": "http://*/*"
          }
        ],
        "isTheme": false,
        "googleOwned": true,
        "isCwsHosted": true,
        "kioskEnabled": false,
        "isKioskOnly": false,
        "type": "EXTENSION",
        "isExtensionPolicySupported": false,
        "manifestVersion": "3",
        "requestingUserDetails": [
          {
            "email": "user@example.com",
            "justification": "Example justification for the request."
          }
        ],
        "requestingDeviceDetails": [
          {
            "device": "example-device-id",
            "justification": "Example justification for the request."
          }
        ]
      }
    }
  }
]
Mensagens de saída

A ação Get Extension Details pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully returned information about the following extensions in Google Workspace: EXTENSION_IDS.

Action wasn't able to return information about the following extension in Google Workspace: EXTENSION_IDS.

No information about the provided extensions were found.

 A ação foi bem-sucedida.
Error executing action "Get Extension Details". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte lista o valor do resultado do script quando usa a ação Get Extension Details:

Nome do resultado do script Valor
is_success True ou False

Obter detalhes do grupo

Use a ação Get Group Details para obter informações sobre um grupo no Google Workspace.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Get Group Details requer os seguintes parâmetros:

Parâmetro Descrição
Group Email Addresses

Obrigatório.

Uma lista de emails de grupos separados por vírgulas a examinar.

Resultados da ação

A ação Get Group Details (Obter detalhes do grupo) fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Get Group Details:

{
        "Entity": "group@example.com",
        "EntityResult": {
            "kind": "groupsSettings#groups",
            "email": "group@example.com",
            "name": "GROUP_NAME",
            "description": "DESCRIPTION",
            "whoCanJoin": "CAN_REQUEST_TO_JOIN",
            "whoCanViewMembership": "ALL_MEMBERS_CAN_VIEW",
            "whoCanViewGroup": "ALL_MEMBERS_CAN_VIEW",
            "whoCanInvite": "ALL_MANAGERS_CAN_INVITE",
            "whoCanAdd": "ALL_MANAGERS_CAN_ADD",
            "allowExternalMembers": "false",
            "whoCanPostMessage": "ANYONE_CAN_POST",
            "allowWebPosting": "true",
            "primaryLanguage": "en_US",
            "maxMessageBytes": 26214400,
            "isArchived": "false",
            "archiveOnly": "false",
            "messageModerationLevel": "MODERATE_NONE",
            "spamModerationLevel": "MODERATE",
            "replyTo": "REPLY_TO_IGNORE",
            "includeCustomFooter": "false",
            "customFooterText": "",
            "sendMessageDenyNotification": "false",
            "defaultMessageDenyNotificationText": "",
            "showInGroupDirectory": "true",
            "allowGoogleCommunication": "false",
            "membersCanPostAsTheGroup": "false",
            "messageDisplayFont": "DEFAULT_FONT",
            "includeInGlobalAddressList": "true",
            "whoCanLeaveGroup": "ALL_MEMBERS_CAN_LEAVE",
            "whoCanContactOwner": "ANYONE_CAN_CONTACT",
            "whoCanAddReferences": "NONE",
            "whoCanAssignTopics": "NONE",
            "whoCanUnassignTopic": "NONE",
            "whoCanTakeTopics": "NONE",
            "whoCanMarkDuplicate": "NONE",
            "whoCanMarkNoResponseNeeded": "NONE",
            "whoCanMarkFavoriteReplyOnAnyTopic": "NONE",
            "whoCanMarkFavoriteReplyOnOwnTopic": "NONE",
            "whoCanUnmarkFavoriteReplyOnAnyTopic": "NONE",
            "whoCanEnterFreeFormTags": "NONE",
            "whoCanModifyTagsAndCategories": "NONE",
            "favoriteRepliesOnTop": "true",
            "whoCanApproveMembers": "ALL_MANAGERS_CAN_APPROVE",
            "whoCanBanUsers": "OWNERS_AND_MANAGERS",
            "whoCanModifyMembers": "OWNERS_AND_MANAGERS",
            "whoCanApproveMessages": "OWNERS_AND_MANAGERS",
            "whoCanDeleteAnyPost": "OWNERS_AND_MANAGERS",
            "whoCanDeleteTopics": "OWNERS_AND_MANAGERS",
            "whoCanLockTopics": "OWNERS_AND_MANAGERS",
            "whoCanMoveTopicsIn": "OWNERS_AND_MANAGERS",
            "whoCanMoveTopicsOut": "OWNERS_AND_MANAGERS",
            "whoCanPostAnnouncements": "OWNERS_AND_MANAGERS",
            "whoCanHideAbuse": "NONE",
            "whoCanMakeTopicsSticky": "NONE",
            "whoCanModerateMembers": "OWNERS_AND_MANAGERS",
            "whoCanModerateContent": "OWNERS_AND_MANAGERS",
            "whoCanAssistContent": "NONE",
            "customRolesEnabledForSettingsToBeMerged": "false",
            "enableCollaborativeInbox": "false",
            "whoCanDiscoverGroup": "ALL_IN_DOMAIN_CAN_DISCOVER",
            "defaultSender": "DEFAULT_SELF"
        }
    }
Mensagens de saída

A ação Get Group Details fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully enriched the following groups using information from Google Workspace: GROUPS

Action wasn't able to enrich the following group using information from Google Workspace: GROUPS

None of the groups were enriched.

 A ação foi bem-sucedida.
Error executing action "Get Group Details". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Get Group Details:

Nome do resultado do script Valor
is_success True ou False

Obtenha detalhes do navegador anfitrião

Use a ação Get Host Browser Details para obter informações sobre os navegadores associados a uma entidade especificada do Google SecOps Hostname.

Esta ação é executada na entidade Hostname do Google SecOps.

Dados de ações

Nenhum.

Resultados da ação

A ação Get Host Browser Details (Obter detalhes do navegador anfitrião) fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte mostra a saída do resultado JSON recebida quando usa a ação Get Host Browser Details:

{
   "Entity": "example.host.com",
   "EntityResult": [
      {
         "deviceId": "example-device-id",
         "kind": "admin#directory#browserdevice",
         "lastPolicyFetchTime": "2025-07-25T12:11:17.546Z",
         "osPlatform": "Linux",
         "osArchitecture": "x86_64",
         "osVersion": "6.12.27-1rodete1-amd64",
         "machineName": "example.host.com",
         "lastRegistrationTime": "2025-07-07T07:45:20.504Z",
         "extensionCount": "15",
         "policyCount": "23",
         "lastDeviceUser": "example-user",
         "lastActivityTime": "2025-07-26T12:13:55.385Z",
         "osPlatformVersion": "Linux 6.12.27-1rodete1-amd64",
         "browserVersions": [
            "140.0.7259.2 (Dev)"
         ],
         "lastStatusReportTime": "2025-07-26T07:46:00.919Z",
         "lastDeviceUsers": [
            {
               "userName": "example-user",
               "lastStatusReportTime": "2025-07-26T07:46:00.919Z"
            }
         ],
         "machinePolicies": [
            {
               "source": "MACHINE_LEVEL_USER_CLOUD",
               "name": "CloudReportingEnabled",
               "value": "true"
            }
         ],
         "browsers": [
            {
               "browserVersion": "140.0.7259.2",
               "channel": "DEV",
               "lastStatusReportTime": "2025-07-26T07:46:00.919Z",
               "executablePath": "/opt/google/chrome-unstable",
               "profiles": [
                  {
                     "name": "Example User Profile",
                     "id": "/home/example_user/.config/google-chrome/Default",
                     "lastStatusReportTime": "2025-07-26T07:46:00.919Z",
                     "lastPolicyFetchTime": "2025-07-25T12:11:17.546Z",
                     "chromeSignedInUserEmail": "user@example.com",
                     "extensions": [
                        {
                           "extensionId": "exampleextensionid",
                           "version": "2.0.6",
                           "permissions": [
                              "alarms",
                              "contextMenus",
                              "management",
                              "storage",
                              "https://accounts.google.com/*",
                              "https://appengine.google.com/*",
                              "https://example.com/*",
                              "https://example.org/*",
                              "https://example-api.com/*",
                              "https://docs.example.com/*",
                              "https://internal.example.net/*",
                              "https://partners.example.com/*",
                              "https://www.google.com/*"
                           ],
                           ],
                           "name": "Example Extension",
                           "description": "This is a description for an example extension.",
                           "appType": "EXTENSION",
                           "homepageUrl": "https://chromewebstore.google.com/detail/exampleextensionid",
                           "installType": "ADMIN",
                           "manifestVersion": 3
                        }
                     ],
                     "userPolicies": [
                        {
                           "source": "USER_CLOUD",
                           "name": "CloudProfileReportingEnabled",
                           "value": "true"
                        }
                     ]
                  }
               ],
               "pendingInstallVersion": "140.0.7312.0"
            }
         ],
         "virtualDeviceId": "example-virtual-device-id",
         "orgUnitPath": "/",
         "deviceIdentifiersHistory": {
            "records": [
               {
                  "identifiers": {
                     "machineName": "example.host.com"
                  },
                  "firstRecordTime": "2025-06-03T08:06:33.895Z",
                  "lastActivityTime": "2025-07-26T07:46:01.325Z"
               }
            ]
         }
      }
   ]
}
Mensagens de saída

A ação Get Host Browser Details pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully returned browsers related to the following hostnames in Google Workspace: HOSTNAME.

No browsers were associated with the following hostnames in Google Workspace: HOSTNAME.

No browsers were associated with provided hostnames.

 A ação foi bem-sucedida.
Error executing action "Get Host Browser Details". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte apresenta o valor do resultado do script quando usa a ação Get Host Browser Details:

Nome do resultado do script Valor
is_success True ou False

Apresentar membros do grupo

Use a ação List Group Members para listar os membros de um grupo do Google Workspace.

Esta ação é executada em todas as entidades do Google SecOps.

Pode usar a ação List Group Members para resolver os seguintes exemplos de utilização:

  • Automatize a admissão e a exclusão de utilizadores.
  • Faça uma auditoria de segurança.
  • Responder a incidentes.
  • Suportar o acesso dinâmico a recursos.

Dados de ações

A ação List Group Members requer os seguintes parâmetros:

Parâmetro Descrição
Group Email Address

Obrigatório.

Um endereço de email do grupo.
Include Derived Membership

Opcional.

Se estiver selecionada, a ação lista as associações indiretas dos utilizadores no grupo.

Selecionado por predefinição.

Resultados da ação

A ação List Group Members fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação List Group Members:

{
   "status": "ACTIVE",
   "kind": "admin#directory#member",
   "email": "user1@example.com",
   "etag": "E_TAG_VALUE",
   "role": "MEMBER",
   "type": "USER",
   "id": "ID"
  },{
   "status": "ACTIVE",
   "kind": "admin#directory#member",
   "email": "user2@example.com",
   "etag": "E_TAG_VALUE",
   "role": "MEMBER",
   "type": "USER", "id": "ID"
}
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação List Group Members (Listar membros do grupo):

Nome do resultado do script Valor
members True ou False

Apresentar privilégios de grupo

Use a ação List Group Privileges para listar as funções e os privilégios relacionados com o grupo do Google Workspace.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação List Group Privileges requer os seguintes parâmetros:

Parâmetro Descrição
Group Email Addresses

Opcional.

Uma lista de grupos a examinar separada por vírgulas.
Check Roles

Opcional.

Uma lista separada por vírgulas de funções a verificar que estão relacionadas com o grupo.
Check Privileges

Opcional.

Uma lista de autorizações separada por vírgulas para verificar que estão relacionadas com o grupo.

Este parâmetro requer que selecione o parâmetro Expandir privilégios. Se configurou o parâmetro Check Roles, a ação verifica os privilégios apenas para as funções que indicou.
Expand Privileges

Opcional.

Se esta opção for selecionada, a ação devolve informações sobre todos os privilégios únicos relacionados com o grupo.
Max Roles To Return

Obrigatório.

O número máximo de funções relacionadas com o grupo a devolver.

O valor predefinido é 100.
Max Privileges To Return

Obrigatório.

O número máximo de privilégios relacionados com o grupo a devolver.

O valor predefinido é 100.

Resultados da ação

A ação List Group Privileges fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação List Group Privileges:

{
    "Entity": "user@example.com",
    "EntityResult": {
        "roles": [
            "Role1",
            "_GROUPS_EDITOR_ROLE",
            "example-role"
        ],
        "unique_privileges": [
            "VIEW_SITE_DETAILS",
            "ACCESS_EMAIL_LOG_SEARCH",
            "ACCESS_ADMIN_QUARANTINE",
            "ACCESS_RESTRICTED_QUARANTINE",
            "ADMIN_QUALITY_DASHBOARD_ACCESS",
            "MANAGE_DLP_RULE",
            "DASHBOARD_ACCESS",
            "MANAGE_GSC_RULE",
            "VIEW_GSC_RULE",
            "SECURITY_HEALTH_DASHBOARD_ACCESS",
            "SIT_CALENDAR_VIEW_METADATA",
            "SIT_CHAT_VIEW_METADATA",
            "SIT_CHROME_VIEW_METADATA",
            "SIT_DEVICE_UPDATE_DELETE",
            "SIT_DEVICE_VIEW_METADATA",
            "SIT_DRIVE_UPDATE_DELETE"
        ]
    }
}
Mensagens de saída

A ação List Group Privileges (Listar privilégios do grupo) apresenta as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully fetched information for the following groups using information from Google Workspace: GROUPS

Action wasn't able to fetch information for the following groups using information from Google Workspace: GROUPS

None of the specific roles/privileges were found for the following groups in Google Workspace: GROUPS

None of the specific roles/privileges were found for the provided groups in Google Workspace.

No information was found for the provided groups in Google Workspace.

 A ação foi bem-sucedida.
Error executing action "List Group Privileges". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação List Group Privileges:

Nome do resultado do script Valor
is_success True ou False

Listar UO da conta

Use a ação List OU of Account para apresentar as unidades organizacionais de uma conta.

Esta ação é executada em todas as entidades do Google SecOps.

Pode usar a ação List OU of Account para resolver os seguintes exemplos de utilização:

  • Automatize a desvinculação de utilizadores.
  • Realizar uma auditoria de segurança direcionada.
  • Automatizar a gestão de membros de um grupo.
  • Simplifique o aprovisionamento de utilizadores.
  • Automatize a auditoria e os relatórios de conformidade.

Entradas de integração

A ação List OU of Account requer os seguintes parâmetros:

Parâmetro Descrição
Customer ID

Obrigatório.

Um ID exclusivo da conta do Google Workspace do cliente.

Para representar o valor customerId da conta, use o marcador de posição my_customer.
Organization Unit Path

Opcional.

O caminho da unidade organizacional a devolver.

O valor predefinido é /.
Max Organization Units

Obrigatório.

A quantidade máxima de unidades organizacionais a devolver.

O valor máximo é 100.

O valor predefinido é 50.

Resultados da ação

A ação List OU of Account (Listar UO da conta) fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação List OU of Account:

[{
   "kind": "admin#directory#orgUnit",
   "parentOrgUnitPath": "/",
   "name": "OU-1",
   "etag": "E_TAG_VALUE",
   "orgUnitPath": "/OU-1",
   "parentOrgUnitId": "id:1455",
   "blockInheritance": false,
   "orgUnitId": "id:123",
   "description": ""
}]
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação List OU of Account:

Nome do resultado do script Valor
organizational_units True ou False

Listar privilégios do utilizador

Use a ação List User Privileges para listar as funções e os privilégios relacionados com o utilizador no Google Workspace.

Esta ação é executada na entidade User do Google SecOps.

Dados de ações

A ação List User Privileges requer os seguintes parâmetros:

Parâmetro Descrição
User Email Addresses

Opcional.

Uma lista de utilizadores a examinar separada por vírgulas.

A ação executa valores que configura para este parâmetro juntamente com a entidade User.
Check Roles

Opcional.

Uma lista separada por vírgulas de funções a verificar que estão relacionadas com o utilizador.
Check Privileges

Opcional.

Uma lista separada por vírgulas de autorizações a validar que estão relacionadas com o utilizador.

Este parâmetro requer que selecione o parâmetro Expandir privilégios. Se configurou o parâmetro Check Roles, a ação verifica os privilégios apenas para as funções que indicou.
Include Inherited Roles

Opcional.

Se selecionada, a ação devolve adicionalmente as funções de utilizador herdadas de grupos.
Expand Privileges

Opcional.

Se selecionada, a ação devolve informações sobre todos os privilégios únicos relacionados com o utilizador.
Max Roles To Return

Obrigatório.

O número máximo de funções relacionadas com o utilizador a devolver.

O valor predefinido é 100.
Max Privileges To Return

Obrigatório.

O número máximo de privilégios relacionados com o utilizador a devolver.

O valor predefinido é 100.

Resultados da ação

A ação List User Privileges (Listar privilégios do utilizador) fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação List User Privileges:

{
    "Entity": "user@example.com",
    "EntityResult": {
        "roles": [
            "Role1",
            "_GROUPS_EDITOR_ROLE",
            "example-role"
        ],
        "unique_privileges": [
            "VIEW_SITE_DETAILS",
            "ACCESS_EMAIL_LOG_SEARCH",
            "ACCESS_ADMIN_QUARANTINE",
            "ACCESS_RESTRICTED_QUARANTINE",
            "ADMIN_QUALITY_DASHBOARD_ACCESS",
            "MANAGE_DLP_RULE",
            "DASHBOARD_ACCESS",
            "MANAGE_GSC_RULE",
            "VIEW_GSC_RULE",
            "SECURITY_HEALTH_DASHBOARD_ACCESS",
            "SIT_CALENDAR_VIEW_METADATA",
            "SIT_CHAT_VIEW_METADATA",
            "SIT_CHROME_VIEW_METADATA",
            "SIT_DEVICE_UPDATE_DELETE",
            "SIT_DEVICE_VIEW_METADATA",
            "SIT_DRIVE_UPDATE_DELETE"
        ]
    }
}
Mensagens de saída

A ação List User Privileges apresenta as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully enriched the following users using information from Google Workspace: USERS

Action wasn't able to enrich the following users using information from Google Workspace: USERS

None of the specific roles/privileges were found for the following users in Google Workspace: USERS

None of the specific roles/privileges were found for the provided users in Google Workspace.

None of the provided users were enriched in Google Workspace.

A ação foi bem-sucedida.
Error executing action "List User Privileges". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação List User Privileges:

Nome do resultado do script Valor
is_success True ou False

Listar utilizadores

Use a ação List Users para listar os utilizadores presentes numa conta.

Esta ação não é executada em entidades do Google SecOps.

Pode usar a ação List Users para resolver os seguintes exemplos de utilização:

  • Identificar contas potencialmente comprometidas.
  • Automatize os processos de anulação da integração.
  • Audite e faça a gestão dos privilégios de acesso dos utilizadores
  • Investigue atividades suspeitas.
  • Faça a gestão de licenças e recursos de utilizadores.

Dados de ações

A ação List Users requer os seguintes parâmetros:

Parâmetro Descrição
Customer ID

Opcional.

Um ID exclusivo da conta do Google Workspace do cliente.

Se não fornecer este valor de parâmetro, a ação usa automaticamente o marcador de posição my_customer para representar um ID de cliente da conta.
Domain

Opcional.

Um domínio para pesquisar utilizadores.
Manager Email

Opcional.

Um endereço de email do gestor de um utilizador.
Return Only Admin Accounts?

Opcional.

Se selecionada, a ação devolve apenas contas de administrador.

Não selecionado por predefinição.
Return Only Delegated Admin Accounts?

Opcional.

Se selecionada, a ação devolve apenas contas de administrador delegado.

Não selecionado por predefinição.
Return Only Suspended Users?

Opcional.

Se selecionada, a ação devolve apenas contas suspensas.

Não selecionado por predefinição.
Org Unit Path

Opcional.

Um caminho completo de uma unidade organizacional a partir da qual obter os utilizadores. O caminho corresponde a todas as cadeias de unidades organizacionais indicadas na unidade de destino.
Department

Opcional.

Um departamento na organização a partir do qual obter os utilizadores.
Record Limit

Opcional.

O número máximo de registos de dados que a ação deve devolver.

O valor predefinido é 20.
Custom Query Parameter

Opcional.

Um parâmetro de consulta personalizado a adicionar à chamada de pesquisa de utilizadores da lista, como orgName='Human Resources'.

Pode configurar este parâmetro com o campo email ou deixar o campo email vazio e configurar o parâmetro Email Addresses. Se configurar o campo email e o parâmetro Email Addresses, a consulta gerada falha.
Return only users without 2fa?

Opcional.

Se selecionada, a ação só devolve utilizadores que não têm a autenticação de dois fatores (2FA) ativada.

Não selecionado por predefinição.
Email Addresses

Opcional.

Uma lista de endereços de email separados por vírgulas para pesquisar.

Se configurar este parâmetro, não configure o campo email no parâmetro Custom Query Parameter.

Se configurar este parâmetro, a ação ignora o parâmetro Record Limit.

Resultados da ação

A ação List Users (Listar utilizadores) fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mesa de parede para caixas

A ação List Users apresenta a seguinte tabela numa página de registo:

Nome da tabela: Utilizadores do Google G Suite

Colunas da tabela:

  • ID
  • Email
  • Nome próprio
  • Nome de família
  • É administrador?
  • Is Delegated Admin?
  • Hora da criação
  • Hora do último início de sessão
  • Suspenso?
  • Arquivada?
  • Alterar palavra-passe no próximo início de sessão?
  • ID de cliente
  • Caminho da unidade organizacional
  • Tem a caixa de correio configurada?
  • Email de recuperação
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação List Users:

{
    "kind": "admin#directory#users",
    "etag": "E_TAG_VALUE",
    "users": [
        {
            "kind": "admin#directory#user",
            "id": "ID",
            "etag": "E_TAG_VALUE",
            "primaryEmail": "user@example.com",
            "name": {
                "givenName": "NAME",
                "familyName": "SURNAME",
                "fullName": "NAME SURNAME"
            },
            "isAdmin": true,
            "isDelegatedAdmin": false,
            "lastLoginTime": "2020-12-22T06:40:34.000Z",
            "creationTime": "2020-07-22T09:23:28.000Z",
            "agreedToTerms": true,
            "suspended": false,
            "archived": false,
            "changePasswordAtNextLogin": false,
            "ipWhitelisted": false,
            "emails": [
                {
                    "address": "user@example.com",
                    "primary": true
                },
                {
                    "address": "user@example.com"
                }
            ],
            "nonEditableAliases": [
                "user@example.com"
            ],
            "customerId": "CUSTOMER_ID",
            "orgUnitPath": "/Management",
            "isMailboxSetup": true,
            "isEnrolledIn2Sv": false,
            "isEnforcedIn2Sv": false,
            "includeInGlobalAddressList": true,
            "recoveryEmail": "email@example.com"
        }
    ]
}
Mensagens de saída

A ação List Users (Listar utilizadores) apresenta as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Action successfully returned the Google Workspace Directory user list.

No users were returned.

 A ação foi bem-sucedida.
Failed to connect to the Google Workspace! Error is ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação List Users (Listar utilizadores):

Nome do resultado do script Valor
is_success True ou False

Tchim-tchim

Use a ação Ping para testar a conetividade ao Google Workspace.

Esta ação é executada em todas as entidades do Google SecOps.

Dados de ações

Nenhum.

Resultados da ação

A ação Ping fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Resultado do script Disponível
Resultado do script

A tabela seguinte descreve os valores para o resultado do script quando usa a ação Ping:

Nome do resultado do script Valor
is_success True ou False

Remova membros do grupo

Use a ação Remover membros do grupo para remover membros de um grupo do Google Workspace.

Esta ação é executada na entidade User do Google SecOps.

Pode usar a ação List Users para resolver os seguintes exemplos de utilização:

  • Automatize a desvinculação de utilizadores.
  • Executar a gestão de grupos dinâmicos.
  • Corrija problemas de controlo de acesso.

Dados de ações

A ação Remover membros do grupo requer os seguintes parâmetros:

Parâmetro Descrição
Group Email Address

Obrigatório.

Um email do grupo do qual remover os membros.
User Email Addresses

Opcional.

Uma lista separada por vírgulas de utilizadores a remover do grupo.

A ação executa valores que configura para este parâmetro juntamente com a entidade User.

Resultados da ação

A ação Remover membros do grupo fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Resultado do script Disponível
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Remover membros do grupo:

Nome do resultado do script Valor
is_success True ou False

Revogue sessões de utilizadores

Use a ação Revogar sessões de utilizador para revogar as sessões Web e de dispositivos do utilizador e repor os respetivos cookies de início de sessão no Google Workspace.

Esta ação é executada na entidade User do Google SecOps.

Dados de ações

A ação Revoke User Sessions requer os seguintes parâmetros:

Parâmetro Descrição
User Email Addresses

Opcional.

Uma lista de utilizadores separados por vírgulas para terminar sessão. A ação executa os valores deste parâmetro com as entidades do Google SecOps.User

Resultados da ação

A ação Revogar sessões de utilizadores fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte mostra o resultado JSON recebido quando usa a ação Revoke User Sessions:

[
   {
       "Entity": "ENTITY_ID",
       "EntityResult": {
           "Status": "done"
       }
   }
]
Mensagens de saída

A ação Revogar sessões de utilizador pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully signed out the following users using Google Workspace: USERS

Action wasn't able to sign out the following users using Google Workspace: USERS

None of the provided users were found in Google Workspace.

A ação foi bem-sucedida.
Error executing action "Revoke User Sessions". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte indica o valor da saída do resultado do script quando usa a ação Revogar sessões de utilizadores:

Nome do resultado do script Valor
is_success True ou False

Pesquise eventos de atividade do utilizador

Use a ação Search User Activity Events para obter eventos de atividade de uma aplicação para uma entidade User especificada do Google SecOps.

Esta ação é executada na entidade User do Google SecOps.

Dados de ações

A ação Search User Activity Events requer os seguintes parâmetros:

Parâmetro Descrição
User Email Addresses

Opcional.

Uma lista separada por vírgulas de endereços de email de utilizadores adicionais a processar.

A ação processa todos os utilizadores nesta lista, além de uma entidade User (se for fornecida).
Application Names

Obrigatório.

Uma lista de aplicações para consultar eventos de atividade.

Para ver uma lista completa das aplicações suportadas, consulte a documentação ApplicationName.
Event Type Filter

Opcional.

Uma lista separada por vírgulas de tipos de eventos a obter.
Time Frame

Opcional.

O intervalo de tempo para a pesquisa de atividade.

Os valores possíveis são os seguintes:

  • Last Hour
  • Last 6 Hours
  • Last 24 Hours
  • Last Week
  • Last Month
  • Custom

Se Custom estiver selecionado, o parâmetro Start Time é obrigatório.

O valor predefinido é Last Hour.
Start Time

Opcional.

O início do intervalo de tempo para a pesquisa de atividade.

Este parâmetro é obrigatório se Custom for selecionado para o parâmetro Time Frame.

Configure o valor no formato ISO 8601.
End Time

Opcional.

O fim do intervalo de tempo para a pesquisa de atividade.

Este parâmetro é opcional quando Custom é selecionado para o parâmetro Time Frame e tem como predefinição a hora atual se não for fornecido.

Configure o valor no formato ISO 8601.
Max Events To Return

Obrigatório.

O número máximo de eventos a devolver por utilizador.

A ação processa um máximo de 1000 eventos por utilizador, por aplicação.

O valor predefinido é 200.

O valor máximo é 1000.

Resultados da ação

A ação Pesquisar eventos de atividade do utilizador fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte mostra o resultado JSON recebido quando usa a ação Search User Activity Events:

{
   "Entity": "user@example.com",
   "EntityResult": [
      {
         "applicationName": "login",
         "type": "login",
         "name": "login_success",
         "parameters": [
            {
               "name": "login_type",
               "value": "google_password"
            },
            {
               "name": "login_challenge_method",
               "multiValue": [
                  "password"
               ]
            },
            {
               "name": "is_suspicious",
               "boolValue": false
            }
         ]
      },
      {
         "applicationName": "token",
         "type": "auth",
         "name": "authorize",
         "parameters": [
            {
               "name": "client_id",
               "value": "example-client-id.apps.googleusercontent.com"
            },
            {
               "name": "app_name",
               "value": "Google Chrome"
            },
            {
               "name": "client_type",
               "value": "NATIVE_DESKTOP"
            },
            {
               "name": "scope_data",
               "multiMessageValue": [
                  {
                     "parameter": [
                        {
                           "name": "scope_name",
                           "value": "https://www.google.com/accounts/OAuthLogin"
                        },
                        {
                           "name": "product_bucket",
                           "multiValue": [
                              "IDENTITY"
                           ]
                        }
                     ]
                  }
               ]
            },
            {
               "name": "scope",
               "multiValue": [
                  "https://www.google.com/accounts/OAuthLogin"
               ]
            }
         ]
      }
   ]
}
Mensagens de saída

A ação Search User Activity Events pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully found events for the following users in Google Workspace: USERS.

No events were found for the following users in Google Workspace: USERS.

No events were found for the provided users in Google Workspace.

 A ação foi bem-sucedida.
Error executing action "Search User Activity Events". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte apresenta o valor da saída do resultado do script quando usa a ação Pesquisar eventos de atividade do utilizador:

Nome do resultado do script Valor
is_success True ou False

Atualize a UO

Use a ação Atualizar UO para atualizar uma unidade organizacional (UO).

Esta ação é executada em todas as entidades do Google SecOps.

Pode usar a ação Atualizar UO para resolver os seguintes exemplos de utilização:

  • Faça a gestão dos grupos de segurança.
  • Automatize a admissão e a exclusão de utilizadores.
  • Implemente políticas de separação de dados.

Dados de ações

A ação Atualizar UO requer os seguintes parâmetros:

Parâmetro Descrição
Customer ID

Obrigatório.

Um ID exclusivo da conta do Google Workspace do cliente.

Para representar o valor customerId da conta, use o marcador de posição my_customer.
Name

Opcional.

Um nome da UO.
Description

Opcional.

Uma descrição da UO.
OU Path

Obrigatório.

Um caminho completo para a UO.

Se a UO estiver localizada no caminho de raiz, /, indique apenas o nome da UO sem um caminho.

Resultados da ação

A ação Update OU fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Resultado do script Disponível
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Atualizar UO:

Nome do resultado do script Valor
is_success True ou False

Atualizar utilizador

Use a ação Atualizar utilizador para atualizar um utilizador do diretório do Google Workspace.

Esta ação não é executada em entidades do Google SecOps.

Pode usar a ação Atualizar utilizador para resolver os seguintes exemplos de utilização:

  • Desative uma conta comprometida.
  • Aplicar uma reposição de palavra-passe após detetar atividade suspeita.
  • Atualize as informações do departamento após concluir uma transferência de funcionário.
  • Suspender contas inativas.

Dados de ações

A ação Atualizar utilizador requer os seguintes parâmetros:

Parâmetro Descrição
Email Address

Obrigatório.

Uma lista de endereços de email principais separados por vírgulas que são usados para identificar os utilizadores a atualizar.
Given Name

Opcional.

O nome próprio do utilizador.
Family Name

Opcional.

O apelido do utilizador.
Password

Opcional.

A palavra-passe do novo utilizador.
Phone

Opcional.

O número de telefone do utilizador.

A ação atualiza o tipo de número de telefone custom.
Gender

Opcional.

O género do utilizador.

Os valores válidos são os seguintes: female, male, other, unknown.
Department

Opcional.

O nome do departamento do utilizador.
Organization

Opcional.

O nome da organização do utilizador.
Change Password At Next Login

Opcional.

Se esta opção estiver selecionada, o sistema exige que o utilizador altere a respetiva palavra-passe na próxima tentativa de início de sessão.

Não selecionado por predefinição.
User Status

Opcional.

O estado do utilizador a atualizar.

Por predefinição, a ação não altera o estado do utilizador.

Os valores possíveis são os seguintes:
  • Not Changed
  • Blocked
  • Unblocked

Resultados da ação

A ação Atualizar utilizador fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Update User (Atualizar utilizador) fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully updated the following users in Google Workspace: EMAIL_ADDRESSES.

Action wasn't able to update the following users in Google Workspace: EMAIL_ADDRESSES

None of the provided users were updated.

 A ação foi bem-sucedida.
Error executing action "Update User". Reason: ERROR_REASON

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Atualizar utilizador:

Nome do resultado do script Valor
is_success True ou False

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.