[Yandex Cloud documentation](../../../index.md) > [Yandex Identity Hub](../../index.md) > [Step-by-step guides](../index.md) > Managing user pools > Creating a user pool

# Creating a user pool


{% list tabs group=instructions %}

- Cloud Center UI {#cloud-center}

  1. Log in to [Yandex Identity Hub](https://center.yandex.cloud/organization).
  1. In the left-hand panel, select ![userpool](../../../_assets/organization/userpool.svg) **User pools**.  
  1. In the top-right corner of the page, click ![Circles3Plus](../../../_assets/console-icons/circles-3-plus.svg) **Create user pool**.
  1. Specify a name and description for the [user pool](../../concepts/user-pools.md).

      The name must be unique within the organization and follow these 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.

  1. In the **Default domain** field, add the [domain](../../concepts/domains.md) that will be used if no other domains are linked to the pool.
  1. Optionally, add labels:
     1. Click **Add label**.
     1. Add a label in `key: value` format.
     1. Press **Enter**.
  1. Optionally, in the **Data available for editing** field, select the user settings available for editing on the [My account](../../concepts/my-account.md) portal. By default, password management is allowed.
  1. In the **Lifetime session** field, specify a time period for user [sessions](../../concepts/sessions.md) to remain active before requiring reauthentication in Yandex Identity Hub.
  1. Click **Create userpool**.

- CLI {#cli}

  If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../../cli/quickstart.md#install).

  The folder used by default is the one specified when [creating](../../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id <folder_ID>` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

  1. See the description of the CLI command for creating a [user pool](../../concepts/user-pools.md):

     ```bash
     yc organization-manager idp userpool create --help
     ```

  1. Run this command:

     ```bash
     yc organization-manager idp userpool create \
       --organization-id <organization_ID> \
       --userpool-name <pool_name> \
       --description <pool_description> \
       --default-subdomain <default_domain> \
       --labels <key>=<value>[,<key>=<value>]
     ```

     Where:
     
     * `--organization-id`: [ID of the organization](../organization-get-id.md) you want to create a user pool in.
     * `--userpool-name`: 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`: User pool description. This is an optional setting.
     * `--default-subdomain`: Default [domain](../../concepts/domains.md). It will be used if no other domains are linked to the pool.
     * `--labels`: List of [labels](../../../resource-manager/concepts/labels.md). This is an optional setting. You can specify one or more labels separated by commas in `<key1>=<value1>,<key2>=<value2>` format.

- Terraform {#tf}

  With [Terraform](https://www.terraform.io/), 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](https://github.com/hashicorp/terraform/blob/main/LICENSE). The [Yandex Cloud provider for Terraform](https://github.com/yandex-cloud/terraform-provider-yandex) is distributed under the [MPL-2.0](https://www.mozilla.org/en-US/MPL/2.0/) license.
  
  For more information about the provider resources, see the guides on the [Terraform](https://www.terraform.io/docs/providers/yandex/index.html) website or [its mirror](../../../terraform/index.md).

  If you do not have Terraform yet, [install it and configure the Yandex Cloud provider](../../../tutorials/infrastructure-management/terraform-quickstart.md#install-terraform).
  
  
  To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), [authenticate](../../../terraform/authentication.md) using the appropriate method.

  1. Describe the [user pool](../../concepts/user-pools.md) parameters in the configuration file:

     ```hcl
     resource "yandex_organizationmanager_idp_userpool" "example_userpool" {
       organization_id   = "<organization_ID>"
       name              = "<pool_name>"
       description       = "<pool_description>"
       default_subdomain = "<default_domain>"
       labels            = {
         <key> = "<value>"
       }
       user_settings {
          allow_edit_self_contacts = <true_or_false>
          allow_edit_self_info = <true_or_false>
          allow_edit_self_login = <true_or_false>
          allow_edit_self_password = <true_or_false>
       }
     }
     ```

     Where:

     * `organization_id`: ID of the organization you want to create a user pool in.
     * `name`: 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`: User pool description. This is an optional setting.
     * `default_subdomain`: Default [domain](../../concepts/domains.md). It will be used if no other domains are linked to the pool.
     * `labels`: List of [labels](../../../resource-manager/concepts/labels.md). This is an optional setting.
     * `user_settings`: User data available for editing on the [My account](../../concepts/my-account.md) portal. By default, password management is allowed. This is an optional setting. Includes the following options:
       * `allow_edit_self_contacts`: Editing contact details.
       * `allow_edit_self_info`: Editing personal data.
       * `allow_edit_self_login`: Editing username.
       * `allow_edit_self_password`: Editing password.

     For more on the properties of the `yandex_organizationmanager_idp_userpool` resource, see [this provider guide](../../../terraform/resources/organizationmanager_idp_userpool.md).

  1. Create the resources:

     1. In the terminal, navigate to the configuration file directory.
     1. Make sure the configuration is correct using this command:
     
        ```bash
        terraform validate
        ```
     
        If the configuration is valid, you will get this message:
     
        ```bash
        Success! The configuration is valid.
        ```
     
     1. Run this command:
     
        ```bash
        terraform plan
        ```
     
        You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.
     1. Apply the configuration changes:
     
        ```bash
        terraform apply
        ```
     
     1. Type `yes` and press **Enter** to confirm the changes.

     Terraform will create all the required resources. You can check the new resources and their settings in the [Cloud Center UI](https://center.yandex.cloud/organization) or using this [CLI](../../../cli/index.md) command:

     ```bash
     yc organization-manager idp userpool list --organization-id <organization_ID>
     ```

- API {#api}

  Use the [Userpool.Create](../../idp/api-ref/Userpool/create.md) REST API method for the [Userpool](../../idp/api-ref/Userpool/index.md) resource or the [UserpoolService/Create](../../idp/api-ref/grpc/Userpool/create.md) gRPC API call.

{% endlist %}
#### Useful links {#see-also}

* [Add local users](../add-account.md#add-local-user)
* [Associating a domain](add-domain.md)