Table of Contents
token.create
Description
object token.create(object/array tokens)
This method allows to create new tokens.
The Manage API tokens permission is required for the user role to manage tokens for other users.
A token created by this method also has to be generated before it is usable.
Parameters
(object/array) Tokens to create.
The method accepts tokens with the standard token properties.
Return values
(object) Returns an object containing the IDs of the created tokens under the tokenids property. The order of the returned IDs matches the order of the passed tokens.
Examples
Create a token
Create an enabled token that never expires and authenticates user of ID 2.
Request:
{
"jsonrpc": "2.0",
"method": "token.create",
"params": {
"name": "Your token",
"userid": "2"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Create a disabled token that expires at January 21st, 2021. This token will authenticate current user.
Request:
{
"jsonrpc": "2.0",
"method": "token.create",
"params": {
"name": "Your token",
"status": "1",
"expires_at": "1611238072"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Source
CToken::create() in ui/include/classes/api/services/CToken.php.