[comment]: # ({53d969c5-f9e8f670})
# userdirectory.get

[comment]: # ({/53d969c5-f9e8f670})

[comment]: # ({f09e8f55-b5ff62ed})
### Описание

`integer/array userdirectory.get(object parameters)`

Метод позволяет получать каталоги пользователей в соответствии с заданными параметрами.

::: noteclassic
Этот метод доступен только для типов пользователей *Super admin*.
:::

[comment]: # ({/f09e8f55-b5ff62ed})

[comment]: # ({31957bd5-d99c84a0})
### Параметры

`(object)` Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|userdirectoryids|ID/array|Возвращать только каталоги пользователей с указанными ID.|
|selectUsrgrps|query|Возвращать свойство `usrgrps` с [группами пользователей](/manual/api/reference/usergroup/object), связанными с каталогом пользователей.<br><br>Поддерживает `count`.|
|selectProvisionMedia|query|Возвращать свойство `provision_media` с [сопоставлениями типов медиа](/manual/api/reference/userdirectory/object#media-type-mappings), связанными с каталогом пользователей.|
|selectProvisionGroups|query|Возвращать свойство `provision_groups` с [сопоставлениями групп для автоматического создания](/manual/api/reference/userdirectory/object#provisioning-groups-mappings), связанными с каталогом пользователей.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `name`.|
|filter|object|Возвращать только те результаты, которые точно соответствуют указанному фильтру.<br><br>Принимает объект, где ключи — это имена свойств, а значения — либо одно значение, либо массив значений.<br><br>Поддерживаемые свойства: `userdirectoryid`, `idp_type`, `provision_status`.|
|search|object|Возвращать результаты, соответствующие указанному шаблону (без учета регистра).<br><br>Принимает объект, где ключи — это имена свойств, а значения — строки для поиска. Если дополнительные параметры не указаны, будет выполнен поиск `LIKE "%…%"`.<br><br>Поддерживаемые свойства: `name`, `description`.<br><br>Каталог пользователей типа SAML будет иметь пустые значения свойств `name` и `description`. Оба свойства можно изменить с помощью операции `userdirectory.update`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/31957bd5-d99c84a0})

[comment]: # ({7223bab1-a18ff82b})
### Возвращаемые значения

`(integer/array)` Возвращает либо:

-   массив объектов;
-   количество полученных объектов, если использовался параметр `countOutput`.

[comment]: # ({/7223bab1-a18ff82b})

[comment]: # ({b41637d2-ba1c8d4c})
### Примеры

[comment]: # ({/b41637d2-ba1c8d4c})

[comment]: # ({dee71092-6acef378})
##### Получение каталогов пользователей

Получите все каталоги пользователей с дополнительными свойствами, которые отображают сопоставления типов медиа и сопоставления групп автоматического создания, связанные с каждым каталогом пользователей.

[Запрос](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "userdirectory.get",
    "params": {
        "output": "extend",
        "selectProvisionMedia": "extend",
        "selectProvisionGroups": "extend"
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
       {
            "userdirectoryid": "1",
            "idp_type": "2",
            "name": "",
            "provision_status": "1",
            "description": "",
            "group_name": "groups",
            "user_username": "",
            "user_lastname": "",
            "idp_entityid": "http://example.com/simplesaml/saml2/idp/metadata.php",
            "sso_url": "http://example.com/simplesaml/saml2/idp/SSOService.php",
            "slo_url": "",
            "username_attribute": "uid",
            "sp_entityid": "zabbix",
            "nameid_format": "",
            "sign_messages": "0",
            "sign_assertions": "0",
            "sign_authn_requests": "0",
            "sign_logout_requests": "0",
            "sign_logout_responses": "0",
            "encrypt_nameid": "0",
            "encrypt_assertions": "0",
            "scim_status": "1",
            "provision_media": [
                {
                    "userdirectory_mediaid": "1",
                    "name": "example.com",
                    "mediatypeid": "1",
                    "attribute": "user@example.com",
                    "active": "0",
                    "severity": "63",
                    "period": "1-7,00:00-24:00"
                }
            ],
            "provision_groups": [
                {
                    "name": "*",
                    "roleid": "1",
                    "user_groups": [
                        {
                            "usrgrpid": "13"
                        }
                    ]
                }
            ]
        },
        {
            "userdirectoryid": "2",
            "idp_type": "1",
            "name": "AD server",
            "provision_status": "1",
            "description": "",
            "host": "host.example.com",
            "port": "389",
            "base_dn": "DC=zbx,DC=local",
            "search_attribute": "sAMAccountName",
            "bind_dn": "CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local",
            "start_tls": "0",
            "search_filter": "",
            "group_basedn": "OU=Zabbix,DC=zbx,DC=local",
            "group_name": "CN",
            "group_member": "member",
            "group_filter": "(%{groupattr}=CN=%{ref},OU=Users,OU=Zabbix,DC=zbx,DC=local)",
            "group_membership": "",
            "user_username": "givenName",
            "user_lastname": "sn",
            "user_ref_attr": "CN",
            "provision_media": [
                {
                    "userdirectory_mediaid": "2",
                    "name": "example.com",
                    "mediatypeid": "1",
                    "attribute": "user@example.com",
                    "active": "0",
                    "severity": "63",
                    "period": "1-7,00:00-24:00"
                }
            ],
            "provision_groups": [
                {
                    "name": "*",
                    "roleid": "4",
                    "user_groups": [
                        {
                            "usrgrpid": "8"
                        }
                    ]
                },
                {
                    "name": "Zabbix administrators",
                    "roleid": "2",
                    "user_groups": [
                        {
                            "usrgrpid": "7"
                        },
                        {
                            "usrgrpid": "8"
                        }
                    ]
                }
            ]
        },
        {
            "userdirectoryid": "3",
            "idp_type": "1",
            "name": "LDAP API server #1",
            "provision_status": "0",
            "description": "",
            "host": "ldap://local.ldap",
            "port": "389",
            "base_dn": "ou=Users,dc=example,dc=org",
            "search_attribute": "uid",
            "bind_dn": "cn=ldap_search,dc=example,dc=org",
            "start_tls": "1",
            "search_filter": "",
            "group_basedn": "",
            "group_name": "",
            "group_member": "",
            "group_filter": "",
            "group_membership": "",
            "user_username": "",
            "user_lastname": "",
            "user_ref_attr": "",
            "provision_media": [],
            "provision_groups": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/dee71092-6acef378})

[comment]: # ({860ec55f-5f3bc200})
### См. также

-   [Группа пользователей](/manual/api/reference/usergroup/object#user)

[comment]: # ({/860ec55f-5f3bc200})

[comment]: # ({901c82dd-392498dd})
### Исходный код

CUserDirectory::get() в *ui/include/classes/api/services/CUserDirectory.php*.

[comment]: # ({/901c82dd-392498dd})