userdirectory.delete

Описание

object userdirectory.delete(array userDirectoryIds)

Этот метод позволяет удалять каталоги пользователей. Каталог пользователей нельзя удалить, если он напрямую используется как минимум одной группой пользователей.
Каталог пользователей LDAP по умолчанию нельзя удалить, если authentication.ldap_configured установлен в 1 или если остаются другие каталоги пользователей.

Этот метод доступен только пользователям типа Супер-администратор.

Параметры

(array) Идентификаторы каталогов пользователей, которые необходимо удалить.

Возвращаемые значения

(object) Возвращает объект, содержащий идентификаторы удалённых каталогов пользователей в свойстве userdirectoryids.

Примеры

Удаление нескольких каталогов пользователей

Удалите два каталога пользователей.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "userdirectory.delete",
    "params": [
        "2",
        "12"
    ],
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "userdirectoryids": [
            "2",
            "12"
        ]
    },
    "id": 1
}

Исходный код

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