[comment]: # translation:outdated

[comment]: # ({d632e1b8-d632e1b8})
# token.get

[comment]: # ({/d632e1b8-d632e1b8})

[comment]: # ({980bb7e6-980bb7e6})
### 説明

`integer/array token.get(object parameters)`

このメソッドでは、指定されたパラメーターに従ってトークンを取得できます。

::: noteclassic
*Super admin*ユーザータイプのみが他のユーザーのトークンを表示できます。
:::

[comment]: # ({/980bb7e6-980bb7e6})

[comment]: # ({1ecf5a88-cc094e72})
### パラメータ

`(object)` 目的の出力を定義するパラメーター

このメソッドは、次のパラメーターをサポートします

|パラメータ|[タイプ](/manual/api/reference_commentary#data_types)|説明|
|--|--|------|
|tokenids|string/array|指定されたIDのトークンのみを返します|
|userids|string/array|指定されたユーザー用に作成されたトークンのみを返します|
|token|string|指定された*Authトークン*用に作成されたトークンのみを返します。|
|valid\_at|timestamp|指定された日時に有効な（有効期限が切れていない）トークンのみを返します。|
|expired\_at|timestamp|指定された日時に無効な（期限切れになった）トークンのみを返します。|
|sortfield|string/array|指定されたプロパティで結果を並べ替えます<br><br>指定可能な値は`tokenid`,` name`,`lastaccess`,` status`,`expires_at`および`created_at`です。|
|countOutput|boolean|すべての`get`メソッドに共通するこれらのパラメーターについては[リファレンス解説](/manual/api/reference_commentary#common_get_method_parameters)ページで詳しく説明されています。|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/1ecf5a88-cc094e72})

[comment]: # ({7223bab1-7223bab1})
### 戻り値

`(integer/array)` 次のいずれかを返します:

-   オブジェクトの配列
-   `countOutput`パラメータが使用されている場合、取得されたオブジェクトの数

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### 例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({7668ba08-66760f5f})
#### トークンを取得する

ID"2"のトークンのデータをすべて取得します。

Request:

```json
{
    "jsonrpc": "2.0",
    "method": "token.get",
    "params": {
        "output": "extend",
        "tokenids": "2"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

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

[comment]: # ({/7668ba08-66760f5f})

[comment]: # ({5cf2ab45-5cf2ab45})
### ソース

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

[comment]: # ({/5cf2ab45-5cf2ab45})