Atualização da configuração do pool de usuários e do cliente do aplicativo - Amazon Cognito
Configurações que você não pode alterarSMSconfiguraçãoAtualizando um grupo de usuários com um AWS SDK AWS CDK, ou REST API

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Atualização da configuração do pool de usuários e do cliente do aplicativo

Quando quiser alterar uma configuração em um grupo de usuários ou cliente de aplicativo, você pode aplicar a atualização no console do Amazon Cognito com alguns cliques. Você navega pelas guias baseadas em recursos nas configurações do grupo de usuários e nos campos de atualização, conforme descrito em outras áreas deste guia.

Muitas organizações gerenciam seus recursos de forma programática em AWS CloudFormation aplicativos desenvolvidos no AWS SDKs ou e em outros CDK softwares de automação. Quando esse é seu modelo de gerenciamento de recursos, você deve tomar cuidado extra ao fazer alterações em seus recursos.

API UpdateUserPoolOpere e UpdateUserPoolClientfaça atualizações em um grupo de usuários ou cliente de aplicativo existente. Cada um vem com um aviso na API Referência: se você não fornecer um valor para um atributo, o Amazon Cognito o define como seu valor padrão. Quando você envia uma solicitação de atualização com apenas um parâmetro, o Amazon Cognito define esse parâmetro com o valor de sua escolha e define todos os outros como um valor padrão. Isso pode redefinir configurações, incluindo seu esquema de atributos, seus acionadores Lambda e sua configuração de e-mail e mensagem. SMS

Além disso, algumas configurações são bloqueadas após a criação do grupo de usuários ou do cliente do aplicativo, e você não pode alterá-las a menos que crie um novo recurso.

Configurações que você não pode alterar

Após a criação de um grupo de usuários, não é possível alterar algumas configurações. Se quiser alterar as configurações a seguir, crie um grupo de usuários ou um cliente da aplicação.

Nome do grupo de usuários

APInome do parâmetro: PoolName

O nome amigável que você atribuiu ao seu grupo de usuários. Para alterar o nome de um grupo de usuários, crie outro grupo de usuários.

Opções de login do grupo de usuários do Amazon Cognito

APInomes dos parâmetros: AliasAttributese UsernameAttributes

Os atributos que seus usuários podem transmitir como nome de usuário ao fazerem login. Ao criar um grupo de usuários, você pode optar por permitir o login com nome de usuário, endereço de e-mail, número de telefone ou nome de usuário preferido. Para alterar as opções de login do grupo de usuários, crie outro grupo de usuários.

Make user name case sensitive (Diferenciar maiúsculas e minúsculas no nome de usuário)

APInome do parâmetro: UsernameConfiguration

Quando você cria um nome de usuário que corresponde a outro nome de usuário, exceto pelo uso de maiúsculas/minúsculas, o Amazon Cognito pode tratá-lo como o mesmo usuário ou como usuários únicos. Para obter mais informações, consulte Sensibilidade entre maiúsculas e minúsculas do grupo de usuários. Para alterar a distinção entre maiúsculas e minúsculas, crie outro grupo de usuários.

Segredo do cliente

APInome do parâmetro: GenerateSecret

Ao criar um cliente da aplicação, você pode gerar um segredo de cliente para que somente fontes confiáveis possam fazer solicitações ao grupo de usuários. Para obter mais informações, consulte Configurações específicas do aplicativo com clientes de aplicativos. Para alterar um segredo de cliente, crie outro cliente da aplicação no mesmo grupo de usuários.

Atributos obrigatórios

APInome do parâmetro: Esquema

Os atributos aos quais seus usuários devem fornecer valores no cadastro ou quando você os cria. Para obter mais informações, consulte Trabalhando com atributos do usuário. Para alterar os atributos necessários, crie outro grupo de usuários.

Atributos personalizados

APInome do parâmetro: Esquema

Atributos com nomes personalizados. Você pode alterar o valor do atributo personalizado de um usuário, mas não é possível excluir um atributo personalizado do grupo de usuários. Para obter mais informações, consulte Trabalhando com atributos do usuário. Se você atingir o número máximo de atributos personalizados e quiser modificar a lista, crie outro grupo de usuários.

SMSconfiguração

Depois de ativar SMS as mensagens no seu grupo de usuários, você não poderá desativá-las.

  • Se você optar por configurar SMS mensagens ao criar um grupo de usuários, não poderá desativar SMS depois de concluir a configuração.

  • Você pode ativar SMS mensagens em um grupo de usuários que você criou, mas depois disso você não pode desativarSMS.

  • O Amazon Cognito pode usar SMS mensagens para convite e recuperação de contas de usuários, verificação de atributos e autenticação multifatorial (). MFA Depois de ativar SMS as mensagens, você pode ativar ou desativar as SMS mensagens para essas funções a qualquer momento.

  • SMSa configuração de mensagens inclui uma IAM função que você delega ao Amazon Cognito para enviar mensagens com a Amazon. SNS Você pode alterar a função atribuída a qualquer momento.

Atualizando um grupo de usuários com um AWS SDK AWS CDK, ou REST API

No console do Amazon Cognito, você pode alterar as configurações do grupo de usuários, um parâmetro por vez. Por exemplo, para adicionar um gatilho Lambda, você escolhe Adicionar gatilho Lambda e escolhe a função e o tipo de gatilho. Os grupos de usuários do Amazon Cognito API são estruturados de forma que as operações de atualização para grupos de usuários e clientes de aplicativos exijam o conjunto completo de parâmetros para o grupo de usuários. No entanto, o console automatiza de forma transparente essa operação de atualização com suas outras configurações do grupo de usuários.

Às vezes, você pode descobrir que uma alteração em outro lugar Conta da AWS pode fazer com que as atualizações gerem um erro quando não estão relacionadas à configuração que você deseja alterar. Uma SES identidade da Amazon excluída ou uma alteração em uma IAM permissão para AWS WAF, por exemplo. Se um dos parâmetros atuais não for mais válido, você não poderá atualizar suas configurações até corrigi-lo. Ao encontrar esse erro, examine a resposta do erro e valide a configuração mencionada.

Os grupos AWS Cloud Development Kit (AWS CDK)de usuários do Amazon Cognito AWS SDKssão ferramentas para automação REST API e configuração programática dos recursos do Amazon Cognito. As solicitações com essas ferramentas também devem, como o console do Amazon Cognito, atualizar uma configuração com uma configuração completa de recursos no corpo da solicitação. Em um alto nível, você deve executar o seguinte processo.

  1. Capture a saída de uma operação que descreve a configuração do seu recurso existente.

  2. Modifique a saída com a alteração das configurações.

  3. Envie a configuração modificada em uma operação que atualiza seu recurso.

O procedimento a seguir atualiza sua configuração com a UpdateUserPoolAPIoperação. A mesma abordagem, com campos de entrada diferentes, se aplica UpdateUserPoolClienta.

Importante

Se você não fornecer valores para os parâmetros existentes, o Amazon Cognito os definirá como valores padrão. Por exemplo, quando você já tiver uma LambdaConfig e enviar um UpdateUserPool com uma LambdaConfig em branco, exclua a atribuição de todas as funções do Lambda para acionadores do grupo de usuários. Planeje adequadamente quando quiser automatizar as alterações na configuração do grupo de usuários.

  1. Capture o estado existente do seu grupo de usuários com DescribeUserPool.

  2. Formate a saída do DescribeUserPool de forma que corresponda aos parâmetros da solicitação do UpdateUserPool. Remova os seguintes campos de nível superior e seus objetos secundários da saídaJSON.

    • Arn

    • CreationDate

    • CustomDomain

    • Domain

    • EmailConfigurationFailure

    • EstimatedNumberOfUsers

    • Id

    • LastModifiedDate

    • Name

    • SchemaAttributes

    • SmsConfigurationFailure

    • Status

  3. Confirme se o resultado JSON corresponde aos parâmetros da solicitação deUpdateUserPool.

  4. Modifique todos os parâmetros que você deseja alterar no resultadoJSON.

  5. Envie uma UpdateUserPool API solicitação com sua modificação JSON como entrada da solicitação.

Você também pode usar essa saída modificada do DescribeUserPool no parâmetro --cli-input-json do update-user-pool na AWS CLI.

Como alternativa, execute o AWS CLI comando a seguir para gerar JSON valores em branco para os campos de entrada aceitos para. update-user-pool Depois, você pode preencher esses campos com os valores de seu grupo de usuários.

aws cognito-idp update-user-pool --generate-cli-skeleton --output json

Execute o comando a seguir para gerar o mesmo JSON objeto para um cliente de aplicativo.

aws cognito-idp update-user-pool-client --generate-cli-skeleton --output json