userdirectory.delete

Description

object userdirectory.delete(array userDirectoryIds)

This method allows to delete user directories. User directory cannot be deleted when it is directly used for at least one user group.
Default LDAP user directory cannot be deleted when authentication.ldap_configured is set to 1 or when there are more user directories left.

Parameters

(array) IDs of the user directories to delete.

Return values

(object) Returns an object containing the IDs of the deleted user directories under the userdirectoryids property.

示例

Deleting multiple user directories

Delete two user directories.

Request:

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

Response:

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

Source

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