userdirectory.delete

Beschreibung

object userdirectory.delete(array userDirectoryIds)

Diese Methode ermöglicht es Ihnen, Benutzerverzeichnisse zu löschen. Ein Benutzerverzeichnis kann nicht gelöscht werden, wenn es direkt für mindestens eine Benutzergruppe verwendet wird.
Das standardmäßige LDAP-Benutzerverzeichnis kann nicht gelöscht werden, wenn authentication.ldap_configured auf 1 gesetzt ist oder wenn keine weiteren Benutzerverzeichnisse mehr vorhanden sind.

Parameter

(array) IDs der zu löschenden Benutzerverzeichnisse.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der gelöschten Benutzerverzeichnisse in der Eigenschaft userdirectoryids enthält.

Beispiele

Mehrere Benutzerverzeichnisse löschen

Löschen Sie zwei Benutzerverzeichnisse.

Anfrage:

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

Antwort:

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

Quelle

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