userdirectory.update

Description

object userdirectory.update(object/array userDirectory)

Cette méthode permet de mettre à jour des annuaires d’utilisateurs existants.

Paramètres

(object/array) Propriétés du répertoire d’utilisateurs à mettre à jour.

La propriété userdirectoryid doit être définie pour chaque répertoire d’utilisateurs, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.

Valeurs de retour

(object) Renvoie un objet contenant les identifiants des répertoires utilisateurs mis à jour dans la propriété userdirectoryids.

Exemples

Mettre à jour le mot de passe de liaison pour un annuaire d’utilisateurs

Définissez un nouveau mot de passe de liaison pour un annuaire d’utilisateurs.

Requête:

{
    "jsonrpc": "2.0",
    "method": "userdirectory.update",
    "params": {
        "userdirectoryid": "3",
        "bind_password": "newldappassword"
    },
    "id": 1
}

Réponse :

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

Mettre à jour les correspondances du répertoire d’utilisateurs

Mettez à jour les correspondances des groupes de provisionnement et des types de média pour le répertoire d’utilisateurs « 2 ».

Requête :

{
    "jsonrpc": "2.0",
    "method": "userdirectory.update",
    "params": {
        "userdirectoryid": "2",
        "provision_media": [
                {
                    "userdirectory_mediaid": "2"
                }
            ],
            "provision_groups": [
                {
                    "name": "Zabbix administrators",
                    "roleid": "2",
                    "user_groups": [
                        {
                            "usrgrpid": "7"
                        },
                        {
                            "usrgrpid": "8"
                        },
                        {
                            "usrgrpid": "11"
                        }
                    ]
                }
            ]
    },
    "id": 1
}

Réponse :

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

Source

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