token.get

Apraksts

integer/array token.get(object parameters)

Metode ļauj izgūt tokenus atbilstoši norādītajiem parametriem.

Tikai Super admin lietotāja tipam ir atļauts skatīt citu lietotāju tokenus.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
tokenids ID/array Atgriezt tikai tokenus ar norādītajiem ID.
userids ID/array Atgriezt tikai tokenus, kas izveidoti norādītajiem lietotājiem.
token string Atgriezt tikai tokenus, kas izveidoti norādītajam Auth token.
valid_at timestamp Atgriezt tikai tokenus, kas ir derīgi (nav beidzies derīguma termiņš) norādītajā datumā un laikā.
expired_at timestamp Atgriezt tikai tokenus, kuriem ir beidzies derīguma termiņš (nav derīgi) norādītajā datumā un laikā.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: tokenid, name, lastaccess, status, expires_at, created_at.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • iegūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Iegūt tokenu

Iegūt visus datus par tokenu ar ID "2".

Pieprasījums:

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

Atbilde:

{
    "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
}

Avots

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