userdirectory.delete

説明

object userdirectory.delete(array userDirectoryIds)

このメソッドでは、ユーザーディレクトリを削除できます。ユーザーディレクトリは、少なくとも1つのユーザーグループで直接使用されている場合、削除できません。
デフォルトのLDAPユーザーディレクトリは、authentication.ldap_configured が 1 に設定されている場合、または他にユーザーディレクトリが残っている場合は削除できません。

このメソッドは、Super admin ユーザータイプでのみ利用できます。

パラメータ

(array) 削除するユーザーディレクトリのID。

戻り値

(object) userdirectoryidsプロパティの下にある削除されたユーザーディレクトリのIDを含むオブジェクトを返します。

例

複数のユーザーディレクトリの削除

2つのユーザーディレクトリを削除します。

リクエスト :

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

レスポンス :

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

ソース

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