userdirectory.delete

Beschreibung

object userdirectory.delete(array userDirectoryIds)

Mit dieser Methode können Benutzerverzeichnisse gelöscht werden. Ein Benutzerverzeichnis kann nicht gelöscht werden, wenn es direkt von mindestens einer Benutzergruppe verwendet wird.
Das Standard-LDAP-Benutzerverzeichnis kann nicht gelöscht werden, wenn authentication.ldap_configured auf 1 gesetzt ist oder wenn weitere Benutzerverzeichnisse 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.