Atualizar a configuração do grupo de usuários

Para alterar as configurações dos grupos de usuários do Amazon Cognito no AWS Management Console, navegue pelas guias baseadas em recursos nas configurações do grupo de usuários e atualize os campos conforme descrito em outras áreas deste guia. 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

Nome do parâmetro da API: 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

Nomes dos parâmetros da API: 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)

Nome do parâmetro da API: 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 ter 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

Nome do parâmetro da API: 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 ter mais informações, consulte Clientes de aplicações de grupos de usuários. Para alterar um segredo de cliente, crie outro cliente da aplicação no mesmo grupo de usuários.

Atributos obrigatórios

Nome do parâmetro da API: Esquema

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

Atributos personalizados

Nome do parâmetro da API: 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 ter mais informações, consulte Atributos de grupo de usuários. Se você atingir o número máximo de atributos personalizados e quiser modificar a lista, crie outro grupo de usuários.

Atualizar um grupo de usuários com a API do Amazon Cognito ou a AWS CLI

Você pode alterar a configuração de um grupo de usuários do Amazon Cognito com ferramentas de automação, como a API do Amazon Cognito ou a AWS Command Line Interface (AWS CLI). O procedimento a seguir atualiza sua configuração com a operação UpdateUserPoolda API. 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 campos de nível superior a seguir e seus objetos secundários da saída JSON.

   • Arn

   • CreationDate

   • CustomDomain

     • Atualize esse campo com a operação UpdateUserPoolDomainda API.

   • Domain

     • Atualize esse campo com a operação UpdateUserPoolDomainda API.

   • EmailConfigurationFailure

   • EstimatedNumberOfUsers

   • Id

   • LastModifiedDate

   • Name

   • SchemaAttributes

   • SmsConfigurationFailure

   • Status

3. Confirme se o JSON resultante corresponde aos parâmetros da solicitação do UpdateUserPool.

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

5. Envie uma solicitação de API UpdateUserPool com seu JSON modificado 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, a fim de gerar JSON com valores em branco para os campos de entrada aceitos para update-user-pool, execute o comando da AWS CLI a seguir. 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

Use o comando a seguir para gerar o mesmo objeto JSON para um cliente da aplicação.

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