token.create
説明
object token.create(object/array tokens)
このメソッドでは、新しいトークンを作成できます。
他のユーザーのトークンを管理できるのはSuper adminユーザータイプのみです。
このメソッドで作成されたトークンは、使用する前にgeneratedする必要があります。
パラメータ
(object/array) トークンの作成
このメソッドは標準トークンプロパティを持つトークンを受け入れます。
戻り値
(object) tokenidsプロパティの下で作成されたトークンのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたトークンの順序と一致します。
例
トークンを作成する
有効期限が切れることのない有効なトークンを作成し、ID2のユーザーを認証します。
Request:
{
"jsonrpc": "2.0",
"method": "token.create",
"params": {
"name": "Your token",
"userid": "2"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
{
"jsonrpc": "2.0",
"result": {
"tokenids": [
"188"
]
},
"id": 1
}
2021年1月21日に有効期限が切れるトークンを作成します。このトークンは現在のユーザーを認証します。
Request:
{
"jsonrpc": "2.0",
"method": "token.create",
"params": {
"name": "Your token",
"status": "1",
"expires_at": "1611238072"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
{
"jsonrpc": "2.0",
"result": {
"tokenids": [
"189"
]
},
"id": 1
}
ソース
CToken::create() in ui/include/classes/api/services/CToken.php.