Редактировать пул пользователей

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

1. Посмотрите описание команды CLI для редактирования пула пользователей:

   yc organization-manager idp userpool update --help
   

2. Выполните команду:

   yc organization-manager idp userpool update <идентификатор_пула> \
     --userpool-name <название_пула> \
     --description <описание_пула> \
     --default-subdomain <домен_по_умолчанию> \
     --labels <ключ>=<значение>[,<ключ>=<значение>]
   

   Где:

   • --userpool-name — новое название пула пользователей. Название должно быть уникальным в рамках организации и соответствовать требованиям:

     • длина — от 1 до 63 символов;
     • может содержать строчные буквы латинского алфавита, цифры и дефисы;
     • первый символ — буква, последний — не дефис.

   • --description — новое описание пула пользователей.

   • --labels — новый список меток. Можно указать одну или несколько меток через запятую в формате <ключ1>=<значение1>,<ключ2>=<значение2>.

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform или в зеркале.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

1. Откройте конфигурационный файл Terraform и измените параметры пула пользователей:

   resource "yandex_organizationmanager_idp_userpool" "example_userpool" {
     organization_id   = "<идентификатор_организации>"
     name              = "<название_пула>"
     description       = "<описание_пула>"
     default_subdomain = "<домен_по_умолчанию>"
     labels            = {
       <ключ> = "<значение>"
     }
   }
   

   Где:

   • name — новое название пула пользователей. Название должно быть уникальным в рамках организации и соответствовать требованиям:

     • длина — от 1 до 63 символов;
     • может содержать строчные буквы латинского алфавита, цифры и дефисы;
     • первый символ — буква, последний — не дефис.

   • description — новое описание пула пользователей.

   • default_subdomain — новый домен по умолчанию. Будет использоваться, если к пулу не привязаны другие домены.

   • labels — новый список меток.

   Более подробную информацию о параметрах ресурса yandex_organizationmanager_idp_userpool см. в документации провайдера.

2. Примените изменения:

   1. В терминале перейдите в папку, где вы отредактировали конфигурационный файл.

   2. Проверьте корректность конфигурационного файла с помощью команды:

      terraform validate
      

      Если конфигурация является корректной, появится сообщение:

      Success! The configuration is valid.
      

   3. Выполните команду:

      terraform plan
      

      В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

   4. Примените изменения конфигурации:

      terraform apply
      

   5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.

   Terraform обновит все требуемые ресурсы. Проверить изменения можно в Yandex Identity Hub или с помощью команды CLI:

   yc organization-manager idp userpool get <идентификатор_пула>
   

Воспользуйтесь методом REST API Userpool.Update для ресурса Userpool или вызовом gRPC API UserpoolService/Update.