token.get

Description

integer/array token.get(object parameters)

La méthode permet de récupérer des jetons en fonction des paramètres donnés.

Seul le type d'utilisateur Super admin est autorisé à afficher les jetons des autres utilisateurs.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
tokenids ID/array Retourner uniquement les jetons avec les ID donnés.
userids ID/array Retourner uniquement les jetons créés pour les utilisateurs donnés.
token string Retourner uniquement les jetons créés pour le jeton d’authentification donné.
valid_at timestamp Retourner uniquement les jetons qui sont valides (non expirés) à la date et à l’heure données.
expired_at timestamp Retourner uniquement les jetons qui sont expirés (non valides) à la date et à l’heure données.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : tokenid, name, lastaccess, status, expires_at, created_at.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs retournées

(integer/array) Retourne soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupérer un jeton

Récupérez toutes les données du jeton avec l’ID « 2 ».

Requête :

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

Réponse :

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

Source

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