token.get

Опис

integer/array token.get(object parameters)

Метода омогућава преузимање токена према датим параметрима.

Само тип корисника Супер администратор може да види токене другим корисницима.

Параметри

(објекат) Параметри који дефинишу жељени излаз.

Метода подржава следеће параметре.

Parameter Type Description
tokenids ID/array Врати само токене са датим ID-јевима.
userids ID/array Врати само токене креиране за дате кориснике.
token string Врати само токене креиране за дати Auth token.
valid_at timestamp Врати само токене, који су важећи (нису истекли) у датом датуму и времену.
expired_at timestamp Врати само токене који су истекли (неважећи) у датом датуму и времену.
sortfield string/array Сортирај резултат према датим особинама.

Могуће вредности: tokenid, name, lastaccess, status, expires_at, created_at.
countOutput boolean Ови параметри су описани у референтном коментару.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Повратне вредности

(integer/array) Враћа било:

  • низ објеката;
  • број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање токена

Преузмите све податке са токеном са ID-ијем "2".

Захтев:

{
    "jsonrpc": "2.0",
    "method": "token.get",
    "params": {
        "output": "extend",
        "tokenids": "2"
    },
    "id": 1
}

Одговор:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "tokenid": "1",
            "name": "The Token",
            "description": "",
            "userid": "1",
            "lastaccess": "0",
            "status": "0",
            "expires_at": "1609406220",
            "created_at": "1611239454",
            "creator_userid": "1"
        }
    ],
    "id": 1
}

Извор

CToken::get() у ui/include/classes/api/services/CToken.php.