userdirectory.delete

Descrição

object userdirectory.delete(array userDirectoryIds)

Este método permite excluir diretórios de usuários. Um diretório de usuário não pode ser excluído quando está diretamente associado a pelo menos um grupo de usuários. O diretório de usuário LDAP padrão não pode ser excluído quando authentication.ldap_configured está definido como 1 ou quando restarem mais diretórios de usuários.

Este método está disponível apenas para o tipo de usuário Super admin.

Parâmetros

(array) IDs dos diretórios de usuários a serem excluídos.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos diretórios de usuários excluídos na propriedade userdirectoryids .

Exemplos

Excluindo múltiplos diretórios de usuários

Exclua dois diretórios de usuários.

Requisição:

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

Resposta:

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

Fonte

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