userdirectory.delete

Beschrijving

object userdirectory.delete(array userDirectoryIds)

Deze methode maakt het mogelijk om gebruikersmappen te verwijderen. Een gebruikersmap kan niet worden verwijderd als deze direct wordt gebruikt voor minstens één gebruikersgroep.
De standaard LDAP-gebruikersmap kan niet worden verwijderd als authentication.ldap_configured is ingesteld op 1 of als er nog meer gebruikersmappen over zijn.

Deze methode is alleen beschikbaar voor gebruikers van het type Super admin.

Parameters

(array) ID's van de te verwijderen gebruikersdirectories.

Retourwaarden

(object) Geeft een object terug met de ID's van de verwijderde gebruikersmappen onder de eigenschap userdirectoryids.

Voorbeelden

Meerdere gebruikersdirectories verwijderen

Verwijder twee gebruikersdirectories.

Aanvraag:

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

Reactie:

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

Bron

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