Documentation
Table of Contents
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 | string/array | Renvoie uniquement les jetons avec les ID donnés. |
| userids | string/array | Renvoie uniquement les jetons créés pour les utilisateurs donnés. |
| token | string | Renvoie uniquement les jetons créés pour le jeton d'authentification donné. |
| valid_at | timestamp | Renvoie uniquement les jetons valides (non expirés) à la date et à l'heure données. |
| expired_at | timestamp | Renvoie uniquement les jetons qui ont expiré (non valides) à la date et à l'heure données. |
| sortfield | string/array | Trie le résultat selon les propriétés données. Les valeurs possibles sont : tokenid, name, lastaccess, status, expires_at et created_at. |
| countOutput | boolean | Ces paramètres communs à toutes les méthodes get sont décrits en détail dans la page de commentaire de référence. |
| editable | boolean | |
| 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
countOutputa été utilisé.
Exemples
Récupération d'un token
Récupérez toutes les données du token avec l'ID "2".
Requête :
{ "jsonrpc": "2.0", "method": "token.get", "params": { "output": "extend", "tokenids": "2" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "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.