Documentation
token.get
説明
integer/array token.get(object parameters)
このメソッドでは、指定されたパラメーターに従ってトークンを取得できます。
Super adminユーザータイプのみが他のユーザーのトークンを表示できます。
パラメーター
(object) 目的の出力を定義するパラメーター。
このメソッドは、次のパラメーターをサポートします。
| パラメーター | タイプ | 説明 |
|---|---|---|
| tokenids | ID/array | 指定されたIDのトークンのみを返します。 |
| userids | ID/array | 指定されたユーザー用に作成されたトークンのみを返します。 |
| token | string | 指定されたAuthトークン用に作成されたトークンのみを返します。 |
| 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() in ui/include/classes/api/services/CToken.php.