# Протокол

## Оглавление

- [keyapis/user/v1/keyapis_user_user_v1.proto](#keyapis_user_v1_keyapis_user_user_v1-proto)
    - [UserService](#keyapis-user-v1-UserService)
  
    - [DeleteUserRequest](#keyapis-user-v1-DeleteUserRequest)
    - [DeleteUserResponse](#keyapis-user-v1-DeleteUserResponse)
    - [DeleteUserResponse.Error](#keyapis-user-v1-DeleteUserResponse-Error)
    - [DeleteUserSessionsRequest](#keyapis-user-v1-DeleteUserSessionsRequest)
    - [DeleteUserSessionsResponse](#keyapis-user-v1-DeleteUserSessionsResponse)
    - [DeleteUserSessionsResponse.Error](#keyapis-user-v1-DeleteUserSessionsResponse-Error)
    - [GetUserCodeRequest](#keyapis-user-v1-GetUserCodeRequest)
    - [GetUserCodeResponse](#keyapis-user-v1-GetUserCodeResponse)
    - [GetUserCodeResponse.Error](#keyapis-user-v1-GetUserCodeResponse-Error)
    - [GetUserCodeResponse.Error.UserCodeNotFound](#keyapis-user-v1-GetUserCodeResponse-Error-UserCodeNotFound)
    - [GetUserCountRequest](#keyapis-user-v1-GetUserCountRequest)
    - [GetUserCountResponse](#keyapis-user-v1-GetUserCountResponse)
    - [GetUserCountResponse.Error](#keyapis-user-v1-GetUserCountResponse-Error)
    - [GetUserListRequest](#keyapis-user-v1-GetUserListRequest)
    - [GetUserListResponse](#keyapis-user-v1-GetUserListResponse)
    - [GetUserListResponse.Error](#keyapis-user-v1-GetUserListResponse-Error)
    - [GetUserRequest](#keyapis-user-v1-GetUserRequest)
    - [GetUserResponse](#keyapis-user-v1-GetUserResponse)
    - [GetUserResponse.Error](#keyapis-user-v1-GetUserResponse-Error)
    - [PostUserCodeCreateRequest](#keyapis-user-v1-PostUserCodeCreateRequest)
    - [PostUserCodeCreateResponse](#keyapis-user-v1-PostUserCodeCreateResponse)
    - [PostUserCodeCreateResponse.Error](#keyapis-user-v1-PostUserCodeCreateResponse-Error)
    - [PostUserRequest](#keyapis-user-v1-PostUserRequest)
    - [PostUserResponse](#keyapis-user-v1-PostUserResponse)
    - [PostUserResponse.Error](#keyapis-user-v1-PostUserResponse-Error)
    - [User](#keyapis-user-v1-User)
    - [User.SavingError](#keyapis-user-v1-User-SavingError)
    - [User.SavingError.Conflict](#keyapis-user-v1-User-SavingError-Conflict)
    - [User.SavingError.CreatorMustBeAdmin](#keyapis-user-v1-User-SavingError-CreatorMustBeAdmin)
    - [User.SavingError.EmailIsAlreadyTaken](#keyapis-user-v1-User-SavingError-EmailIsAlreadyTaken)
    - [User.SavingError.EntityNotFound](#keyapis-user-v1-User-SavingError-EntityNotFound)
    - [User.SavingError.MrfIdRequiredForUserType](#keyapis-user-v1-User-SavingError-MrfIdRequiredForUserType)
    - [User.SavingError.RfIdDoesNotMatchMrfId](#keyapis-user-v1-User-SavingError-RfIdDoesNotMatchMrfId)
    - [User.SavingError.UserStatusForbidden](#keyapis-user-v1-User-SavingError-UserStatusForbidden)
    - [User.SavingError.UserTypeForbidden](#keyapis-user-v1-User-SavingError-UserTypeForbidden)
    - [UserCode](#keyapis-user-v1-UserCode)
    - [UserFilter](#keyapis-user-v1-UserFilter)
    - [UserPaging](#keyapis-user-v1-UserPaging)
    - [ValidationError](#keyapis-user-v1-ValidationError)
  
    - [User.StatusType](#keyapis-user-v1-User-StatusType)
    - [User.Type](#keyapis-user-v1-User-Type)
    - [UserPaging.DirectionType](#keyapis-user-v1-UserPaging-DirectionType)
    - [UserPaging.OrderByType](#keyapis-user-v1-UserPaging-OrderByType)
  


## [Схема классов](/svg/protos/key/keyapis/user/v1/keyapis_user_user_v1.proto.svg)
<a href="/svg/protos/key/keyapis/user/v1/keyapis_user_user_v1.proto.svg"><img src="/svg/protos/key/keyapis/user/v1/keyapis_user_user_v1.proto.svg" alt="/svg/protos/key/keyapis/user/v1/keyapis_user_user_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_user_v1_keyapis_user_user_v1-proto"></a>

## [keyapis/user/v1/keyapis_user_user_v1.proto](/protos/key/keyapis/user/v1/keyapis_user_user_v1.proto)
Сервис реализует функционал управления пользователями


<a name="keyapis-user-v1-UserService"></a>

### UserService
 Сервис пользователей

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-user-v1-GetUser"></a> [GetUser](#keyapis-user-v1-GetUser) | Метод получения пользователей. Метод доступен для: admin, service, manager, bti, ltp_first, owner, empolyee. Роли owner или employee могут запрашивать только пользователей, принадлежащих их компании | [keyapis.user.v1.GetUserRequest](#keyapis-user-v1-GetUserRequest) | [keyapis.user.v1.GetUserResponse](#keyapis-user-v1-GetUserResponse) |
| <a id="keyapis-user-v1-GetUserList"></a> [GetUserList](#keyapis-user-v1-GetUserList) | Метод получения списка пользователей. Метод доступен для: admin, service, manager, bti, ltp_first, owner, empolyee. Если метод вызван ролями owner или employee в фильтре поле company_ids принудительно замещается их company_id | [keyapis.user.v1.GetUserListRequest](#keyapis-user-v1-GetUserListRequest) | [keyapis.user.v1.GetUserListResponse](#keyapis-user-v1-GetUserListResponse) stream |
| <a id="keyapis-user-v1-GetUserCount"></a> [GetUserCount](#keyapis-user-v1-GetUserCount) | Метод получения количества пользователей. Метод доступен для: admin, service, manager, bti, ltp_first, owner, empolyee. Если метод вызван ролями owner или employee в фильтре поле company_ids принудительно замещается их company_id | [keyapis.user.v1.GetUserCountRequest](#keyapis-user-v1-GetUserCountRequest) | [keyapis.user.v1.GetUserCountResponse](#keyapis-user-v1-GetUserCountResponse) |
| <a id="keyapis-user-v1-DeleteUser"></a> [DeleteUser](#keyapis-user-v1-DeleteUser) | Метод удаления пользователей. Метод доступен для: admin, service | [keyapis.user.v1.DeleteUserRequest](#keyapis-user-v1-DeleteUserRequest) | [keyapis.user.v1.DeleteUserResponse](#keyapis-user-v1-DeleteUserResponse) |
| <a id="keyapis-user-v1-DeleteUserSessions"></a> [DeleteUserSessions](#keyapis-user-v1-DeleteUserSessions) | Метод удаления всех пользовательских сессий. Метод доступен для: admin, service | [keyapis.user.v1.DeleteUserSessionsRequest](#keyapis-user-v1-DeleteUserSessionsRequest) | [keyapis.user.v1.DeleteUserSessionsResponse](#keyapis-user-v1-DeleteUserSessionsResponse) |
| <a id="keyapis-user-v1-GetUserCode"></a> [GetUserCode](#keyapis-user-v1-GetUserCode) | Метод получения идентификационного кода пользователя. Метод доступен для: admin, service, ltp_first | [keyapis.user.v1.GetUserCodeRequest](#keyapis-user-v1-GetUserCodeRequest) | [keyapis.user.v1.GetUserCodeResponse](#keyapis-user-v1-GetUserCodeResponse) |
| <a id="keyapis-user-v1-PostUserCodeCreate"></a> [PostUserCodeCreate](#keyapis-user-v1-PostUserCodeCreate) | Метод создания идентификационного кода пользователя. После создания кода отправляется событие SendingSmsTask. Метод доступен для: admin, service, ltp_first | [keyapis.user.v1.PostUserCodeCreateRequest](#keyapis-user-v1-PostUserCodeCreateRequest) | [keyapis.user.v1.PostUserCodeCreateResponse](#keyapis-user-v1-PostUserCodeCreateResponse) |
| <a id="keyapis-user-v1-PostUser"></a> [PostUser](#keyapis-user-v1-PostUser) | Метод создания пользователя. Метод доступен для: admin, service. Доступно создание пользователей с типом: ADMIN, MRF, BTI, LTP_FIRST, SERVICE, DEVICE_ADMIN, MANAGER | [keyapis.user.v1.PostUserRequest](#keyapis-user-v1-PostUserRequest) | [keyapis.user.v1.PostUserResponse](#keyapis-user-v1-PostUserResponse) |

 <!-- end services -->


<a name="keyapis-user-v1-DeleteUserRequest"></a>


### [DeleteUserRequest](#keyapis-user-v1-DeleteUserRequest)
 Запрос удаления пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-DeleteUserRequest-id"></a> [id](#keyapis-user-v1-DeleteUserRequest-id) | Идентификатор |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-user-v1-DeleteUserResponse"></a>


### [DeleteUserResponse](#keyapis-user-v1-DeleteUserResponse)
 Ответ на запрос удаления пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-DeleteUserResponse-error"></a> [error](#keyapis-user-v1-DeleteUserResponse-error) | Ошибка |  optional  [keyapis.user.v1.DeleteUserResponse.Error](#keyapis-user-v1-DeleteUserResponse-Error) | <nil>|






<a name="keyapis-user-v1-DeleteUserResponse-Error"></a>


### [DeleteUserResponse.Error](#keyapis-user-v1-DeleteUserResponse-Error)
 Ошибка запроса удаления пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-DeleteUserResponse-Error-validation"></a> [validation](#keyapis-user-v1-DeleteUserResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.user.v1.ValidationError](#keyapis-user-v1-ValidationError) | <nil>|
| <a id="keyapis-user-v1-DeleteUserResponse-Error-saving"></a> [saving](#keyapis-user-v1-DeleteUserResponse-Error-saving) | Ошибка сохранения |  optional  [keyapis.user.v1.User.SavingError](#keyapis-user-v1-User-SavingError) | <nil>|






<a name="keyapis-user-v1-DeleteUserSessionsRequest"></a>


### [DeleteUserSessionsRequest](#keyapis-user-v1-DeleteUserSessionsRequest)
 Запрос удаления всех пользовательских сессий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-DeleteUserSessionsRequest-id"></a> [id](#keyapis-user-v1-DeleteUserSessionsRequest-id) | Идентификатор пользователя. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-user-v1-DeleteUserSessionsResponse"></a>


### [DeleteUserSessionsResponse](#keyapis-user-v1-DeleteUserSessionsResponse)
 Ответ на запрос удаления всех пользовательских сессий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-DeleteUserSessionsResponse-error"></a> [error](#keyapis-user-v1-DeleteUserSessionsResponse-error) | Ошибка |  optional  [keyapis.user.v1.DeleteUserSessionsResponse.Error](#keyapis-user-v1-DeleteUserSessionsResponse-Error) | <nil>|






<a name="keyapis-user-v1-DeleteUserSessionsResponse-Error"></a>


### [DeleteUserSessionsResponse.Error](#keyapis-user-v1-DeleteUserSessionsResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-DeleteUserSessionsResponse-Error-validation"></a> [validation](#keyapis-user-v1-DeleteUserSessionsResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.user.v1.ValidationError](#keyapis-user-v1-ValidationError) | <nil>|






<a name="keyapis-user-v1-GetUserCodeRequest"></a>


### [GetUserCodeRequest](#keyapis-user-v1-GetUserCodeRequest)
 Запрос получения идентификационного кода пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserCodeRequest-id"></a> [id](#keyapis-user-v1-GetUserCodeRequest-id) | Идентификатор. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-user-v1-GetUserCodeResponse"></a>


### [GetUserCodeResponse](#keyapis-user-v1-GetUserCodeResponse)
 Ответ на запрос получения идентификационного кода пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserCodeResponse-data"></a> [data](#keyapis-user-v1-GetUserCodeResponse-data) | Идентификационный код |  optional  [keyapis.user.v1.UserCode](#keyapis-user-v1-UserCode) | <nil>|
| <a id="keyapis-user-v1-GetUserCodeResponse-error"></a> [error](#keyapis-user-v1-GetUserCodeResponse-error) | Ошибка |  optional  [keyapis.user.v1.GetUserCodeResponse.Error](#keyapis-user-v1-GetUserCodeResponse-Error) | <nil>|






<a name="keyapis-user-v1-GetUserCodeResponse-Error"></a>


### [GetUserCodeResponse.Error](#keyapis-user-v1-GetUserCodeResponse-Error)
 Ошибка запроса получения идентификационного кода пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserCodeResponse-Error-validation"></a> [validation](#keyapis-user-v1-GetUserCodeResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.user.v1.ValidationError](#keyapis-user-v1-ValidationError) | <nil>|
| <a id="keyapis-user-v1-GetUserCodeResponse-Error-user_code_not_found"></a> [user_code_not_found](#keyapis-user-v1-GetUserCodeResponse-Error-user_code_not_found) | У пользователя отсутствует идентификационный код |  optional  [keyapis.user.v1.GetUserCodeResponse.Error.UserCodeNotFound](#keyapis-user-v1-GetUserCodeResponse-Error-UserCodeNotFound) | <nil>|






<a name="keyapis-user-v1-GetUserCodeResponse-Error-UserCodeNotFound"></a>


### [GetUserCodeResponse.Error.UserCodeNotFound](#keyapis-user-v1-GetUserCodeResponse-Error-UserCodeNotFound)
 У пользователя отсутствует идентификационный код






<a name="keyapis-user-v1-GetUserCountRequest"></a>


### [GetUserCountRequest](#keyapis-user-v1-GetUserCountRequest)
 Запрос получения количества пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserCountRequest-filter"></a> [filter](#keyapis-user-v1-GetUserCountRequest-filter) | Фильтр |    [keyapis.user.v1.UserFilter](#keyapis-user-v1-UserFilter) | <nil>|






<a name="keyapis-user-v1-GetUserCountResponse"></a>


### [GetUserCountResponse](#keyapis-user-v1-GetUserCountResponse)
 Ответ на запрос получения количества пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserCountResponse-data"></a> [data](#keyapis-user-v1-GetUserCountResponse-data) | Всего пользователей |  optional  [int32](#scalar-types) | <nil>|
| <a id="keyapis-user-v1-GetUserCountResponse-error"></a> [error](#keyapis-user-v1-GetUserCountResponse-error) | Ошибка |  optional  [keyapis.user.v1.GetUserCountResponse.Error](#keyapis-user-v1-GetUserCountResponse-Error) | <nil>|






<a name="keyapis-user-v1-GetUserCountResponse-Error"></a>


### [GetUserCountResponse.Error](#keyapis-user-v1-GetUserCountResponse-Error)
 Ошибка запроса получения количества пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserCountResponse-Error-validation"></a> [validation](#keyapis-user-v1-GetUserCountResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.user.v1.ValidationError](#keyapis-user-v1-ValidationError) | <nil>|






<a name="keyapis-user-v1-GetUserListRequest"></a>


### [GetUserListRequest](#keyapis-user-v1-GetUserListRequest)
 Запрос на получение списка пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserListRequest-filter"></a> [filter](#keyapis-user-v1-GetUserListRequest-filter) | Фильтр |    [keyapis.user.v1.UserFilter](#keyapis-user-v1-UserFilter) | <nil>|
| <a id="keyapis-user-v1-GetUserListRequest-paging"></a> [paging](#keyapis-user-v1-GetUserListRequest-paging) | Стандартный постраничный вывод |  optional  [keyapis.user.v1.UserPaging](#keyapis-user-v1-UserPaging) | <nil>|






<a name="keyapis-user-v1-GetUserListResponse"></a>


### [GetUserListResponse](#keyapis-user-v1-GetUserListResponse)
 Ответ на получение списка пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserListResponse-data"></a> [data](#keyapis-user-v1-GetUserListResponse-data) | Пользователь |  optional  [keyapis.user.v1.User](#keyapis-user-v1-User) | <nil>|
| <a id="keyapis-user-v1-GetUserListResponse-error"></a> [error](#keyapis-user-v1-GetUserListResponse-error) | Ошибка |  optional  [keyapis.user.v1.GetUserListResponse.Error](#keyapis-user-v1-GetUserListResponse-Error) | <nil>|






<a name="keyapis-user-v1-GetUserListResponse-Error"></a>


### [GetUserListResponse.Error](#keyapis-user-v1-GetUserListResponse-Error)
 Ошибка запроса получения списка пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserListResponse-Error-validation"></a> [validation](#keyapis-user-v1-GetUserListResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.user.v1.ValidationError](#keyapis-user-v1-ValidationError) | <nil>|






<a name="keyapis-user-v1-GetUserRequest"></a>


### [GetUserRequest](#keyapis-user-v1-GetUserRequest)
 Запрос получения пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserRequest-id"></a> [id](#keyapis-user-v1-GetUserRequest-id) | Идентификатор |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-user-v1-GetUserResponse"></a>


### [GetUserResponse](#keyapis-user-v1-GetUserResponse)
 Ответ на запрос получения пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserResponse-data"></a> [data](#keyapis-user-v1-GetUserResponse-data) | Пользователь |  optional  [keyapis.user.v1.User](#keyapis-user-v1-User) | <nil>|
| <a id="keyapis-user-v1-GetUserResponse-error"></a> [error](#keyapis-user-v1-GetUserResponse-error) | Ошибка |  optional  [keyapis.user.v1.GetUserResponse.Error](#keyapis-user-v1-GetUserResponse-Error) | <nil>|






<a name="keyapis-user-v1-GetUserResponse-Error"></a>


### [GetUserResponse.Error](#keyapis-user-v1-GetUserResponse-Error)
 Ошибка запроса получения пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-GetUserResponse-Error-validation"></a> [validation](#keyapis-user-v1-GetUserResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.user.v1.ValidationError](#keyapis-user-v1-ValidationError) | <nil>|






<a name="keyapis-user-v1-PostUserCodeCreateRequest"></a>


### [PostUserCodeCreateRequest](#keyapis-user-v1-PostUserCodeCreateRequest)
 Запрос создания идентификационного кода пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-PostUserCodeCreateRequest-user_code"></a> [user_code](#keyapis-user-v1-PostUserCodeCreateRequest-user_code) | Идентификационный код пользователя |    [keyapis.user.v1.UserCode](#keyapis-user-v1-UserCode) | REQUIRED|






<a name="keyapis-user-v1-PostUserCodeCreateResponse"></a>


### [PostUserCodeCreateResponse](#keyapis-user-v1-PostUserCodeCreateResponse)
 Ответ на запрос создания идентификационного кода пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-PostUserCodeCreateResponse-data"></a> [data](#keyapis-user-v1-PostUserCodeCreateResponse-data) | Идентификационный код пользователя |  optional  [keyapis.user.v1.UserCode](#keyapis-user-v1-UserCode) | <nil>|
| <a id="keyapis-user-v1-PostUserCodeCreateResponse-error"></a> [error](#keyapis-user-v1-PostUserCodeCreateResponse-error) | Ошибка |  optional  [keyapis.user.v1.PostUserCodeCreateResponse.Error](#keyapis-user-v1-PostUserCodeCreateResponse-Error) | <nil>|






<a name="keyapis-user-v1-PostUserCodeCreateResponse-Error"></a>


### [PostUserCodeCreateResponse.Error](#keyapis-user-v1-PostUserCodeCreateResponse-Error)
 Ошибка запроса создания идентификационного кода пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-PostUserCodeCreateResponse-Error-validation"></a> [validation](#keyapis-user-v1-PostUserCodeCreateResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.user.v1.ValidationError](#keyapis-user-v1-ValidationError) | <nil>|






<a name="keyapis-user-v1-PostUserRequest"></a>


### [PostUserRequest](#keyapis-user-v1-PostUserRequest)
 Запрос на создание пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-PostUserRequest-data"></a> [data](#keyapis-user-v1-PostUserRequest-data) | Пользователь |    [keyapis.user.v1.User](#keyapis-user-v1-User) | REQUIRED|






<a name="keyapis-user-v1-PostUserResponse"></a>


### [PostUserResponse](#keyapis-user-v1-PostUserResponse)
 Ответ на запрос на создание пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-PostUserResponse-data"></a> [data](#keyapis-user-v1-PostUserResponse-data) | Пользователь |  optional  [keyapis.user.v1.User](#keyapis-user-v1-User) | <nil>|
| <a id="keyapis-user-v1-PostUserResponse-error"></a> [error](#keyapis-user-v1-PostUserResponse-error) | Ошибка |  optional  [keyapis.user.v1.PostUserResponse.Error](#keyapis-user-v1-PostUserResponse-Error) | <nil>|






<a name="keyapis-user-v1-PostUserResponse-Error"></a>


### [PostUserResponse.Error](#keyapis-user-v1-PostUserResponse-Error)
 Ошибка запроса сохранения пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-PostUserResponse-Error-validation"></a> [validation](#keyapis-user-v1-PostUserResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.user.v1.ValidationError](#keyapis-user-v1-ValidationError) | <nil>|
| <a id="keyapis-user-v1-PostUserResponse-Error-saving"></a> [saving](#keyapis-user-v1-PostUserResponse-Error-saving) | Ошибка сохранения |  optional  [keyapis.user.v1.User.SavingError](#keyapis-user-v1-User-SavingError) | <nil>|






<a name="keyapis-user-v1-User"></a>


### [User](#keyapis-user-v1-User)
 Пользователь


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-User-id"></a> [id](#keyapis-user-v1-User-id) | Идентификатор. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-user-v1-User-type"></a> [type](#keyapis-user-v1-User-type) | Тип пользователя |    [keyapis.user.v1.User.Type](#keyapis-user-v1-User-Type) | REQUIRED|
| <a id="keyapis-user-v1-User-status_type"></a> [status_type](#keyapis-user-v1-User-status_type) | Статус пользователя |    [keyapis.user.v1.User.StatusType](#keyapis-user-v1-User-StatusType) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-User-login"></a> [login](#keyapis-user-v1-User-login) | Логин. # Диапазон: 3..64 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-email"></a> [email](#keyapis-user-v1-User-email) | Электронная почта. # Диапазон: 4..256 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-phone_number"></a> [phone_number](#keyapis-user-v1-User-phone_number) | Номер телефона. # Диапазон: 5..14 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-company_id"></a> [company_id](#keyapis-user-v1-User-company_id) | Идентификатор компании. # Диапазон: 1..2147483647 |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-mrf_id"></a> [mrf_id](#keyapis-user-v1-User-mrf_id) | Идентификатор МРФ |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-rf_id"></a> [rf_id](#keyapis-user-v1-User-rf_id) | Идентификатор РФ |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-created_at"></a> [created_at](#keyapis-user-v1-User-created_at) | Дата создания. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-User-changed_at"></a> [changed_at](#keyapis-user-v1-User-changed_at) | Дата изменения. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-activated_at"></a> [activated_at](#keyapis-user-v1-User-activated_at) | Дата активации. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-User-blocked_at"></a> [blocked_at](#keyapis-user-v1-User-blocked_at) | Дата активации. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-User-creator_user_id"></a> [creator_user_id](#keyapis-user-v1-User-creator_user_id) | Идентификатор создавшего пользователя. Берется из токена. # Диапазон: 1..2147483647 |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-User-owner_user_id"></a> [owner_user_id](#keyapis-user-v1-User-owner_user_id) | Идентификатор пользователя-владельца. # Диапазон: 1..2147483647 |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-invoice_email"></a> [invoice_email](#keyapis-user-v1-User-invoice_email) | Электронная почта для чеков. # Диапазон: 4..256 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-vc_user_id"></a> [vc_user_id](#keyapis-user-v1-User-vc_user_id) | Идентификатор пользователя в Видеонаблюдении. Вычисляется на стороне сервера при создании пользователя |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-User-description"></a> [description](#keyapis-user-v1-User-description) | Описание |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-User-ustore_user_id"></a> [ustore_user_id](#keyapis-user-v1-User-ustore_user_id) | Идентификатор пользователя в сервисе ustore. Вычисляется на стороне сервера при создании пользователя |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-User-env_url"></a> [env_url](#keyapis-user-v1-User-env_url) | Адрес окружения для внутренних пользователей |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="keyapis-user-v1-User-SavingError"></a>


### [User.SavingError](#keyapis-user-v1-User-SavingError)
 Ошибка сохранения.
Эти проверки выполняются при работе с базой данных и сторонними сервисами


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-User-SavingError-conflict"></a> [conflict](#keyapis-user-v1-User-SavingError-conflict) | Конфликт версий |  optional  [keyapis.user.v1.User.SavingError.Conflict](#keyapis-user-v1-User-SavingError-Conflict) | <nil>|
| <a id="keyapis-user-v1-User-SavingError-user_type_forbidden"></a> [user_type_forbidden](#keyapis-user-v1-User-SavingError-user_type_forbidden) | Нельзя удалять пользователя с данным типом |  optional  [keyapis.user.v1.User.SavingError.UserTypeForbidden](#keyapis-user-v1-User-SavingError-UserTypeForbidden) | <nil>|
| <a id="keyapis-user-v1-User-SavingError-user_status_forbidden"></a> [user_status_forbidden](#keyapis-user-v1-User-SavingError-user_status_forbidden) | Нельзя удалять пользователя в текущем статусе |  optional  [keyapis.user.v1.User.SavingError.UserStatusForbidden](#keyapis-user-v1-User-SavingError-UserStatusForbidden) | <nil>|
| <a id="keyapis-user-v1-User-SavingError-mrf_id_is_required_for_user_type"></a> [mrf_id_is_required_for_user_type](#keyapis-user-v1-User-SavingError-mrf_id_is_required_for_user_type) | Идентификатор МРФ обязателен |  optional  [keyapis.user.v1.User.SavingError.MrfIdRequiredForUserType](#keyapis-user-v1-User-SavingError-MrfIdRequiredForUserType) | <nil>|
| <a id="keyapis-user-v1-User-SavingError-creator_must_be_admin"></a> [creator_must_be_admin](#keyapis-user-v1-User-SavingError-creator_must_be_admin) | Создатель пользователя должен иметь роль Admin |  optional  [keyapis.user.v1.User.SavingError.CreatorMustBeAdmin](#keyapis-user-v1-User-SavingError-CreatorMustBeAdmin) | <nil>|
| <a id="keyapis-user-v1-User-SavingError-rf_id_does_not_match_mrf_id"></a> [rf_id_does_not_match_mrf_id](#keyapis-user-v1-User-SavingError-rf_id_does_not_match_mrf_id) | Идентификатор РФ не соответствует идентификатору МРФ |  optional  [keyapis.user.v1.User.SavingError.RfIdDoesNotMatchMrfId](#keyapis-user-v1-User-SavingError-RfIdDoesNotMatchMrfId) | <nil>|
| <a id="keyapis-user-v1-User-SavingError-email_is_already_taken"></a> [email_is_already_taken](#keyapis-user-v1-User-SavingError-email_is_already_taken) | Email уже занят |  optional  [keyapis.user.v1.User.SavingError.EmailIsAlreadyTaken](#keyapis-user-v1-User-SavingError-EmailIsAlreadyTaken) | <nil>|
| <a id="keyapis-user-v1-User-SavingError-entity_not_found"></a> [entity_not_found](#keyapis-user-v1-User-SavingError-entity_not_found) | Связанная с пользователем сущность не найдена |  optional  [keyapis.user.v1.User.SavingError.EntityNotFound](#keyapis-user-v1-User-SavingError-EntityNotFound) | <nil>|






<a name="keyapis-user-v1-User-SavingError-Conflict"></a>


### [User.SavingError.Conflict](#keyapis-user-v1-User-SavingError-Conflict)
 Конфликт версий.
Причины:
- В базе хранится другая версия строки, значения changed_at отличаются






<a name="keyapis-user-v1-User-SavingError-CreatorMustBeAdmin"></a>


### [User.SavingError.CreatorMustBeAdmin](#keyapis-user-v1-User-SavingError-CreatorMustBeAdmin)
 Создатель пользователя должен иметь роль Admin






<a name="keyapis-user-v1-User-SavingError-EmailIsAlreadyTaken"></a>


### [User.SavingError.EmailIsAlreadyTaken](#keyapis-user-v1-User-SavingError-EmailIsAlreadyTaken)
 Email уже занят






<a name="keyapis-user-v1-User-SavingError-EntityNotFound"></a>


### [User.SavingError.EntityNotFound](#keyapis-user-v1-User-SavingError-EntityNotFound)
 Связанная с пользователем сущность не найдена.
Например: компания по company_id, пользователь по owner_user_id


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-User-SavingError-EntityNotFound-field"></a> [field](#keyapis-user-v1-User-SavingError-EntityNotFound-field) | Поле |    [string](#scalar-types) | <nil>|






<a name="keyapis-user-v1-User-SavingError-MrfIdRequiredForUserType"></a>


### [User.SavingError.MrfIdRequiredForUserType](#keyapis-user-v1-User-SavingError-MrfIdRequiredForUserType)
 Для данного типа пользователя идентификатор МРФ обязателен






<a name="keyapis-user-v1-User-SavingError-RfIdDoesNotMatchMrfId"></a>


### [User.SavingError.RfIdDoesNotMatchMrfId](#keyapis-user-v1-User-SavingError-RfIdDoesNotMatchMrfId)
 Идентификатор РФ не соответствует идентификатору МРФ






<a name="keyapis-user-v1-User-SavingError-UserStatusForbidden"></a>


### [User.SavingError.UserStatusForbidden](#keyapis-user-v1-User-SavingError-UserStatusForbidden)
 Нельзя удалять пользователя в текущем статусе.
В каких статусах можно удалить пользователя:
- demo






<a name="keyapis-user-v1-User-SavingError-UserTypeForbidden"></a>


### [User.SavingError.UserTypeForbidden](#keyapis-user-v1-User-SavingError-UserTypeForbidden)
 Нельзя удалять пользователя с данным типом.
Доступные типы:
- Жилец (мастер)






<a name="keyapis-user-v1-UserCode"></a>


### [UserCode](#keyapis-user-v1-UserCode)
 Идентификационный код пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-UserCode-code"></a> [code](#keyapis-user-v1-UserCode-code) | Идентификационный код. Если поле не заполнено, генерируется автоматически. # Диапазон: 10000..99999 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-user-v1-UserCode-user_id"></a> [user_id](#keyapis-user-v1-UserCode-user_id) | Идентификатор пользователя. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-user-v1-UserCode-created_at"></a> [created_at](#keyapis-user-v1-UserCode-created_at) | Дата создания. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-UserCode-creator_user_id"></a> [creator_user_id](#keyapis-user-v1-UserCode-creator_user_id) | Идентификатор создателя кода |    [int32](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-user-v1-UserCode-creator_user_type"></a> [creator_user_type](#keyapis-user-v1-UserCode-creator_user_type) | Тип создателя кода |    [keyapis.user.v1.User.Type](#keyapis-user-v1-User-Type) | OUTPUT_ONLY|






<a name="keyapis-user-v1-UserFilter"></a>


### [UserFilter](#keyapis-user-v1-UserFilter)
 Фильтр по пользователям


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-UserFilter-company_ids"></a> [company_ids](#keyapis-user-v1-UserFilter-company_ids) | По идентификаторам компаний |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-user-v1-UserFilter-user_types"></a> [user_types](#keyapis-user-v1-UserFilter-user_types) | По типам |  repeated  [keyapis.user.v1.User.Type](#keyapis-user-v1-User-Type) | <nil>|
| <a id="keyapis-user-v1-UserFilter-user_status_types"></a> [user_status_types](#keyapis-user-v1-UserFilter-user_status_types) | По статусам |  repeated  [keyapis.user.v1.User.StatusType](#keyapis-user-v1-User-StatusType) | <nil>|
| <a id="keyapis-user-v1-UserFilter-emails"></a> [emails](#keyapis-user-v1-UserFilter-emails) | По электронной почте |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-user-v1-UserFilter-phone_numbers"></a> [phone_numbers](#keyapis-user-v1-UserFilter-phone_numbers) | По номеру телефона |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-user-v1-UserFilter-logins"></a> [logins](#keyapis-user-v1-UserFilter-logins) | По логину |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-user-v1-UserFilter-text"></a> [text](#keyapis-user-v1-UserFilter-text) | Поиск по тексту. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Описание |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-user-v1-UserFilter-contacts"></a> [contacts](#keyapis-user-v1-UserFilter-contacts) | Поиск по контактным данным пользователя (электронная почта или номер телефона). Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Электронная почта; # - Номер телефона |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="keyapis-user-v1-UserPaging"></a>


### [UserPaging](#keyapis-user-v1-UserPaging)
 Постраничный вывод


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-UserPaging-order_by_type"></a> [order_by_type](#keyapis-user-v1-UserPaging-order_by_type) | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: CHANGED_AT |    [keyapis.user.v1.UserPaging.OrderByType](#keyapis-user-v1-UserPaging-OrderByType) | <nil>|
| <a id="keyapis-user-v1-UserPaging-direction_type"></a> [direction_type](#keyapis-user-v1-UserPaging-direction_type) | Тип направления сортировки. # По умолчанию: DESC |    [keyapis.user.v1.UserPaging.DirectionType](#keyapis-user-v1-UserPaging-DirectionType) | <nil>|
| <a id="keyapis-user-v1-UserPaging-limit"></a> [limit](#keyapis-user-v1-UserPaging-limit) | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-user-v1-UserPaging-offset"></a> [offset](#keyapis-user-v1-UserPaging-offset) | Сдвиг. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | <nil>|






<a name="keyapis-user-v1-ValidationError"></a>


### [ValidationError](#keyapis-user-v1-ValidationError)
 Ошибки валидации.
Эти проверки выполняются до обращения в базу данных


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-user-v1-ValidationError-path"></a> [path](#keyapis-user-v1-ValidationError-path) | Путь к полю в формате наименования прото |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-user-v1-ValidationError-message"></a> [message](#keyapis-user-v1-ValidationError-message) | Валидационное сообщение |    [string](#scalar-types) | REQUIRED|





 <!-- end messages -->



<a name="keyapis-user-v1-User-StatusType"></a>

### [User.StatusType](#keyapis-user-v1-User-StatusType)
 Справочник типов статусов пользователей.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-user-v1-User-StatusType-STATUS_TYPE_UNKNOWN"></a> [STATUS_TYPE_UNKNOWN](#keyapis-user-v1-User-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-user-v1-User-StatusType-NEW"></a> [NEW](#keyapis-user-v1-User-StatusType-NEW) | Не активный пользователь |
| 2 | <a id="keyapis-user-v1-User-StatusType-DEMO"></a> [DEMO](#keyapis-user-v1-User-StatusType-DEMO) | Демо пользователь |
| 3 | <a id="keyapis-user-v1-User-StatusType-ACTIVE"></a> [ACTIVE](#keyapis-user-v1-User-StatusType-ACTIVE) | Активный пользователь |
| 4 | <a id="keyapis-user-v1-User-StatusType-BLOCKED"></a> [BLOCKED](#keyapis-user-v1-User-StatusType-BLOCKED) | Архивный пользователь |




<a name="keyapis-user-v1-User-Type"></a>

### [User.Type](#keyapis-user-v1-User-Type)
 Справочник типов пользователей.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-user-v1-User-Type-TYPE_UNKNOWN"></a> [TYPE_UNKNOWN](#keyapis-user-v1-User-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-user-v1-User-Type-OWNER"></a> [OWNER](#keyapis-user-v1-User-Type-OWNER) | Владелец УК |
| 2 | <a id="keyapis-user-v1-User-Type-EMPLOYEE"></a> [EMPLOYEE](#keyapis-user-v1-User-Type-EMPLOYEE) | Сотрудник УК |
| 3 | <a id="keyapis-user-v1-User-Type-MASTER"></a> [MASTER](#keyapis-user-v1-User-Type-MASTER) | Мастер житель |
| 4 | <a id="keyapis-user-v1-User-Type-SLAVE"></a> [SLAVE](#keyapis-user-v1-User-Type-SLAVE) | Подчиненный житель |
| 5 | <a id="keyapis-user-v1-User-Type-ADMIN"></a> [ADMIN](#keyapis-user-v1-User-Type-ADMIN) | Администратор |
| 6 | <a id="keyapis-user-v1-User-Type-SELLER"></a> [SELLER](#keyapis-user-v1-User-Type-SELLER) | Сотрудники ГАП |
| 7 | <a id="keyapis-user-v1-User-Type-MRF"></a> [MRF](#keyapis-user-v1-User-Type-MRF) | МРФ |
| 8 | <a id="keyapis-user-v1-User-Type-BACKOFFICE"></a> [BACKOFFICE](#keyapis-user-v1-User-Type-BACKOFFICE) | ГРЗУК |
| 9 | <a id="keyapis-user-v1-User-Type-SERVICE"></a> [SERVICE](#keyapis-user-v1-User-Type-SERVICE) | Сервис |
| 10 | <a id="keyapis-user-v1-User-Type-ROOT"></a> [ROOT](#keyapis-user-v1-User-Type-ROOT) | Супер админ |
| 11 | <a id="keyapis-user-v1-User-Type-BTI"></a> [BTI](#keyapis-user-v1-User-Type-BTI) | Сотрудник БТИ |
| 12 | <a id="keyapis-user-v1-User-Type-LTP_FIRST"></a> [LTP_FIRST](#keyapis-user-v1-User-Type-LTP_FIRST) | Сотрудник 1 ЛТП |
| 13 | <a id="keyapis-user-v1-User-Type-EXTERNAL_SELLER"></a> [EXTERNAL_SELLER](#keyapis-user-v1-User-Type-EXTERNAL_SELLER) | Сотрудник ГАП |
| 14 | <a id="keyapis-user-v1-User-Type-APPLICATION"></a> [APPLICATION](#keyapis-user-v1-User-Type-APPLICATION) | Приложение |
| 15 | <a id="keyapis-user-v1-User-Type-MANAGER"></a> [MANAGER](#keyapis-user-v1-User-Type-MANAGER) | Администратор точек продаж |
| 16 | <a id="keyapis-user-v1-User-Type-DEVICE_ADMIN"></a> [DEVICE_ADMIN](#keyapis-user-v1-User-Type-DEVICE_ADMIN) | Администратор устройств |




<a name="keyapis-user-v1-UserPaging-DirectionType"></a>

### [UserPaging.DirectionType](#keyapis-user-v1-UserPaging-DirectionType)
 Справочник типов направлений сортировки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-user-v1-UserPaging-DirectionType-DIRECTION_TYPE_UNKNOWN"></a> [DIRECTION_TYPE_UNKNOWN](#keyapis-user-v1-UserPaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-user-v1-UserPaging-DirectionType-DESC"></a> [DESC](#keyapis-user-v1-UserPaging-DirectionType-DESC) | От большего к меньшему |
| 2 | <a id="keyapis-user-v1-UserPaging-DirectionType-ASC"></a> [ASC](#keyapis-user-v1-UserPaging-DirectionType-ASC) | От меньшего к большему |




<a name="keyapis-user-v1-UserPaging-OrderByType"></a>

### [UserPaging.OrderByType](#keyapis-user-v1-UserPaging-OrderByType)
 Справочник типов значений сортировки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-user-v1-UserPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-user-v1-UserPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-user-v1-UserPaging-OrderByType-ID"></a> [ID](#keyapis-user-v1-UserPaging-OrderByType-ID) | По идентификатору |
| 2 | <a id="keyapis-user-v1-UserPaging-OrderByType-CREATED_AT"></a> [CREATED_AT](#keyapis-user-v1-UserPaging-OrderByType-CREATED_AT) | По времени создания |
| 3 | <a id="keyapis-user-v1-UserPaging-OrderByType-CHANGED_AT"></a> [CHANGED_AT](#keyapis-user-v1-UserPaging-OrderByType-CHANGED_AT) | По времени изменения |
| 4 | <a id="keyapis-user-v1-UserPaging-OrderByType-EMAIL"></a> [EMAIL](#keyapis-user-v1-UserPaging-OrderByType-EMAIL) | По электронной почте |
| 5 | <a id="keyapis-user-v1-UserPaging-OrderByType-RANK"></a> [RANK](#keyapis-user-v1-UserPaging-OrderByType-RANK) | По рангу для поиска по тексту. Применяется когда передано поле для поиска по тексту. В случае если текстовое поле не передано, применяется значение по умолчанию |
| 6 | <a id="keyapis-user-v1-UserPaging-OrderByType-DESCRIPTION"></a> [DESCRIPTION](#keyapis-user-v1-UserPaging-OrderByType-DESCRIPTION) | По описанию (collate-agnostic ordering) |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |