userdirectory.delete

Description

object userdirectory.delete(array userDirectoryIds)

This method allows to delete user directories. User directory cannot be deleted when it is directly used for at least one user group.
Default LDAP user directory cannot be deleted when authentication.ldap_configured is set to 1 or when there are more user directories left.

パラメータ

(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.