token.create

Описание

object token.create(объект/массив 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.