ModifyAccount

ModifyAccountメソッドを使用すると、既存アカウントを変更できます。

アカウントをロックすると、そのアカウントからのすべての既存の接続がただちに切断されます。アカウントのCHAP設定を変更した場合、既存の接続はすべてアクティブなままですが、以降の接続や再接続の際には新しいCHAP設定が使用されます。アカウントの属性をクリアするには、attributesパラメータに{}を指定します。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
accountID 変更するアカウントのID。 整数 なし
status

アカウントのステータス。

active:アカウントはアクティブで、接続は許可されます。

locked:アカウントはロックされており、接続は拒否されます。

文字列 なし ×
initiatorSecret イニシエータに使用するCHAPシークレット。このシークレットは12~16文字で、推測されにくいものにしてください。イニシエータCHAPシークレットは一意にする必要があり、ターゲットCHAPシークレットと同じにすることはできません。 文字列 なし ×
targetSecret ターゲット(相互CHAP認証)に使用するCHAPシークレット。このシークレットは12~16文字で、推測されにくいものにしてください。ターゲットCHAPシークレットは一意にする必要があり、イニシエータCHAPシークレットと同じにすることはできません。 文字列 なし ×
attributes JSONオブジェクト形式の名前と値のペアのリスト。 JSONオブジェクト なし ×
username アカウントに関連付けられているユーザ名を変更する際に使用します。(1~64文字)。 文字列 なし ×

戻り値

このメソッドには戻り値はありません。

要求例

このメソッドの要求例を次に示します。この例では、属性は{}を指定してクリアされています。

{
   "method": "ModifyAccount",
   "params": {
     "accountID" : 25,
     "status"   : "locked",
     "attributes" : {}
   },
   "id" : 1
}

応答例

このメソッドの応答例を次に示します。

{
 "id" : 1, 
 "result" : { }
}

新規導入バージョン

9.6