Usar políticas personalizadas da organização

Com a política da organização doGoogle Cloud , você controla de forma centralizada e programática os recursos da sua organização. Um administrador de políticas da organização pode definir políticas da organização, ou seja, conjuntos de restrições que se aplicam aos recursos doGoogle Cloud e aos elementos que descendem dele na hierarquia de recursos doGoogle Cloud . É possível aplicar políticas da organização no nível da organização, de pastas ou de projetos.

A política da organização fornece restrições predefinidas para diversos serviços doGoogle Cloud . No entanto, se você quiser um controle mais granular e personalizável sobre os campos específicos restritos nas suas políticas da organização, crie também políticas da organização personalizadas.

Vantagens

É possível usar políticas personalizadas da organização para permitir ou negar operações específicas em recursos do Identity Platform para atender aos requisitos de segurança, conformidade ou governança do seu aplicativo. Por exemplo, é possível controlar as seguintes propriedades:

É possível desativar a opção de login com senha para aplicativos na sua organização e exigir que eles sempre usem a opção de login com e-mail.
É possível limitar os aplicativos na sua organização para usar um provedor de identidade (IdP) OIDC com um emissor especificado.
É possível desativar as opções de IdP do OIDC e do SAML para aplicativos na sua organização.
É possível desativar a opção de multilocação para aplicativos na sua organização.

Herança de políticas

Por padrão, as políticas da organização são herdadas pelos elementos que descendem dos recursos em que elas são aplicadas. Por exemplo, se você aplicar uma política a uma pasta, o Google Cloud vai aplicá-la a todos os projetos dessa pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.

Preços

O Organization Policy Service, incluindo políticas predefinidas e personalizadas, é oferecido sem custos financeiros.

Limitações

Quando você ativa o Identity Platform para um projeto, ele cria uma configuração padrão para esse projeto. O proprietário do projeto não pode mudar os valores padrão da configuração até que o projeto seja ativado. Mudar qualquer um dos valores padrão antes de ativar o projeto pode causar falha na ativação. Para mudar os valores padrão da configuração após a ativação, use o método updateConfig.

Antes de começar

Conecte seu app ao Identity Platform. Para instruções sobre como conectar seu app, consulte o Guia de início rápido.
Verifique qual é o ID da organização.

Funções exigidas

Para receber as permissões necessárias para gerenciar políticas da organização, peça ao administrador que conceda a você os seguintes papéis do IAM:

Administrador de políticas da organização (roles/orgpolicy.policyAdmin) no recurso da organização
Administrador do Identity Toolkit (roles/identitytoolkit.admin) no recurso do Identity Platform

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para gerenciar políticas da organizações. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As permissões a seguir são necessárias para gerenciar as políticas da organização:

orgpolicy.constraints.list
orgpolicy.policies.create
orgpolicy.policies.delete
orgpolicy.policies.list
orgpolicy.policies.update
orgpolicy.policy.get
orgpolicy.policy.set

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Criar uma restrição personalizada

Uma restrição personalizada é definida em um arquivo YAML pelos recursos, métodos, condições e ações compatíveis com o serviço em que você está aplicando a política da organização. As condições das restrições personalizadas são definidas usando a Common Expression Language (CEL). Para mais informações sobre como criar condições em restrições personalizadas usando a CEL, consulte a seção CEL de Como criar e gerenciar restrições personalizadas.

Para criar um arquivo YAML para uma restrição personalizada:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- identitytoolkit.googleapis.com/RESOURCE_NAME
methodTypes: METHOD
condition: CONDITION
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

Substitua:

ORGANIZATION_ID: o ID da organização, como 123456789.
CONSTRAINT_NAME: o nome da nova restrição personalizada. Uma restrição personalizada precisa começar com custom. e só pode incluir letras maiúsculas, minúsculas ou números, por exemplo, custom.allowEmailLinkLogin. O tamanho máximo desse campo é de 70 caracteres, sem contar o prefixo (por exemplo, organizations/123456789/customConstraints/custom).
RESOURCE_NAME: o nome (não o URI) do recurso REST da API Identity Platform que contém o objeto e o campo que você quer restringir. Por exemplo, identitytoolkit.googleapis.com/Config.

CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo pode ter no máximo 1000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravação de condições. Por exemplo, "resource.signIn.email.passwordRequired == true".
METHOD: ao criar uma configuração ou uma restrição de criação de locatário, especifique CREATE. Ao criar uma restrição UPDATE de configuração ou locatário, especifique as duas da seguinte maneira:
```
methodTypes:
- CREATE
- UPDATE
```
ACTION: a ação a ser realizada ao atender a condition. Pode ser ALLOW ou DENY.
DISPLAY_NAME: um nome legível para a restrição. Esse campo pode ter no máximo 200 caracteres.
DESCRIPTION: uma descrição legível da restrição a ser exibida como mensagem de erro quando a política é violada. Esse campo pode ter no máximo 2000 caracteres.

Para saber como criar uma restrição personalizada, consulte Como definir restrições personalizadas.

Configurar uma restrição personalizada

Console

Para criar uma restrição personalizada, faça o seguinte:

No console do Google Cloud , acesse a página Políticas da organização.
Acessar a página Políticas da organização
No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
Clique em Restrição personalizada.
Na caixa Nome de exibição, insira um nome legível para a restrição. Esse nome é usado em mensagens de erro e pode ser usado para identificação e depuração. Não use PII ou dados sensíveis em nomes de exibição, porque eles podem ser expostos em mensagens de erro. Esse campo pode ter até 200 caracteres.
Na caixa ID da restrição, insira o nome que você quer para a nova restrição personalizada. Uma restrição personalizada só pode conter letras (maiúsculas e minúsculas) ou números, por exemplo, custom.disableGkeAutoUpgrade. Esse campo pode conter até 70 caracteres, sem contar o prefixo (custom.), por exemplo, organizations/123456789/customConstraints/custom. Não inclua PII ou dados sensíveis no ID da restrição, porque eles podem ser expostos em mensagens de erro.
Na caixa Descrição, insira uma descrição legível da restrição. Essa descrição é usada como uma mensagem de erro quando a política é violada. Inclua detalhes sobre o motivo da violação e como resolver o problema. Não inclua PII ou dados sensíveis na descrição, porque eles podem ser expostos em mensagens de erro. Esse campo pode conter até 2.000 caracteres.
Na caixa Tipo de recurso, selecione o nome do recurso REST do Google Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, container.googleapis.com/NodePool. A maioria dos tipos de recursos aceita até 20 restrições personalizadas. Se você tentar criar mais restrições personalizadas, a operação vai falhar.
Em Método de aplicação, selecione se quer aplicar a restrição em um método REST CREATE ou em ambos os métodos CREATE e UPDATE. Se você aplicar a restrição com o método UPDATE em um recurso que a viola, as mudanças nesse recurso serão bloqueadas pela política da organização, a menos que a mudança resolva a violação.

Nem todos os serviços do Google Cloud aceitam os dois métodos. Para ver os métodos compatíveis com cada serviço, encontre o serviço em Serviços compatíveis.

Para definir uma condição, clique em Editar condição.

No painel Adicionar condição, crie uma condição de CEL que se refira a um recurso de serviço compatível, por exemplo, resource.management.autoUpgrade == false. Esse campo pode ter até 1.000 caracteres. Para detalhes sobre o uso da CEL, consulte Common Expression Language. Para mais informações sobre os recursos de serviço que você pode usar nas restrições personalizadas, consulte Serviços compatíveis com restrição personalizada.
Clique em Salvar.

Em Ação, selecione se você quer permitir ou negar o método avaliado quando a condição é atendida.

A ação de negação significa que a operação para criar ou atualizar o recurso será bloqueada se a condição for avaliada como verdadeira.

A ação de permissão significa que a operação para criar ou atualizar o recurso só é permitida se a condição for avaliada como verdadeira. Todos os outros casos, exceto os listados explicitamente na condição, estão bloqueados.

Clique em Criar restrição.

Quando você digita um valor em cada campo, a configuração YAML equivalente à restrição personalizada aparece à direita.

gcloud

Para criar uma restrição personalizada, crie um arquivo YAML com o seguinte formato:

      name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
      resourceTypes:
      - RESOURCE_NAME
      methodTypes:
      - CREATE
      condition: "CONDITION"
      actionType: ACTION
      displayName: DISPLAY_NAME
      description: DESCRIPTION

Substitua:

ORGANIZATION_ID: o ID da organização, como 123456789.
CONSTRAINT_NAME: o nome da sua nova restrição personalizada. Uma restrição personalizada só pode conter letras (maiúsculas e minúsculas) ou números, por exemplo, custom.allowEmailLinkLogin. Esse campo pode ter até 70 caracteres.
RESOURCE_NAME: o nome totalmente qualificado do recurso Google Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, identitytoolkit.googleapis.com/Config.
CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo pode conter até 1.000 caracteres. Por exemplo, "resource.signIn.email.passwordRequired == true".

Para mais informações sobre os recursos disponíveis para gravação de condições, consulte Recursos compatíveis.

ACTION: a ação a ser realizada se o condition for atendido. Só pode ser ALLOW.

A ação "permitir" significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso será permitida. Isso também significa que todos os outros casos, exceto o listado explicitamente na condição, estão bloqueados.

DISPLAY_NAME: um nome legível para a restrição. Esse campo pode ter até 200 caracteres.
DESCRIPTION: uma descrição legível da restrição a ser exibida como uma mensagem de erro quando a política for violada. Esse campo pode conter até 2.000 caracteres.

Depois de criar o arquivo YAML para uma nova restrição personalizada, faça a configuração necessária para disponibilizá-la para as políticas da organização. Para configurar uma restrição personalizada, use o comando gcloud org-policies set-custom-constraint:

        gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Substitua CONSTRAINT_PATH pelo caminho completo do arquivo de restrição personalizada. Por exemplo, /home/user/customconstraint.yaml.

Após a conclusão, as restrições personalizadas vão estar disponíveis como políticas da organização na lista de políticas da organização do Google Cloud .

Para verificar se a restrição personalizada existe, use o comando gcloud org-policies list-custom-constraints:

      gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

Substitua ORGANIZATION_ID pelo ID do recurso da organização.

Para mais informações, consulte Como visualizar políticas da organização.

Aplicar uma política personalizada da organização

Para aplicar uma restrição, crie uma política da organização que faça referência a ela e aplique essa política a um recurso do Google Cloud .

Console

No console do Google Cloud , acesse a página Políticas da organização.
Acessar a página Políticas da organização
No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
Na lista da página Políticas da organização, selecione uma restrição para acessar a página Detalhes da política associada.
Para configurar a política da organização nesse recurso, clique em Gerenciar política.
Na página Editar política, selecione Substituir a política do recurso pai.
Clique em Adicionar uma regra.
Na seção Aplicação, selecione se essa política da organização é aplicada ou não.
Opcional: para tornar a política da organização condicional em uma tag, clique em Adicionar condição. Se você adicionar uma regra condicional a uma política da organização, inclua pelo menos uma regra não condicional para que a política seja salva. Para mais informações, consulte Como definir uma política da organização com tags.
Clique em Testar mudanças para simular o efeito da política da organização. Para mais informações, consulte Testar mudanças na política da organização com o Simulador de política.
Para aplicar a política da organização no modo de teste, clique em Definir política de simulação. Para mais informações, consulte Criar uma política da organização no modo de simulação.
Depois de verificar se a política da organização no modo de simulação funciona como esperado, clique em Definir política para definir a política ativa.

gcloud

Para criar uma política da organização com regras booleanas, crie um arquivo YAML para a política que faça referência à restrição:

        name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
        spec:
          rules:
          - enforce: true
        
        dryRunSpec:
          rules:
          - enforce: true

Substitua:

PROJECT_ID: o projeto em que você quer aplicar a restrição.
CONSTRAINT_NAME: o nome definido para a restrição personalizada. Por exemplo, custom.allowEmailLinkLogin.

Para aplicar a política da organização no modo de teste, execute o seguinte comando com a flag dryRunSpec:

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=dryRunSpec

Substitua POLICY_PATH pelo caminho completo para o arquivo YAML da política da organização. A política leva até 15 minutos para entrar em vigor.

Depois de verificar se a política da organização no modo de simulação funciona conforme o esperado, defina a política ativa com o comando org-policies set-policy e a flag spec:

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=spec

Substitua POLICY_PATH pelo caminho completo para o arquivo YAML da política da organização. A política leva até 15 minutos para entrar em vigor.

Testar a política personalizada da organização

Para testar a política personalizada da organização, tente ativar a multitenância para o projeto:

curl -i -X PATCH \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-d '
{
  "sign_in": {"email": {"password_required": false}}
}' https://autopush-identitytoolkit.sandbox.googleapis.com/admin/v2/projects/shimingz-playground-1/config\?update_mask\=sign_in.email.password_required

A saída será semelhante a esta:

Operation denied by custom org policies: ["customConstraints/custom.allowEmailLinkLogin": "Cannot disable email link login."]

Recursos e operações com suporte do Identity Platform

O Identity Platform é compatível com os seguintes recursos para políticas personalizadas da organização:

Campos sem suporte

Os seguintes campos não são aceitos porque se referem à segurança do recurso:

identitytoolkit.googleapis.com/Config:
- resource.notification.send_email.smtp.password
identitytoolkit.googleapis.com/DefaultSupportedIdpConfig:
- resource.client_secret
identitytoolkit.googleapis.com/OauthIdpConfig:
- resource.client_secret

Exemplos de políticas personalizadas da organização para casos de uso comuns

A tabela a seguir mostra a sintaxe de algumas políticas da organização personalizadas que podem ser úteis:

Descrição	Sintaxe da restrição
Não desative o login por e-mail para o aplicativo	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.enableEmailLogin resourceTypes: - identitytoolkit.googleapis.com/Config methodTypes: - CREATE - UPDATE condition: "resource.signIn.email.enabled == true" actionType: ALLOW displayName: Enable email login description: All applications must have email login enabled.
Permitir apenas o login com o Google com um ID do cliente específico do Google	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.denyUnexpectedGoogleClientId resourceTypes: - identitytoolkit.googleapis.com/DefaultSupportedIdpConfig methodTypes: - CREATE - UPDATE condition: "resource.name.contains('google.com') && !resource.client_id == 'my-client-id'" actionType: DENY displayName: Only allow login with Google with specific Google client ID description: Only allow login with Google with specific Google client ID for all applications.
Permitir apenas uma entidade SAML específica	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.allowSpecificSamlEntity resourceTypes: - identitytoolkit.googleapis.com/InboundSamlConfig methodTypes: - CREATE - UPDATE condition: "resource.idp_config.idp_entity_id == 'my-saml-entity-id'" actionType: ALLOW displayName: Only allow a specific SAML entity description: Only allow a specific SAML entity for applications in this organization.
Permitir IdP OIDC com fluxo de código	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.allowOauthIdpWithCodeFlow resourceTypes: - identitytoolkit.googleapis.com/OauthIdpConfig methodTypes: - CREATE - UPDATE condition: "resource.response_type.code == true" actionType: ALLOW displayName: Allow OIDC IdP with code flow description: All OIDC IdP must use code flow.
Permitir região de SMS nos EUA	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.allowSmsRegion resourceTypes: - identitytoolkit.googleapis.com/Tenant methodTypes: - CREATE - UPDATE condition: "resource.sms_region_config.allow_by_default.disallowed_regions.exists(disallowed_region, disallowed_region != 'US')" actionType: DENY displayName: Allow SMS region in US description: Only allow SMS to be operated in the US for all applications.

A seguir

Consulte Introdução ao serviço Política da organização para saber mais sobre as políticas da organização.
Saiba mais sobre como criar e gerenciar políticas da organização.
Veja a lista completa de restrições da política da organização predefinidas.