userdirectory.update

Description

object userdirectory.update(object/array userDirectory)

This method allows to update existing user directories.

Parameters

(object/array) User directory properties to be updated.

The userdirectoryid property must be defined for each user directory, all other properties are optional.
Only the passed properties will be updated, all others will remain unchanged.

Return values

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

Examples

Update bind password for user directory

Set new bind password for a user directory.

Request:

{
           "jsonrpc": "2.0",
           "method": "userdirectory.update",
           "params": {
               "userdirectory": "2",
               "bind_password": "newldappassword"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

Source

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