# Протокол

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

- [keyapis/access_management/v1/keyapis_access_management_group_v1.proto](#keyapis_access_management_v1_keyapis_access_management_group_v1-proto)
    - [GroupService](#keyapis-access_management-v1-GroupService)
  
    - [Claim](#keyapis-access_management-v1-Claim)
    - [DeleteGroupRequest](#keyapis-access_management-v1-DeleteGroupRequest)
    - [DeleteGroupResponse](#keyapis-access_management-v1-DeleteGroupResponse)
    - [GetGroupClaimCountRequest](#keyapis-access_management-v1-GetGroupClaimCountRequest)
    - [GetGroupClaimCountResponse](#keyapis-access_management-v1-GetGroupClaimCountResponse)
    - [GetGroupClaimExistRequest](#keyapis-access_management-v1-GetGroupClaimExistRequest)
    - [GetGroupClaimExistResponse](#keyapis-access_management-v1-GetGroupClaimExistResponse)
    - [GetGroupClaimExistResponse.Error](#keyapis-access_management-v1-GetGroupClaimExistResponse-Error)
    - [GetGroupClaimExistResponse.Error.ClaimFilterEmptyError](#keyapis-access_management-v1-GetGroupClaimExistResponse-Error-ClaimFilterEmptyError)
    - [GetGroupClaimListRequest](#keyapis-access_management-v1-GetGroupClaimListRequest)
    - [GetGroupClaimListResponse](#keyapis-access_management-v1-GetGroupClaimListResponse)
    - [GetGroupCountRequest](#keyapis-access_management-v1-GetGroupCountRequest)
    - [GetGroupCountResponse](#keyapis-access_management-v1-GetGroupCountResponse)
    - [GetGroupCountResponse.Error](#keyapis-access_management-v1-GetGroupCountResponse-Error)
    - [GetGroupListRequest](#keyapis-access_management-v1-GetGroupListRequest)
    - [GetGroupListResponse](#keyapis-access_management-v1-GetGroupListResponse)
    - [GetGroupListResponse.Error](#keyapis-access_management-v1-GetGroupListResponse-Error)
    - [GetGroupRequest](#keyapis-access_management-v1-GetGroupRequest)
    - [GetGroupResponse](#keyapis-access_management-v1-GetGroupResponse)
    - [GetGroupResponse.Error](#keyapis-access_management-v1-GetGroupResponse-Error)
    - [GetGroupUserCountRequest](#keyapis-access_management-v1-GetGroupUserCountRequest)
    - [GetGroupUserCountResponse](#keyapis-access_management-v1-GetGroupUserCountResponse)
    - [GetGroupUserListRequest](#keyapis-access_management-v1-GetGroupUserListRequest)
    - [GetGroupUserListResponse](#keyapis-access_management-v1-GetGroupUserListResponse)
    - [Group](#keyapis-access_management-v1-Group)
    - [GroupClaimFilter](#keyapis-access_management-v1-GroupClaimFilter)
    - [GroupClaimFilter.ClaimsEntry](#keyapis-access_management-v1-GroupClaimFilter-ClaimsEntry)
    - [GroupClaimFilter.UserData](#keyapis-access_management-v1-GroupClaimFilter-UserData)
    - [GroupClaimFilter.UserData.ClaimsEntry](#keyapis-access_management-v1-GroupClaimFilter-UserData-ClaimsEntry)
    - [GroupClaimPaging](#keyapis-access_management-v1-GroupClaimPaging)
    - [GroupFilter](#keyapis-access_management-v1-GroupFilter)
    - [GroupFilter.ClaimsEntry](#keyapis-access_management-v1-GroupFilter-ClaimsEntry)
    - [GroupFilter.RequirementsEntry](#keyapis-access_management-v1-GroupFilter-RequirementsEntry)
    - [GroupPaging](#keyapis-access_management-v1-GroupPaging)
    - [GroupTemplateNotFoundError](#keyapis-access_management-v1-GroupTemplateNotFoundError)
    - [GroupUserFilter](#keyapis-access_management-v1-GroupUserFilter)
    - [GroupUserPaging](#keyapis-access_management-v1-GroupUserPaging)
    - [PostGroupByTemplateRequest](#keyapis-access_management-v1-PostGroupByTemplateRequest)
    - [PostGroupByTemplateResponse](#keyapis-access_management-v1-PostGroupByTemplateResponse)
    - [PostGroupByTemplateResponse.Error](#keyapis-access_management-v1-PostGroupByTemplateResponse-Error)
    - [PostGroupRequest](#keyapis-access_management-v1-PostGroupRequest)
    - [PostGroupResponse](#keyapis-access_management-v1-PostGroupResponse)
    - [PostGroupResponse.Error](#keyapis-access_management-v1-PostGroupResponse-Error)
    - [PutGroupApiKeyCreateRequest](#keyapis-access_management-v1-PutGroupApiKeyCreateRequest)
    - [PutGroupApiKeyCreateResponse](#keyapis-access_management-v1-PutGroupApiKeyCreateResponse)
    - [PutGroupApiKeyDeleteRequest](#keyapis-access_management-v1-PutGroupApiKeyDeleteRequest)
    - [PutGroupApiKeyDeleteResponse](#keyapis-access_management-v1-PutGroupApiKeyDeleteResponse)
    - [PutGroupUserAttachRequest](#keyapis-access_management-v1-PutGroupUserAttachRequest)
    - [PutGroupUserAttachResponse](#keyapis-access_management-v1-PutGroupUserAttachResponse)
    - [PutGroupUserDetachRequest](#keyapis-access_management-v1-PutGroupUserDetachRequest)
    - [PutGroupUserDetachResponse](#keyapis-access_management-v1-PutGroupUserDetachResponse)
    - [UserGroup](#keyapis-access_management-v1-UserGroup)
    - [ValidationError](#keyapis-access_management-v1-ValidationError)
  
    - [GroupClaimPaging.DirectionType](#keyapis-access_management-v1-GroupClaimPaging-DirectionType)
    - [GroupClaimPaging.OrderByType](#keyapis-access_management-v1-GroupClaimPaging-OrderByType)
    - [GroupPaging.DirectionType](#keyapis-access_management-v1-GroupPaging-DirectionType)
    - [GroupPaging.OrderByType](#keyapis-access_management-v1-GroupPaging-OrderByType)
    - [GroupUserPaging.DirectionType](#keyapis-access_management-v1-GroupUserPaging-DirectionType)
    - [GroupUserPaging.OrderByType](#keyapis-access_management-v1-GroupUserPaging-OrderByType)
  


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




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

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


<a name="keyapis-access_management-v1-GroupService"></a>

### GroupService
 Сервис управления доступом пользователей

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-access_management-v1-GetGroup"></a> [GetGroup](#keyapis-access_management-v1-GetGroup) | Метод получения группы. Метод доступен для: admin, service, bti, seller | [keyapis.access_management.v1.GetGroupRequest](#keyapis-access_management-v1-GetGroupRequest) | [keyapis.access_management.v1.GetGroupResponse](#keyapis-access_management-v1-GetGroupResponse) |
| <a id="keyapis-access_management-v1-GetGroupList"></a> [GetGroupList](#keyapis-access_management-v1-GetGroupList) | Метод получения списка групп. Метод доступен для: admin, service, bti, seller | [keyapis.access_management.v1.GetGroupListRequest](#keyapis-access_management-v1-GetGroupListRequest) | [keyapis.access_management.v1.GetGroupListResponse](#keyapis-access_management-v1-GetGroupListResponse) stream |
| <a id="keyapis-access_management-v1-GetGroupCount"></a> [GetGroupCount](#keyapis-access_management-v1-GetGroupCount) | Метод получения количества групп. Метод доступен для: admin, service, bti, seller | [keyapis.access_management.v1.GetGroupCountRequest](#keyapis-access_management-v1-GetGroupCountRequest) | [keyapis.access_management.v1.GetGroupCountResponse](#keyapis-access_management-v1-GetGroupCountResponse) |
| <a id="keyapis-access_management-v1-PostGroup"></a> [PostGroup](#keyapis-access_management-v1-PostGroup) | Метод сохранения группы. Поддерживает создание и обновление как UPSERT по Group.id. Метод доступен для: admin, service | [keyapis.access_management.v1.PostGroupRequest](#keyapis-access_management-v1-PostGroupRequest) | [keyapis.access_management.v1.PostGroupResponse](#keyapis-access_management-v1-PostGroupResponse) |
| <a id="keyapis-access_management-v1-DeleteGroup"></a> [DeleteGroup](#keyapis-access_management-v1-DeleteGroup) | Метод удаления группы. Метод доступен для: admin, service | [keyapis.access_management.v1.DeleteGroupRequest](#keyapis-access_management-v1-DeleteGroupRequest) | [keyapis.access_management.v1.DeleteGroupResponse](#keyapis-access_management-v1-DeleteGroupResponse) |
| <a id="keyapis-access_management-v1-PostGroupByTemplate"></a> [PostGroupByTemplate](#keyapis-access_management-v1-PostGroupByTemplate) | Метод создания группы по шаблону. Метод доступен для: admin, service, bti, seller | [keyapis.access_management.v1.PostGroupByTemplateRequest](#keyapis-access_management-v1-PostGroupByTemplateRequest) | [keyapis.access_management.v1.PostGroupByTemplateResponse](#keyapis-access_management-v1-PostGroupByTemplateResponse) |
| <a id="keyapis-access_management-v1-PutGroupUserAttach"></a> [PutGroupUserAttach](#keyapis-access_management-v1-PutGroupUserAttach) | Метод привязки пользователя к группе. Метод доступен для: admin, owner, service, bti, seller | [keyapis.access_management.v1.PutGroupUserAttachRequest](#keyapis-access_management-v1-PutGroupUserAttachRequest) | [keyapis.access_management.v1.PutGroupUserAttachResponse](#keyapis-access_management-v1-PutGroupUserAttachResponse) |
| <a id="keyapis-access_management-v1-PutGroupUserDetach"></a> [PutGroupUserDetach](#keyapis-access_management-v1-PutGroupUserDetach) | Метод удаления привязки пользователя к группе. Метод доступен для: admin, owner, service, bti, seller | [keyapis.access_management.v1.PutGroupUserDetachRequest](#keyapis-access_management-v1-PutGroupUserDetachRequest) | [keyapis.access_management.v1.PutGroupUserDetachResponse](#keyapis-access_management-v1-PutGroupUserDetachResponse) |
| <a id="keyapis-access_management-v1-GetGroupUserList"></a> [GetGroupUserList](#keyapis-access_management-v1-GetGroupUserList) | Метод получения списка связей пользователей и групп. Метод доступен для: admin, owner, service, bti, seller | [keyapis.access_management.v1.GetGroupUserListRequest](#keyapis-access_management-v1-GetGroupUserListRequest) | [keyapis.access_management.v1.GetGroupUserListResponse](#keyapis-access_management-v1-GetGroupUserListResponse) stream |
| <a id="keyapis-access_management-v1-GetGroupUserCount"></a> [GetGroupUserCount](#keyapis-access_management-v1-GetGroupUserCount) | Метод получения количества связей пользователей и групп. Метод доступен для: admin, owner, service, bti, seller | [keyapis.access_management.v1.GetGroupUserCountRequest](#keyapis-access_management-v1-GetGroupUserCountRequest) | [keyapis.access_management.v1.GetGroupUserCountResponse](#keyapis-access_management-v1-GetGroupUserCountResponse) |
| <a id="keyapis-access_management-v1-GetGroupClaimList"></a> [GetGroupClaimList](#keyapis-access_management-v1-GetGroupClaimList) | Метод получения уникальных назначенных атрибутов пользователя. Метод также возвращает группы пользователя в виде атрибута (Claim) {key=GROUP_ID,value=Group.id}. Бизнес-пользователи получают только свои разрешения, поэтому для всех пользователей, кроме admin, owner, service, bti, seller игнорируются GroupClaimFilter.user_id, GroupClaimFilter.user_data, GroupClaimFilter.api_key_hash, а значения для них берутся из токена. Для admin, owner, service, bti, seller при наличии GroupClaimFilter.user_id отдаем разрешения для указанного GroupClaimFilter.user_id и GroupClaimFilter.user_data, при отсутствии GroupClaimFilter.user_id значения берутся из токена. Для admin, service при наличии GroupClaimFilter.api_key_hash возвращаем Claim с учетом только GroupClaimFilter.api_key_hash. Метод доступен для: admin, master, slave, owner, employee, service, bti, seller, external_seller, ltp_first, mrf, manager | [keyapis.access_management.v1.GetGroupClaimListRequest](#keyapis-access_management-v1-GetGroupClaimListRequest) | [keyapis.access_management.v1.GetGroupClaimListResponse](#keyapis-access_management-v1-GetGroupClaimListResponse) stream |
| <a id="keyapis-access_management-v1-GetGroupClaimCount"></a> [GetGroupClaimCount](#keyapis-access_management-v1-GetGroupClaimCount) | Метод получения количества уникальных назначенных атрибутов пользователя. Метод также сосчитает и атрибуты групп {key=GROUP_ID,value=Group.id}. Бизнес-пользователи получают только свои разрешения, поэтому для всех пользователей, кроме admin, owner, service, bti, seller игнорируются GroupClaimFilter.user_id, GroupClaimFilter.user_data, GroupClaimFilter.api_key_hash, а значения для них берутся из токена. Для admin, owner, service, bti, seller при наличии GroupClaimFilter.user_id отдаем разрешения для указанного GroupClaimFilter.user_id и GroupClaimFilter.user_data, при отсутствии GroupClaimFilter.user_id значения берутся из токена. Для admin, service при наличии GroupClaimFilter.api_key_hash возвращаем Claim с учетом только GroupClaimFilter.api_key_hash. Метод доступен для: admin, master, slave, owner, employee, service, bti, seller, external_seller, ltp_first, mrf, manager | [keyapis.access_management.v1.GetGroupClaimCountRequest](#keyapis-access_management-v1-GetGroupClaimCountRequest) | [keyapis.access_management.v1.GetGroupClaimCountResponse](#keyapis-access_management-v1-GetGroupClaimCountResponse) |
| <a id="keyapis-access_management-v1-GetGroupClaimExist"></a> [GetGroupClaimExist](#keyapis-access_management-v1-GetGroupClaimExist) | Метод проверки наличия назначенных атрибутов пользователя. Метод также проверит и атрибуты групп {key=GROUP_ID,value=Group.id}. Бизнес-пользователи получают только свои разрешения, поэтому для всех пользователей, кроме admin, owner, service, bti, seller игнорируются GroupClaimFilter.user_id, GroupClaimFilter.user_data, GroupClaimFilter.api_key_hash, а значения для них берутся из токена. Для admin, owner, service, bti, seller при наличии GroupClaimFilter.user_id отдаем разрешения для указанного GroupClaimFilter.user_id и GroupClaimFilter.user_data, при отсутствии GroupClaimFilter.user_id значения берутся из токена. Для admin, service при наличии GroupClaimFilter.api_key_hash возвращаем Claim с учетом только GroupClaimFilter.api_key_hash. Метод доступен для: admin, master, slave, owner, employee, service, bti, seller, external_seller, ltp_first, mrf, manager | [keyapis.access_management.v1.GetGroupClaimExistRequest](#keyapis-access_management-v1-GetGroupClaimExistRequest) | [keyapis.access_management.v1.GetGroupClaimExistResponse](#keyapis-access_management-v1-GetGroupClaimExistResponse) |
| <a id="keyapis-access_management-v1-PutGroupApiKeyCreate"></a> [PutGroupApiKeyCreate](#keyapis-access_management-v1-PutGroupApiKeyCreate) | Метод добавления ключа доступа ApiKey. Метод доступен для: admin | [keyapis.access_management.v1.PutGroupApiKeyCreateRequest](#keyapis-access_management-v1-PutGroupApiKeyCreateRequest) | [keyapis.access_management.v1.PutGroupApiKeyCreateResponse](#keyapis-access_management-v1-PutGroupApiKeyCreateResponse) |
| <a id="keyapis-access_management-v1-PutGroupApiKeyDelete"></a> [PutGroupApiKeyDelete](#keyapis-access_management-v1-PutGroupApiKeyDelete) | Метод удаления ключей доступа ApiKey. Метод доступен для: admin | [keyapis.access_management.v1.PutGroupApiKeyDeleteRequest](#keyapis-access_management-v1-PutGroupApiKeyDeleteRequest) | [keyapis.access_management.v1.PutGroupApiKeyDeleteResponse](#keyapis-access_management-v1-PutGroupApiKeyDeleteResponse) |

 <!-- end services -->


<a name="keyapis-access_management-v1-Claim"></a>


### [Claim](#keyapis-access_management-v1-Claim)
 Атрибут пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-Claim-key"></a> [key](#keyapis-access_management-v1-Claim-key) | Ключ атрибута |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_management-v1-Claim-value"></a> [value](#keyapis-access_management-v1-Claim-value) | Значение атрибута |    [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-DeleteGroupRequest"></a>


### [DeleteGroupRequest](#keyapis-access_management-v1-DeleteGroupRequest)
 Запрос удаления группы


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-DeleteGroupRequest-id"></a> [id](#keyapis-access_management-v1-DeleteGroupRequest-id) | Идентификатор группы. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-access_management-v1-DeleteGroupResponse"></a>


### [DeleteGroupResponse](#keyapis-access_management-v1-DeleteGroupResponse)
 Ответ на запрос удаления группы






<a name="keyapis-access_management-v1-GetGroupClaimCountRequest"></a>


### [GetGroupClaimCountRequest](#keyapis-access_management-v1-GetGroupClaimCountRequest)
 Запрос получения количества уникальных назначенных атрибутов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupClaimCountRequest-filter"></a> [filter](#keyapis-access_management-v1-GetGroupClaimCountRequest-filter) | Фильтр атрибутов пользователя |    [keyapis.access_management.v1.GroupClaimFilter](#keyapis-access_management-v1-GroupClaimFilter) | <nil>|






<a name="keyapis-access_management-v1-GetGroupClaimCountResponse"></a>


### [GetGroupClaimCountResponse](#keyapis-access_management-v1-GetGroupClaimCountResponse)
 Ответ на запрос получения количества уникальных назначенных атрибутов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupClaimCountResponse-data"></a> [data](#keyapis-access_management-v1-GetGroupClaimCountResponse-data) | Всего уникальных атрибутов пользователя |  optional  [int32](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GetGroupClaimExistRequest"></a>


### [GetGroupClaimExistRequest](#keyapis-access_management-v1-GetGroupClaimExistRequest)
 Запрос проверки назначенных атрибутов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupClaimExistRequest-filter"></a> [filter](#keyapis-access_management-v1-GetGroupClaimExistRequest-filter) | Фильтр атрибутов пользователя |    [keyapis.access_management.v1.GroupClaimFilter](#keyapis-access_management-v1-GroupClaimFilter) | <nil>|






<a name="keyapis-access_management-v1-GetGroupClaimExistResponse"></a>


### [GetGroupClaimExistResponse](#keyapis-access_management-v1-GetGroupClaimExistResponse)
 Ответ на запрос проверки назначенных атрибутов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupClaimExistResponse-data"></a> [data](#keyapis-access_management-v1-GetGroupClaimExistResponse-data) | Флаг наличия |  optional  [bool](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-GetGroupClaimExistResponse-error"></a> [error](#keyapis-access_management-v1-GetGroupClaimExistResponse-error) | Ошибка |  optional  [keyapis.access_management.v1.GetGroupClaimExistResponse.Error](#keyapis-access_management-v1-GetGroupClaimExistResponse-Error) | <nil>|






<a name="keyapis-access_management-v1-GetGroupClaimExistResponse-Error"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupClaimExistResponse-Error-claim_filter_empty"></a> [claim_filter_empty](#keyapis-access_management-v1-GetGroupClaimExistResponse-Error-claim_filter_empty) | Ошибка пустого фильтра по атрибутам пользователя |  optional  [keyapis.access_management.v1.GetGroupClaimExistResponse.Error.ClaimFilterEmptyError](#keyapis-access_management-v1-GetGroupClaimExistResponse-Error-ClaimFilterEmptyError) | <nil>|






<a name="keyapis-access_management-v1-GetGroupClaimExistResponse-Error-ClaimFilterEmptyError"></a>


### [GetGroupClaimExistResponse.Error.ClaimFilterEmptyError](#keyapis-access_management-v1-GetGroupClaimExistResponse-Error-ClaimFilterEmptyError)
 Ошибка пустого фильтра по атрибутам пользователя






<a name="keyapis-access_management-v1-GetGroupClaimListRequest"></a>


### [GetGroupClaimListRequest](#keyapis-access_management-v1-GetGroupClaimListRequest)
 Запрос уникального списка назначенных атрибутов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupClaimListRequest-filter"></a> [filter](#keyapis-access_management-v1-GetGroupClaimListRequest-filter) | Фильтр атрибутов пользователя |    [keyapis.access_management.v1.GroupClaimFilter](#keyapis-access_management-v1-GroupClaimFilter) | <nil>|
| <a id="keyapis-access_management-v1-GetGroupClaimListRequest-paging"></a> [paging](#keyapis-access_management-v1-GetGroupClaimListRequest-paging) | Пагинация по атрибутам пользователя |  optional  [keyapis.access_management.v1.GroupClaimPaging](#keyapis-access_management-v1-GroupClaimPaging) | <nil>|






<a name="keyapis-access_management-v1-GetGroupClaimListResponse"></a>


### [GetGroupClaimListResponse](#keyapis-access_management-v1-GetGroupClaimListResponse)
 Ответ на запрос уникального списка назначенных атрибутов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupClaimListResponse-data"></a> [data](#keyapis-access_management-v1-GetGroupClaimListResponse-data) | Атрибут пользователя |  optional  [keyapis.access_management.v1.Claim](#keyapis-access_management-v1-Claim) | <nil>|






<a name="keyapis-access_management-v1-GetGroupCountRequest"></a>


### [GetGroupCountRequest](#keyapis-access_management-v1-GetGroupCountRequest)
 Запрос получения количества групп


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






<a name="keyapis-access_management-v1-GetGroupCountResponse"></a>


### [GetGroupCountResponse](#keyapis-access_management-v1-GetGroupCountResponse)
 Ответ на запрос получения количества групп


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






<a name="keyapis-access_management-v1-GetGroupCountResponse-Error"></a>


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


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






<a name="keyapis-access_management-v1-GetGroupListRequest"></a>


### [GetGroupListRequest](#keyapis-access_management-v1-GetGroupListRequest)
 Запрос получения списка групп


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupListRequest-filter"></a> [filter](#keyapis-access_management-v1-GetGroupListRequest-filter) | Фильтр |    [keyapis.access_management.v1.GroupFilter](#keyapis-access_management-v1-GroupFilter) | <nil>|
| <a id="keyapis-access_management-v1-GetGroupListRequest-paging"></a> [paging](#keyapis-access_management-v1-GetGroupListRequest-paging) | Пагинация |  optional  [keyapis.access_management.v1.GroupPaging](#keyapis-access_management-v1-GroupPaging) | <nil>|






<a name="keyapis-access_management-v1-GetGroupListResponse"></a>


### [GetGroupListResponse](#keyapis-access_management-v1-GetGroupListResponse)
 Ответ на запрос получения списка групп


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






<a name="keyapis-access_management-v1-GetGroupListResponse-Error"></a>


### [GetGroupListResponse.Error](#keyapis-access_management-v1-GetGroupListResponse-Error)
 Ошибка запроса получения списка групп


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






<a name="keyapis-access_management-v1-GetGroupRequest"></a>


### [GetGroupRequest](#keyapis-access_management-v1-GetGroupRequest)
 Запрос получения группы


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupRequest-id"></a> [id](#keyapis-access_management-v1-GetGroupRequest-id) | Идентификатор группы. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-access_management-v1-GetGroupResponse"></a>


### [GetGroupResponse](#keyapis-access_management-v1-GetGroupResponse)
 Ответ на запрос получения группы


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






<a name="keyapis-access_management-v1-GetGroupResponse-Error"></a>


### [GetGroupResponse.Error](#keyapis-access_management-v1-GetGroupResponse-Error)
 Ошибка запроса получения группы


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






<a name="keyapis-access_management-v1-GetGroupUserCountRequest"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupUserCountRequest-filter"></a> [filter](#keyapis-access_management-v1-GetGroupUserCountRequest-filter) | Фильтр связей пользователей и групп |    [keyapis.access_management.v1.GroupUserFilter](#keyapis-access_management-v1-GroupUserFilter) | <nil>|






<a name="keyapis-access_management-v1-GetGroupUserCountResponse"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupUserCountResponse-data"></a> [data](#keyapis-access_management-v1-GetGroupUserCountResponse-data) | Всего связей пользователей и групп |  optional  [int32](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GetGroupUserListRequest"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupUserListRequest-filter"></a> [filter](#keyapis-access_management-v1-GetGroupUserListRequest-filter) | Фильтр связей пользователей и групп |    [keyapis.access_management.v1.GroupUserFilter](#keyapis-access_management-v1-GroupUserFilter) | <nil>|
| <a id="keyapis-access_management-v1-GetGroupUserListRequest-paging"></a> [paging](#keyapis-access_management-v1-GetGroupUserListRequest-paging) | Пагинация |  optional  [keyapis.access_management.v1.GroupUserPaging](#keyapis-access_management-v1-GroupUserPaging) | <nil>|






<a name="keyapis-access_management-v1-GetGroupUserListResponse"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GetGroupUserListResponse-data"></a> [data](#keyapis-access_management-v1-GetGroupUserListResponse-data) | Связь пользователя и группы |  optional  [keyapis.access_management.v1.UserGroup](#keyapis-access_management-v1-UserGroup) | <nil>|






<a name="keyapis-access_management-v1-Group"></a>


### [Group](#keyapis-access_management-v1-Group)
 Группа атрибутов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-Group-id"></a> [id](#keyapis-access_management-v1-Group-id) | Идентификатор группы. # Тип: Guid |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-Group-title"></a> [title](#keyapis-access_management-v1-Group-title) | Наименование. # Диапазон: 3..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_management-v1-Group-description"></a> [description](#keyapis-access_management-v1-Group-description) | Описание. # Диапазон: 3..256 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-Group-claims"></a> [claims](#keyapis-access_management-v1-Group-claims) | Массив атрибутов группы. Эти атрибуты назначены пользователям, которые принадлежат группе. # Диапазон: 0..100 |  repeated  [keyapis.access_management.v1.Claim](#keyapis-access_management-v1-Claim) | <nil>|
| <a id="keyapis-access_management-v1-Group-requirements"></a> [requirements](#keyapis-access_management-v1-Group-requirements) | Требования, означающие принадлежность пользователя к данной группе. Пользователь принадлежит группе, если все атрибуты требований группы присутствуют у пользователя и имеют те же значения. # Диапазон: 0..10 |  repeated  [keyapis.access_management.v1.Claim](#keyapis-access_management-v1-Claim) | <nil>|
| <a id="keyapis-access_management-v1-Group-deleted_at"></a> [deleted_at](#keyapis-access_management-v1-Group-deleted_at) | Дата удаления группы из использования. Группа не участвует в определении разрешений пользователя, если дата deleted_at непустая и уже в прошлом |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_management-v1-Group-tags"></a> [tags](#keyapis-access_management-v1-Group-tags) | Теги группы. # Диапазон: 0..10 |  repeated  [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GroupClaimFilter"></a>


### [GroupClaimFilter](#keyapis-access_management-v1-GroupClaimFilter)
 Фильтр атрибутов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupClaimFilter-user_id"></a> [user_id](#keyapis-access_management-v1-GroupClaimFilter-user_id) | По идентификатору пользователя. Соответствует subject, sub, client_id из JWT. Для пользователя Ключа это user_id Ключа |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_management-v1-GroupClaimFilter-claims"></a> [claims](#keyapis-access_management-v1-GroupClaimFilter-claims) | По назначенным атрибутам пользователя. Фильтр ограничивает возвращаемые атрибуты данным списком. Возвращаем атрибуты групп, у которых Claim.key=claims[n].key И (Claim.value=claims[n].value ИЛИ claims[n].value пустой). При пустом GroupClaimFilter.claims не ограничиваем выдачу, отдаем все Claims, назначенные пользователю |  repeated  [keyapis.access_management.v1.GroupClaimFilter.ClaimsEntry](#keyapis-access_management-v1-GroupClaimFilter-ClaimsEntry) | <nil>|
| <a id="keyapis-access_management-v1-GroupClaimFilter-user_data"></a> [user_data](#keyapis-access_management-v1-GroupClaimFilter-user_data) | По условию принадлежности к группе. Пользователь принадлежит группе, если user_data полностью удовлетворяет требованиям группы, то есть user_data содержит в себе Group.requirements целиком |    [keyapis.access_management.v1.GroupClaimFilter.UserData](#keyapis-access_management-v1-GroupClaimFilter-UserData) | <nil>|
| <a id="keyapis-access_management-v1-GroupClaimFilter-api_key_hash"></a> [api_key_hash](#keyapis-access_management-v1-GroupClaimFilter-api_key_hash) | Хешированное SHA256 значение ключа доступа ApiKey |    [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GroupClaimFilter-ClaimsEntry"></a>


### [GroupClaimFilter.ClaimsEntry](#keyapis-access_management-v1-GroupClaimFilter-ClaimsEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupClaimFilter-ClaimsEntry-key"></a> [key](#keyapis-access_management-v1-GroupClaimFilter-ClaimsEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-GroupClaimFilter-ClaimsEntry-value"></a> [value](#keyapis-access_management-v1-GroupClaimFilter-ClaimsEntry-value) |  |    [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GroupClaimFilter-UserData"></a>


### [GroupClaimFilter.UserData](#keyapis-access_management-v1-GroupClaimFilter-UserData)
 Условие принадлежности к группе


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupClaimFilter-UserData-claims"></a> [claims](#keyapis-access_management-v1-GroupClaimFilter-UserData-claims) | Атрибуты пользователя, claims которого мы хотим получить |  repeated  [keyapis.access_management.v1.GroupClaimFilter.UserData.ClaimsEntry](#keyapis-access_management-v1-GroupClaimFilter-UserData-ClaimsEntry) | <nil>|






<a name="keyapis-access_management-v1-GroupClaimFilter-UserData-ClaimsEntry"></a>


### [GroupClaimFilter.UserData.ClaimsEntry](#keyapis-access_management-v1-GroupClaimFilter-UserData-ClaimsEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupClaimFilter-UserData-ClaimsEntry-key"></a> [key](#keyapis-access_management-v1-GroupClaimFilter-UserData-ClaimsEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-GroupClaimFilter-UserData-ClaimsEntry-value"></a> [value](#keyapis-access_management-v1-GroupClaimFilter-UserData-ClaimsEntry-value) |  |    [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GroupClaimPaging"></a>


### [GroupClaimPaging](#keyapis-access_management-v1-GroupClaimPaging)
 Пагинация атрибутов пользователя


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






<a name="keyapis-access_management-v1-GroupFilter"></a>


### [GroupFilter](#keyapis-access_management-v1-GroupFilter)
 Фильтр групп


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupFilter-text"></a> [text](#keyapis-access_management-v1-GroupFilter-text) | По тексту. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Наименование |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-GroupFilter-requirements"></a> [requirements](#keyapis-access_management-v1-GroupFilter-requirements) | По requirements группы. Возвращаем группы, у которых Group.requirements.key=GroupFilter.requirements[n].key И Group.requirements.value=GroupFilter.requirements[n].value. При пустом GroupFilter.requirements[n].value возвращаем все группы, у которых Group.requirements.key=GroupFilter.requirements[n].key. При передаче нескольких элементов map они работают в выборке через И |  repeated  [keyapis.access_management.v1.GroupFilter.RequirementsEntry](#keyapis-access_management-v1-GroupFilter-RequirementsEntry) | <nil>|
| <a id="keyapis-access_management-v1-GroupFilter-claims"></a> [claims](#keyapis-access_management-v1-GroupFilter-claims) | По claims группы. Возвращаем группы, у которых Group.claim.key=GroupFilter.claims[n].key И Group.claims.value=GroupFilter.claims[n].value. При пустом GroupFilter.claims[n].value возвращаем все группы, у которых Group.claims.key=GroupFilter.claims[n].key. При передаче нескольких элементов map они работают в выборке через И |  repeated  [keyapis.access_management.v1.GroupFilter.ClaimsEntry](#keyapis-access_management-v1-GroupFilter-ClaimsEntry) | <nil>|
| <a id="keyapis-access_management-v1-GroupFilter-tags"></a> [tags](#keyapis-access_management-v1-GroupFilter-tags) | По тегам. # Диапазон: 0..10 |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-GroupFilter-hide_deleted"></a> [hide_deleted](#keyapis-access_management-v1-GroupFilter-hide_deleted) | Скрывать удалённые элементы. Если значение — true, возвращаются только записи, у которых deleted_at = null или deleted_at > текущего времени. Если значение — false или не задано, возвращаются все записи, включая удалённые |    [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="keyapis-access_management-v1-GroupFilter-ClaimsEntry"></a>


### [GroupFilter.ClaimsEntry](#keyapis-access_management-v1-GroupFilter-ClaimsEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupFilter-ClaimsEntry-key"></a> [key](#keyapis-access_management-v1-GroupFilter-ClaimsEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-GroupFilter-ClaimsEntry-value"></a> [value](#keyapis-access_management-v1-GroupFilter-ClaimsEntry-value) |  |    [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GroupFilter-RequirementsEntry"></a>


### [GroupFilter.RequirementsEntry](#keyapis-access_management-v1-GroupFilter-RequirementsEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupFilter-RequirementsEntry-key"></a> [key](#keyapis-access_management-v1-GroupFilter-RequirementsEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-GroupFilter-RequirementsEntry-value"></a> [value](#keyapis-access_management-v1-GroupFilter-RequirementsEntry-value) |  |    [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GroupPaging"></a>


### [GroupPaging](#keyapis-access_management-v1-GroupPaging)
 Пагинация групп


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






<a name="keyapis-access_management-v1-GroupTemplateNotFoundError"></a>


### [GroupTemplateNotFoundError](#keyapis-access_management-v1-GroupTemplateNotFoundError)
 Ошибки создания группы по шаблону


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupTemplateNotFoundError-group_template_id"></a> [group_template_id](#keyapis-access_management-v1-GroupTemplateNotFoundError-group_template_id) | Идентификатор шаблона группы, который не найден |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_management-v1-GroupTemplateNotFoundError-message"></a> [message](#keyapis-access_management-v1-GroupTemplateNotFoundError-message) | Сообщение |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-access_management-v1-GroupUserFilter"></a>


### [GroupUserFilter](#keyapis-access_management-v1-GroupUserFilter)
 Фильтр для запроса связей пользователей и групп.
При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ.
При передаче нескольких разных параметров фильтра они работают в выборке через И


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-GroupUserFilter-group_ids"></a> [group_ids](#keyapis-access_management-v1-GroupUserFilter-group_ids) | По Идентификаторам группы |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-access_management-v1-GroupUserFilter-user_ids"></a> [user_ids](#keyapis-access_management-v1-GroupUserFilter-user_ids) | По Идентификаторам пользователя |  repeated  [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-GroupUserPaging"></a>


### [GroupUserPaging](#keyapis-access_management-v1-GroupUserPaging)
 Пагинация связей пользователей и групп


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






<a name="keyapis-access_management-v1-PostGroupByTemplateRequest"></a>


### [PostGroupByTemplateRequest](#keyapis-access_management-v1-PostGroupByTemplateRequest)
 Запрос создания группы по шаблону


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-PostGroupByTemplateRequest-group_template_id"></a> [group_template_id](#keyapis-access_management-v1-PostGroupByTemplateRequest-group_template_id) | Идентификатор шаблона группы. # Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_management-v1-PostGroupByTemplateRequest-group_title"></a> [group_title](#keyapis-access_management-v1-PostGroupByTemplateRequest-group_title) | Наименование создаваемой по шаблону группы. В наименование группы будет добавлен суффикс GroupTemplate.group_title_suffix. # Диапазон: 3..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_management-v1-PostGroupByTemplateRequest-group_requirements"></a> [group_requirements](#keyapis-access_management-v1-PostGroupByTemplateRequest-group_requirements) | Специфичные для создаваемой по шаблону группы Claim requirements, они будут добавлены к requirements создаваемой по шаблону группы. # Диапазон: 0..10 |  repeated  [keyapis.access_management.v1.Claim](#keyapis-access_management-v1-Claim) | <nil>|






<a name="keyapis-access_management-v1-PostGroupByTemplateResponse"></a>


### [PostGroupByTemplateResponse](#keyapis-access_management-v1-PostGroupByTemplateResponse)
 Ответ на запрос создания группы по шаблону


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






<a name="keyapis-access_management-v1-PostGroupByTemplateResponse-Error"></a>


### [PostGroupByTemplateResponse.Error](#keyapis-access_management-v1-PostGroupByTemplateResponse-Error)
 Ошибка запроса создания группы


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






<a name="keyapis-access_management-v1-PostGroupRequest"></a>


### [PostGroupRequest](#keyapis-access_management-v1-PostGroupRequest)
 Запрос сохранения группы


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-PostGroupRequest-data"></a> [data](#keyapis-access_management-v1-PostGroupRequest-data) | Группа |    [keyapis.access_management.v1.Group](#keyapis-access_management-v1-Group) | REQUIRED|






<a name="keyapis-access_management-v1-PostGroupResponse"></a>


### [PostGroupResponse](#keyapis-access_management-v1-PostGroupResponse)
 Ответ на запрос сохранения группы


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






<a name="keyapis-access_management-v1-PostGroupResponse-Error"></a>


### [PostGroupResponse.Error](#keyapis-access_management-v1-PostGroupResponse-Error)
 Ошибка запроса сохранения группы


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






<a name="keyapis-access_management-v1-PutGroupApiKeyCreateRequest"></a>


### [PutGroupApiKeyCreateRequest](#keyapis-access_management-v1-PutGroupApiKeyCreateRequest)
 Запрос на добавления группе ключа доступа ApiKey


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-PutGroupApiKeyCreateRequest-group_id"></a> [group_id](#keyapis-access_management-v1-PutGroupApiKeyCreateRequest-group_id) | Идентификатор группы. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-access_management-v1-PutGroupApiKeyCreateResponse"></a>


### [PutGroupApiKeyCreateResponse](#keyapis-access_management-v1-PutGroupApiKeyCreateResponse)
 Ответ на запрос на добавления группе ключа доступа ApiKey


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-PutGroupApiKeyCreateResponse-data"></a> [data](#keyapis-access_management-v1-PutGroupApiKeyCreateResponse-data) | Значение ключа доступа ApiKey. # Тип: Guid |  optional  [string](#scalar-types) | <nil>|






<a name="keyapis-access_management-v1-PutGroupApiKeyDeleteRequest"></a>


### [PutGroupApiKeyDeleteRequest](#keyapis-access_management-v1-PutGroupApiKeyDeleteRequest)
 Запрос на удаление ключей доступа ApiKey


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-PutGroupApiKeyDeleteRequest-group_id"></a> [group_id](#keyapis-access_management-v1-PutGroupApiKeyDeleteRequest-group_id) | Идентификатор группы. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-access_management-v1-PutGroupApiKeyDeleteResponse"></a>


### [PutGroupApiKeyDeleteResponse](#keyapis-access_management-v1-PutGroupApiKeyDeleteResponse)
 Ответ на запрос на удаление ключей доступа ApiKey






<a name="keyapis-access_management-v1-PutGroupUserAttachRequest"></a>


### [PutGroupUserAttachRequest](#keyapis-access_management-v1-PutGroupUserAttachRequest)
 Запрос на добавление связи пользователя и группы


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-PutGroupUserAttachRequest-user_group"></a> [user_group](#keyapis-access_management-v1-PutGroupUserAttachRequest-user_group) | Связь пользователя и группы |    [keyapis.access_management.v1.UserGroup](#keyapis-access_management-v1-UserGroup) | REQUIRED|






<a name="keyapis-access_management-v1-PutGroupUserAttachResponse"></a>


### [PutGroupUserAttachResponse](#keyapis-access_management-v1-PutGroupUserAttachResponse)
 Ответ на добавление связи пользователя и группы






<a name="keyapis-access_management-v1-PutGroupUserDetachRequest"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-PutGroupUserDetachRequest-user_group"></a> [user_group](#keyapis-access_management-v1-PutGroupUserDetachRequest-user_group) | Связь пользователя и группы |    [keyapis.access_management.v1.UserGroup](#keyapis-access_management-v1-UserGroup) | REQUIRED|






<a name="keyapis-access_management-v1-PutGroupUserDetachResponse"></a>


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






<a name="keyapis-access_management-v1-UserGroup"></a>


### [UserGroup](#keyapis-access_management-v1-UserGroup)
 Связка пользователя с группой


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_management-v1-UserGroup-user_id"></a> [user_id](#keyapis-access_management-v1-UserGroup-user_id) | Идентификатор пользователя. Соответствует subject, sub, client_id из JWT. # Диапазон: 3..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_management-v1-UserGroup-group_id"></a> [group_id](#keyapis-access_management-v1-UserGroup-group_id) | Идентификатор группы. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






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


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


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





 <!-- end messages -->



<a name="keyapis-access_management-v1-GroupClaimPaging-DirectionType"></a>

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

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




<a name="keyapis-access_management-v1-GroupClaimPaging-OrderByType"></a>

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

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_management-v1-GroupClaimPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-access_management-v1-GroupClaimPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_management-v1-GroupClaimPaging-OrderByType-KEY"></a> [KEY](#keyapis-access_management-v1-GroupClaimPaging-OrderByType-KEY) | По ключу атрибута |
| 2 | <a id="keyapis-access_management-v1-GroupClaimPaging-OrderByType-VALUE"></a> [VALUE](#keyapis-access_management-v1-GroupClaimPaging-OrderByType-VALUE) | По значению атрибута |




<a name="keyapis-access_management-v1-GroupPaging-DirectionType"></a>

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

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




<a name="keyapis-access_management-v1-GroupPaging-OrderByType"></a>

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

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_management-v1-GroupPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-access_management-v1-GroupPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_management-v1-GroupPaging-OrderByType-ID"></a> [ID](#keyapis-access_management-v1-GroupPaging-OrderByType-ID) | По идентификатору |
| 2 | <a id="keyapis-access_management-v1-GroupPaging-OrderByType-TITLE"></a> [TITLE](#keyapis-access_management-v1-GroupPaging-OrderByType-TITLE) | По наименованию |




<a name="keyapis-access_management-v1-GroupUserPaging-DirectionType"></a>

### [GroupUserPaging.DirectionType](#keyapis-access_management-v1-GroupUserPaging-DirectionType)
 Справочник типов направлений сортировки

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




<a name="keyapis-access_management-v1-GroupUserPaging-OrderByType"></a>

### [GroupUserPaging.OrderByType](#keyapis-access_management-v1-GroupUserPaging-OrderByType)
 Справочник типов сортировки

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_management-v1-GroupUserPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-access_management-v1-GroupUserPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_management-v1-GroupUserPaging-OrderByType-GROUP_ID"></a> [GROUP_ID](#keyapis-access_management-v1-GroupUserPaging-OrderByType-GROUP_ID) | По Идентификатору группы |
| 2 | <a id="keyapis-access_management-v1-GroupUserPaging-OrderByType-USER_ID"></a> [USER_ID](#keyapis-access_management-v1-GroupUserPaging-OrderByType-USER_ID) | По Идентификатору пользователя |


 <!-- 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 |