[Yandex Cloud documentation](../../../../../index.md) > [Yandex Identity Hub](../../../../index.md) > API reference > gRPC > [Identity Provider API](../index.md) > [Userpool](index.md) > Get

# Identity Provider API, gRPC: UserpoolService.Get

Returns the specified userpool.
To get the list of available userpools, make a [List](list.md#List) request.

## gRPC request

**rpc Get ([GetUserpoolRequest](#yandex.cloud.organizationmanager.v1.idp.GetUserpoolRequest)) returns ([Userpool](#yandex.cloud.organizationmanager.v1.idp.Userpool))**

## GetUserpoolRequest {#yandex.cloud.organizationmanager.v1.idp.GetUserpoolRequest}

```json
{
  "userpool_id": "string"
}
```

Request to get a userpool.

#|
||Field | Description ||
|| userpool_id | **string**

Required field. ID of the userpool to return.
To get the userpool ID, make a [UserpoolService.List](list.md#List) request.

The maximum string length in characters is 50. ||
|#

## Userpool {#yandex.cloud.organizationmanager.v1.idp.Userpool}

```json
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "created_at": "google.protobuf.Timestamp",
  "updated_at": "google.protobuf.Timestamp",
  "domains": [
    "string"
  ],
  "status": "Status",
  "user_settings": {
    "allow_edit_self_password": "bool",
    "allow_edit_self_info": "bool",
    "allow_edit_self_contacts": "bool",
    "allow_edit_self_login": "bool"
  },
  "password_quality_policy": {
    "allow_similar": "bool",
    "max_length": "int64",
    "min_length": "int64",
    "match_length": "int64",
    "required_classes": {
      "lowers": "bool",
      "uppers": "bool",
      "digits": "bool",
      "specials": "bool"
    },
    "min_length_by_class_settings": {
      "one": "int64",
      "two": "int64",
      "three": "int64"
    },
    // Includes only one of the fields `fixed`, `smart`
    "fixed": {
      "lowers_required": "bool",
      "uppers_required": "bool",
      "digits_required": "bool",
      "specials_required": "bool",
      "min_length": "int64"
    },
    "smart": {
      "one_class": "int64",
      "two_classes": "int64",
      "three_classes": "int64",
      "four_classes": "int64"
    }
    // end of the list of possible fields
  },
  "password_lifetime_policy": {
    "min_days_count": "int64",
    "max_days_count": "int64"
  },
  "bruteforce_protection_policy": {
    "window": "google.protobuf.Duration",
    "block": "google.protobuf.Duration",
    "attempts": "int64"
  },
  "password_blacklist_policy": {
    "check_common": "google.protobuf.BoolValue"
  }
}
```

A userpool is a container for users in the Identity Provider system.

#|
||Field | Description ||
|| id | **string**

Unique identifier of the userpool. ||
|| organization_id | **string**

ID of the organization this userpool belongs to. ||
|| name | **string**

Name of the userpool. ||
|| description | **string**

Description of the userpool. ||
|| labels | **object** (map<**string**, **string**>)

Resource labels as key:value pairs. ||
|| created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**

Timestamp when the userpool was created. ||
|| updated_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**

Timestamp when the userpool was last updated. ||
|| domains[] | **string**

List of domains associated with this userpool. ||
|| status | enum **Status**

Current status of the userpool.

- `CREATING`: The userpool is in the process of being created.
- `ACTIVE`: The userpool is active and operational.
- `DELETING`: The userpool is in the process of being deleted. ||
|| user_settings | **[UserSettings](#yandex.cloud.organizationmanager.v1.idp.UserSettings)**

User settings for this userpool. ||
|| password_quality_policy | **[PasswordQualityPolicy](#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy)**

Password quality policy for this userpool. ||
|| password_lifetime_policy | **[PasswordLifetimePolicy](#yandex.cloud.organizationmanager.v1.idp.PasswordLifetimePolicy)**

Password lifetime policy for this userpool. ||
|| bruteforce_protection_policy | **[BruteforceProtectionPolicy](#yandex.cloud.organizationmanager.v1.idp.BruteforceProtectionPolicy)**

Bruteforce protection policy for this userpool. ||
|| password_blacklist_policy | **[PasswordBlacklistPolicy](#yandex.cloud.organizationmanager.v1.idp.PasswordBlacklistPolicy)**

Password blacklist policy for this userpool. ||
|#

## UserSettings {#yandex.cloud.organizationmanager.v1.idp.UserSettings}

Settings that control user capabilities within a userpool.

#|
||Field | Description ||
|| allow_edit_self_password | **bool**

Whether users can change their own passwords. ||
|| allow_edit_self_info | **bool**

Whether users can edit their own profile information. ||
|| allow_edit_self_contacts | **bool**

Whether users can edit their own contact information. ||
|| allow_edit_self_login | **bool**

Whether users can edit their own login information. ||
|#

## PasswordQualityPolicy {#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy}

Policy that defines password quality requirements.

#|
||Field | Description ||
|| allow_similar | **bool**

Whether passwords similar to previous ones are allowed. ||
|| max_length | **int64**

Maximum password length. Zero means no maximum length is enforced.

Acceptable values are 0 to 1000, inclusive. ||
|| min_length | **int64**

Deprecated. Use Fixed instead. ||
|| match_length | **int64**

Minimum length of substrings to check for similarity to vulnerable sequences.

Acceptable values are 0 to 1000, inclusive. ||
|| required_classes | **[RequiredClasses](#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy.RequiredClasses)**

Deprecated. Use Fixed instead. ||
|| min_length_by_class_settings | **[MinLengthByClassSettings](#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy.MinLengthByClassSettings)**

Deprecated. Use Smart instead. ||
|| fixed | **[Fixed](#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy.Fixed)**

Fixed complexity requirements. Exactly one of complexity requirements must be specified.

Includes only one of the fields `fixed`, `smart`.

Defines password complexity policy. ||
|| smart | **[Smart](#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy.Smart)**

Smart complexity requirements. Exactly one of complexity requirements must be specified.

Includes only one of the fields `fixed`, `smart`.

Defines password complexity policy. ||
|#

## RequiredClasses {#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy.RequiredClasses}

Deprecated. Use Fixed instead.

#|
||Field | Description ||
|| lowers | **bool**

Whether lowercase letters are required. ||
|| uppers | **bool**

Whether uppercase letters are required. ||
|| digits | **bool**

Whether digits are required. ||
|| specials | **bool**

Whether special characters are required. ||
|#

## MinLengthByClassSettings {#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy.MinLengthByClassSettings}

Deprecated. Use Smart instead.

#|
||Field | Description ||
|| one | **int64**

Minimum length for passwords with one character class. ||
|| two | **int64**

Minimum length for passwords with two character classes. ||
|| three | **int64**

Minimum length for passwords with three character classes. ||
|#

## Fixed {#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy.Fixed}

Fixed complexity policy enforces uniform password rules with required character classes and minimum length.

#|
||Field | Description ||
|| lowers_required | **bool**

Whether lowercase letters are required in the password. ||
|| uppers_required | **bool**

Whether uppercase letters are required in the password. ||
|| digits_required | **bool**

Whether digits are required in the password. ||
|| specials_required | **bool**

Whether special characters are required in the password. ||
|| min_length | **int64**

Minimum length required for all passwords.

Acceptable values are 0 to 1000, inclusive. ||
|#

## Smart {#yandex.cloud.organizationmanager.v1.idp.PasswordQualityPolicy.Smart}

Smart complexity policy applies adaptive requirements based on character class diversity.
Zero value means passwords with this number of classes are forbidden.

#|
||Field | Description ||
|| one_class | **int64**

For passwords with one class of characters

Acceptable values are 0 to 1000, inclusive. ||
|| two_classes | **int64**

For passwords with two classes of characters

Acceptable values are 0 to 1000, inclusive. ||
|| three_classes | **int64**

For passwords with three classes of characters

Acceptable values are 0 to 1000, inclusive. ||
|| four_classes | **int64**

For passwords with all four classes of characters

Acceptable values are 0 to 1000, inclusive. ||
|#

## PasswordLifetimePolicy {#yandex.cloud.organizationmanager.v1.idp.PasswordLifetimePolicy}

Policy that defines password lifetime requirements.

#|
||Field | Description ||
|| min_days_count | **int64**

Minimum number of days before a password can be changed.

Acceptable values are 0 to 730, inclusive. ||
|| max_days_count | **int64**

Maximum number of days a password remains valid.
Zero means passwords never expire.

Acceptable values are 0 to 730, inclusive. ||
|#

## BruteforceProtectionPolicy {#yandex.cloud.organizationmanager.v1.idp.BruteforceProtectionPolicy}

Policy that defines protection against brute force attacks.
Zero or empty values disable bruteforce protection.

#|
||Field | Description ||
|| window | **[google.protobuf.Duration](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/duration)**

Time window for counting failed authentication attempts. ||
|| block | **[google.protobuf.Duration](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/duration)**

Duration of the block after too many failed attempts. ||
|| attempts | **int64**

Number of failed attempts allowed within the window before blocking.

Acceptable values are 1 to 100, inclusive. ||
|#

## PasswordBlacklistPolicy {#yandex.cloud.organizationmanager.v1.idp.PasswordBlacklistPolicy}

Policy that defines password blacklist requirements.

#|
||Field | Description ||
|| check_common | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)**

Whether check in common password database is enabled. Default value is true. ||
|#