token.create

Описание

object token.create(object/array tokens)

Этот метод позволяет создавать новые токены.

Для роли пользователя, управляющей токенами других пользователей, требуется разрешение Управление токенами API.

Токен, созданный этим методом, также необходимо сгенерировать, прежде чем его можно будет использовать.

Параметры

(объект/массив) Создаваемые токены.

Этот метод принимает токены со стандартными свойствами токена.

Возвращаемые значения

(объект) Возвращает объект, который содержит ID созданных токенов, указанных в свойстве tokenids. Порядок возвращаемых ID совпадает с порядком переданных токенов.

Примеры

Создание токена

Создайте включенный токен, срок действия которого никогда не истекает, и который выполняет аутентификацию пользователя с ID 2.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "token.create",
    "params": {
        "name": "Your token",
        "userid": "2"
    },
    "id": 1
}

Ответ:

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

Создайте отключенный токен, срок действия которого истекает 21 января 2021 года. Этот токен будет выполнять аутентификацию текущего пользователя.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "token.create",
    "params": {
        "name": "Your token",
        "status": "1",
        "expires_at": "1611238072"
    },
    "id": 1
}

Ответ:

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

Источник

CToken::create() в ui/include/classes/api/services/CToken.php.