Deleting a user pool
Note
This feature is at the Preview stage.
- Log in to Yandex Identity Hub
using an administrator or organization owner account. - In the left-hand panel, select
User pools. - In the user pool row, click
and select Delete. - In the window that opens, confirm deleting the 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.
-
View the description of the CLI command for deleting a user pool:
yc organization-manager idp userpool delete --help -
Run this command:
yc organization-manager idp userpool delete <pool_ID>
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
-
Open the Terraform configuration file and delete the fragment with the user pool description:
resource "yandex_organizationmanager_idp_userpool" "example_userpool" { organization_id = "<organization_ID>" name = "<pool_name>" description = "<pool_description>" default_subdomain = "<default_domain>" labels = { <key> = "<value>" } }For more information about
yandex_organizationmanager_idp_userpoolproperties, see the relevant provider documentation. -
Apply the changes:
-
In the terminal, go to the directory where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validateIf the configuration is correct, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou 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.
-
Apply the changes:
terraform apply -
Type
yesand press Enter to confirm the changes.
Terraform will delete all the resources as appropriate. You can check the deletion of the resources in Yandex Identity Hub
or using this CLI command:yc organization-manager idp userpool list --organization-id <organization_ID> -
Use the Userpool.Delete REST API method for the Userpool resource or the UserpoolService/Delete gRPC API call.