token.update

説明

object token.update(object/array tokens)

このメソッドは、既存のトークンを更新することができます。

他のユーザーのトークンを管理するには、ユーザーの役割にAPIトークンの管理の権限が必要です。

パラメータ

(object/array) 更新されるトークンプロパティ

tokenidプロパティはトークンごとに定義する必要があり、すべてのプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。

このメソッドは標準トークンプロパティを持つトークンを受け入れます。

戻り値

(object) tokenidsプロパティの下で更新されたトークンのIDを含むオブジェクトを返します。

例

トークンの有効期限変更

トークンから有効期限を削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "token.update",
    "params": {
        "tokenid": "2",
        "expires_at": "0"
    },
    "id": 1
}

レスポンス:

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

ソース

CToken::update() in ui/include/classes/api/services/CToken.php.