ALTER AUTHENTICATION POLICY¶

Modifica as propriedades de uma política de autenticação.

Consulte também:: CREATE AUTHENTICATION POLICY, DESCRIBE AUTHENTICATION POLICY, DROP AUTHENTICATION POLICY, SHOW AUTHENTICATION POLICIES

Sintaxe¶

ALTER AUTHENTICATION POLICY <name> RENAME TO <new_name>

ALTER AUTHENTICATION POLICY [ IF EXISTS ] <name> SET
  [ AUTHENTICATION_METHODS = ( '<string_literal>' [ , '<string_literal>' , ...  ] ) ]
  [ CLIENT_TYPES = ( '<string_literal>' [ , '<string_literal>' , ...  ] ) ]
  [ CLIENT_POLICY = ( <client_type> = ( MINIMUM_VERSION = '<version>' ) [ , ... ] ) ]
  [ SECURITY_INTEGRATIONS = ( '<string_literal>' [ , '<string_literal>' , ...  ] ) ]
  [ MFA_ENROLLMENT = { 'REQUIRED' | 'REQUIRED_PASSWORD_ONLY' } ]
  [ MFA_POLICY= ( <list_of_properties> ) ]
  [ PAT_POLICY = ( <list_of_properties> ) ]
  [ WORKLOAD_IDENTITY_POLICY = ( <list_of_properties> ) ]
  [ COMMENT = '<string_literal>' ]

ALTER AUTHENTICATION POLICY [ IF EXISTS ] <name> UNSET
  [ AUTHENTICATION_METHODS ]
  [ SECURITY_INTEGRATIONS ]
  [ MFA_ENROLLMENT ]
  [ MFA_POLICY ]
  [ CLIENT_TYPES ]
  [ CLIENT_POLICY ]
  [ SECURITY_INTEGRATIONS ]
  [ PAT_POLICY ]
  [ WORKLOAD_IDENTITY_POLICY ]
  [ COMMENT ]

Copy

Parâmetros¶

name

Especifica o identificador para a política de autenticação a ser alterada.

Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Para obter mais informações, consulte Requisitos para identificadores.

RENAME TO ...

Especifica um novo nome para uma política de autenticação existente.

SET ...

Especifica uma ou mais propriedades a serem definidas para a política de autenticação, separadas por espaços em branco, vírgulas ou novas linhas.

AUTHENTICATION_METHODS = ( 'string_literal' [ , 'string_literal' , ... ] )

Altera os métodos de autenticação permitidos durante o login. Este parâmetro aceita um ou mais dos seguintes valores:

Cuidado

A restrição por método de autenticação pode ter consequências indesejadas, como o bloqueio de conexões de driver ou integrações de terceiros.

ALL: Permitir todos os métodos de autenticação.
SAML: Permite integrações de segurança SAML2. Se SAML estiver presente, uma opção de login SSO será exibida. Se SAML não estiver presente, uma opção de login SSO não aparecerá.
PASSWORD: Permite que os usuários se autentiquem usando nome de usuário e senha.
OAUTH: Permite OAuth externo.
KEYPAIR: Permite autenticação do par de chaves.
PROGRAMMATIC_ACCESS_TOKEN: Permite que os usuários se autentiquem com um token de acesso programático.
WORKLOAD_IDENTITY: Permite que os usuários se autentiquem através de federação de identidades de cargas de trabalho.

Padrão: ALL.

CLIENT_TYPES = ( 'string_literal' [ , 'string_literal' , ... ] )

Altera quais clientes podem autenticar com Snowflake.

Se um cliente tentar se conectar e não for um dos valores válidos de CLIENT_TYPES listados abaixo, a tentativa de login falhará.

Se você definir MFA_ENROLLMENT como REQUIRED, deverá incluir SNOWFLAKE_UI na lista CLIENT_TYPES para permitir que os usuários se inscrevam em MFA.

Se você quiser excluir SNOWFLAKE_UI da lista CLIENT_TYPES, deverá definir MFA_ENROLLMENT como OPTIONAL.

The CLIENT_TYPES property of an authentication policy is a best-effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary. Notably, it does not restrict access to the Snowflake REST APIs.

Esta propriedade aceita um ou mais dos seguintes valores:

ALL: Permitir que todos os clientes se autentiquem.
SNOWFLAKE_UI: Snowsight ou Classic Console, as interfaces da Web do Snowflake.

Cuidado

If SNOWFLAKE_UI is not included in the CLIENT_TYPES list while MFA_ENROLLMENT is set to REQUIRED, or MFA_ENROLLMENT is unspecified, MFA enrollment doesn’t work.
DRIVERS: Os drivers permitem acesso ao Snowflake a partir de aplicativos escritos em linguagens suportadas. Por exemplo, os drivers Go, JDBC, .NET e Snowpipe Streaming.

Cuidado

Se DRIVERS não estiver incluído na lista CLIENT_TYPES, a ingestão automatizada poderá parar de funcionar.
SNOWFLAKE_CLI: Um cliente de linha de comando para se conectar ao Snowflake e para gerenciar cargas de trabalho centradas no desenvolvedor e operações SQL.
SNOWSQL: Um cliente de linha de comando para conexão com o Snowflake.

Se um cliente tentar se conectar e não for um dos CLIENT_TYPES válidos, a tentativa de login falhará. Se CLIENT_TYPES não estiver definido, qualquer cliente poderá se conectar.

Padrão: ALL.

CLIENT_POLICY = client_type = ( MINIMUM_VERSION = 'version' )

Specifies a policy within the authentication policy that sets the minimum version allowed for each specified client type.

If CLIENT_TYPES is empty, contains ALL, or contains DRIVERS, the CLIENT_POLICY parameter accepts one or more of the following driver clients (and a specific version string). For any driver client that is not specified, the policy implicitly allows any version of that client.

If CLIENT_TYPES contains another value, such as SNOWFLAKE_CLI, and does not also contain DRIVERS, specifying any of the following client types results in an error. You can’t create (or alter) an authentication policy such that the CLIENT_TYPES and CLIENT_POLICY parameters aren’t compatible.

client_type

One or more valid client type values. This is a different set of values from those that the CLIENT_TYPES parameter accepts. Do not use single quotes for these values.

JDBC_DRIVER (Snowflake JDBC Driver)
ODBC_DRIVER (Snowflake ODBC Driver)
PYTHON_DRIVER (Snowflake Python Driver)
JAVASCRIPT_DRIVER (Snowflake Javascript Driver)
C_DRIVER (Libsnowflakeclient C Driver)
GO_DRIVER (Snowflake Go Driver)
PHP_DRIVER (Snowflake PHP PDO Driver)
DOTNET_DRIVER (Snowflake .NET Driver)
SQL_API (SQL API)
SNOWPIPE_STREAMING_CLIENT_SDK (Snowpipe Streaming Client SDK)
PY_CORE (Snowflake Python Core Driver)
SPROC_PYTHON (Snowflake Python Stored Procedure)
PYTHON_SNOWPARK (Snowflake Python Snowpark Driver)
SQL_ALCHEMY (Snowflake SQLAlchemy)
SNOWPARK (Snowpark)
SNOWFLAKE_CLIENT (Snowflake Client SDK)

'version'

The minimum accepted version for each specified client type: a sequence of three digits delimited by periods and enclosed by single quotation marks. For example: '1.0.0' or '3.14.1'. Authentication attempts with lower client versions are blocked when this policy is in effect for an account or a user.

The CLIENT_POLICY property of an authentication policy is a best-effort method to block user logins based on specific client versions. It should not be used as the sole control to establish a security boundary.

SECURITY_INTEGRATIONS = ( 'string_literal' [ , 'string_literal' , ... ] )

Altera as integrações de segurança às quais a política de autenticação está associada. Este parâmetro não tem efeito quando SAML ou OAUTH não estão na lista AUTHENTICATION_METHODS.

Todos os valores da lista SECURITY_INTEGRATIONS devem ser compatíveis com os valores da lista AUTHENTICATION_METHODS. Por exemplo, se SECURITY_INTEGRATIONS contiver uma integração de segurança SAML e AUTHENTICATION_METHODS contiver OAUTH, não será possível criar a política de autenticação.

ALL: Permitir todas as integrações de segurança.

Padrão: ALL.

MFA_ENROLLMENT = { 'REQUIRED' | 'REQUIRED_PASSWORD_ONLY' }

Determines whether a user must enroll in multi-factor authentication. If this value is used, then the CLIENT_TYPES parameter must include SNOWFLAKE_UI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).

REQUIRED: Human users who are using password or single-sign on (SSO) authentication must enroll in MFA.
REQUIRED_PASSWORD_ONLY: All human users who are using password authentication must enroll in MFA, regardless of the client they are using. Users using SSO authentication are not required to enroll.

MFA_POLICY= ( list_of_properties )

Specifies the policies that affect how multi-factor authentication (MFA) is enforced. Set this to a space-delimited list of one or more of the following properties and values:

ALLOWED_METHODS = ( { 'ALL' | 'PASSKEY' | 'TOTP' | 'OTP' | 'DUO' } [ , { 'PASSKEY' | 'TOTP' | 'OTP' | 'DUO' } ... ] )

Specifies the multi-factor authentication (MFA) methods that users can use as a second factor of authentication. You can specify more than one method as a comma-delimited list.

ALL: Os usuários podem usar uma chave de acesso, um aplicativo autenticador ou o Duo como segundo fator de autenticação.
PASSKEY: Os usuários podem usar uma chave de acesso como segundo fator de autenticação.
TOTP: Os usuários podem usar um aplicativo autenticador como segundo fator de autenticação.
OTP: User can use a one-time passcode as their second factor of authentication. For more information, see Configuração de administradores para acesso de emergência.
DUO: Os usuários podem usar o Duo como segundo fator de autenticação.

Padrão: ALL.

ENFORCE_MFA_ON_EXTERNAL_AUTHENTICATION = { 'ALL' | 'NONE' }

Specifies whether multi-factor authentication (MFA) is required when users authenticate with single sign-on (SSO). To require MFA, specify ALL.

Default: NONE

PAT_POLICY = ( list_of_properties )

Especifica as políticas para tokens de acesso programático. Defina isso como uma lista delimitada por espaço de uma ou mais das seguintes propriedades e valores:

DEFAULT_EXPIRY_IN_DAYS = number_of_days

Especifica o tempo de expiração padrão (em dias) para um token de acesso programático. Você pode especificar um valor de 1 até o tempo de expiração máximo (que você pode especificar configurando MAX_EXPIRY_IN_DAYS).

O tempo de expiração padrão é de 15 dias.

Para obter mais informações, consulte Configuração do tempo de expiração padrão.

MAX_EXPIRY_IN_DAYS = number_of_days

Especifica o número máximo de dias que pode ser definido para o tempo de expiração de um token de acesso programático. Você pode especificar um valor do tempo de expiração padrão (que você pode especificar definindo DEFAULT_EXPIRY_IN_DAYS) a 365.

O tempo de expiração máximo padrão é de 365 dias.

Nota

Se houver tokens de acesso programático existentes com tempos de expiração que excedam o novo tempo máximo de expiração, as tentativas de autenticação com esses tokens falharão.

Por exemplo, suponha que você gere um token de acesso programático chamado my_token com o tempo de expiração de 7 dias. Se você alterar posteriormente o tempo máximo de expiração de todos os tokens para 2 dias, a autenticação com my_token falhará porque o tempo de expiração do token excede o novo tempo máximo de expiração.

Para obter mais informações, consulte Configuração do tempo máximo de expiração.

NETWORK_POLICY_EVALUATION = { ENFORCED_REQUIRED | ENFORCED_NOT_REQUIRED | NOT_ENFORCED }

Especifica como os requisitos de política de redes são tratados para tokens de acesso programático.

Por padrão, um usuário deve estar sujeito a uma política de redes com uma ou mais regras de rede para gerar ou usar tokens de acesso programático:

Os usuários do serviço (com TYPE=SERVICE) devem estar sujeitos a uma política de redes para gerar e usar tokens de acesso programático.
Os usuários humanos (com TYPE=PERSON) devem estar sujeitos a uma política de redes para usar tokens de acesso programático.

Para substituir esse comportamento, defina essa propriedade como um dos seguintes valores:

ENFORCED_REQUIRED (comportamento padrão)

O usuário deve estar sujeito a uma política de redes para gerar e usar tokens de acesso programático.

Se o usuário estiver sujeito a uma política de redes, a política de redes será aplicada durante a autenticação.

ENFORCED_NOT_REQUIRED

O usuário não precisa estar sujeito a uma política de redes para gerar e usar tokens de acesso programático.

Se o usuário estiver sujeito a uma política de redes, a política de redes será aplicada durante a autenticação.

NOT_ENFORCED

O usuário não precisa estar sujeito a uma política de redes para gerar e usar tokens de acesso programático.

Se o usuário estiver sujeito a uma política de redes, a política de redes não será aplicada durante a autenticação.

Por exemplo:

PAT_POLICY=(
  DEFAULT_EXPIRY_IN_DAYS=30
  MAX_EXPIRY_IN_DAYS=365
  NETWORK_POLICY_EVALUATION = ENFORCED_NOT_REQUIRED
);

Copy

WORKLOAD_IDENTITY_POLICY = ( list_of_properties )

Especifica as políticas para federação de identidades de cargas de trabalho. Defina como uma lista delimitada por espaço que contenha uma ou mais das seguintes propriedades e valores:

ALLOWED_PROVIDERS = ( { ALL | AWS | AZURE | GCP | OIDC } [ , { AWS | AZURE | GCP | OIDC } ... ] )

Especifica os provedores de identidade de carga de trabalho permitidos pela política de autenticação durante a autenticação de identidade de carga de trabalho. Se esse parâmetro for omitido, todos os provedores de identidade de carga de trabalho serão permitidos.

ALL: Os usuários podem se autenticar com qualquer provedor de identidade de carga de trabalho com suporte e configurado.
AWS: Os usuários podem ser autenticados com uma função ou usuário do AWS IAM.
AZURE: Os usuários podem se autenticar com um token de acesso do Azure Entra ID.
GCP: Os usuários podem ser autenticados com um token de ID assinado pelo Google.
OIDC: Os usuários podem ser autenticados com um token de ID de um provedor OIDC configurado.

ALLOWED_AWS_ACCOUNTS = ( 'string_literal' [ , 'string_literal' , ... ] )

Especifica a lista de IDs de contas da AWS permitido pela política de autenticação durante a autenticação de identidade de carga de trabalho do tipo AWS.

Por padrão, quando um usuário do serviço Snowflake tem uma WORKLOAD_IDENTITY do tipo AWS, então o ARN pode fazer referência a qualquer conta da AWS. Se esse parâmetro for definido, então somente os ARNs dos IDs de contas da AWS especificados têm permissão para autenticar.

Cada elemento deve ser uma string de 12 dígitos representando o ID da conta da AWS.

Para obter mais informações, consulte Exibir identificadores de contas da AWS.

ALLOWED_AZURE_ISSUERS = ( 'string_literal' [ , 'string_literal' , ... ] )

Especifica a lista de emissores do Azure Entra ID permitidos pela política de autenticação durante a autenticação de identidade de carga de trabalho do tipo AZURE.

Por padrão, quando um usuário do serviço Snowflake tem uma WORKLOAD_IDENTITY do tipo AZURE, o emissor pode ser qualquer Entra ID de locatário. Se esse parâmetro for definido, então somente os tokens Azure dos emissores especificados têm permissão para autenticação.

Cada elemento deve ser um URL de autoridade válido com o seguinte formato:

https://login.microsoftonline.com/tenantId/v2.0

ALLOWED_OIDC_ISSUERS = ( 'string_literal' [ , 'string_literal' , ... ] )

Especifica a lista de emissores OIDC permitidos pela política de autenticação durante a autenticação de identidade de carga de trabalho do tipo OIDC.

Por padrão, quando um usuário do serviço Snowflake tem uma WORKLOAD_IDENTITY do tipo OIDC, então o emissor pode ser qualquer emissor OIDC válido. Se esse parâmetro for definido, então apenas tokens dos emissores OIDC especificados podem ser autenticados.

Cada elemento deve ser um URL HTTPS válido que contém componentes de esquema, host e, opcionalmente, número de porta e caminho, mas nenhum componente de consulta ou fragmento. O URL não deve conter espaços e não deve exceder 2048 caracteres de comprimento.

Por exemplo:

WORKLOAD_IDENTITY_POLICY=(
  ALLOWED_PROVIDERS = (AWS, AZURE, GCP, OIDC)
  ALLOWED_AWS_ACCOUNTS = ('123456789012', '210987654321')
  ALLOWED_AZURE_ISSUERS = ('https://login.microsoftonline.com/8c7832f5-de56-4d9f-ba94-3b2c361abe6b/v2.0',
    'https://login.microsoftonline.com/9ebd1ec9-9a78-4429-8f53-5cf870a812d1/v2.0')
  ALLOWED_OIDC_ISSUERS = ('https://my.custom.oidc.issuer/', 'https://another.custom/oidc/issuer')
);

Copy

COMMENT = 'string_literal': Altera o comentário da política de autenticação.

UNSET ...

Especifica as propriedades a serem removidas para a política de autenticação, o que as restaura para os padrões.

Requisitos de controle de acesso¶

A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:

Privilégio	Objeto	Notas
OWNERSHIP	Política de autenticação	Only the SECURITYADMIN role, or a higher role, has this privilege by default. The privilege can be granted to additional roles as needed.

O privilégio USAGE no banco de dados e no esquema pai é necessário para executar operações em qualquer objeto de um esquema. Observe que uma função com privilégio concedido em um esquema permite que essa função resolva o esquema. Por exemplo, uma função com privilégio CREATE concedido em um esquema pode criar objetos nesse esquema sem também ter USAGE concedido nesse esquema.

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso¶

Se você quiser atualizar uma política de autenticação existente e precisar ver a definição da política, execute o comando DESCRIBE AUTHENTICATION POLICY ou a função GET_DDL.

Exemplos¶

Altere a lista de clientes permitidos em uma política de autenticação:

ALTER AUTHENTICATION POLICY restrict_client_types_policy
  SET CLIENT_TYPES = ('SNOWFLAKE_UI', 'SNOWSQL');

Copy