Editing 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 line with the user pool, click and select Edit.
-
Enter a new name or description for the user pool.
The name must be unique within the organization and satisfy the relevant 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.
-
Specify a new domain to use if there are no other domains associated with the pool.
-
Add or delete labels.
-
Click Save.
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 to update a user pool:
yc organization-manager idp userpool update --help -
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.
-