Editing a user pool

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. View the description of the CLI command to update a user pool:

   yc organization-manager idp userpool update --help
   

2. Run this command:

   yc organization-manager idp userpool update <pool_ID> \
     --userpool-name <pool_name> \
     --description <pool_description> \
     --default-subdomain <default_domain> \
     --labels <key>=<value>[,<key>=<value>]
   

   Where:

   • --userpool-name: New user pool name. The name must be unique within the organization and aligned with the naming requirements:

     • It must be from 1 to 63 characters long.
     • It may contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

   • --description: New user pool description.

   • --labels: New list of labels. You can specify one or more labels separated by commas in <key1>=<value1>,<key2>=<value2> format.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. Open the Terraform configuration file and update the user pool parameters:

   resource "yandex_organizationmanager_idp_userpool" "example_userpool" {
     organization_id   = "<organization_ID>"
     name              = "<pool_name>"
     description       = "<pool_description>"
     default_subdomain = "<default_domain>"
     labels            = {
       <key> = "<value>"
     }
   }
   

   Where:

   • name: New user pool name. The name must be unique within the organization and aligned with the naming requirements:

     • It must be from 1 to 63 characters long.
     • It may contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

   • description: New user pool description.

   • default_subdomain: New default domain. It will be used if no other domains are associated with the pool.

   • labels: New list of labels.

   For more information about yandex_organizationmanager_idp_userpool properties, see the relevant provider documentation.

2. Apply the changes:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will update all the required resources. You can check the update in Yandex Identity Hub or using the CLI:

   yc organization-manager idp userpool get <pool_ID>
   

Use the Userpool.Update REST API method for the Userpool resource or the UserpoolService/Update gRPC API call.