<h2 id="%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" data-line="0" class="code-line">
<a class="header-anchor-link" href="#%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" aria-hidden="true"></a> はじめに</h2>
この記事は <a href="https://qiita.com/advent-calendar/2024/trocco" target="_blank" rel="nofollow noopener noreferrer">TROCCO® Advent Calendar 2024</a>の4日目の記事です。
TROCCOでは、お客様のデータ基盤を中長期で運用する際の課題を解決するべく、直近APIの拡充を進めています。 
また、一部のリソースについて、<a href="https://registry.terraform.io/providers/trocco-io/trocco/latest/docs" target="_blank" rel="nofollow noopener noreferrer">Terraform Provider</a>を提供し、TROCCOのリソースをTerraformで管理できるように目下開発を進めています。
この記事では、その中で開発された<a href="https://documents.trocco.io/apidocs/get-users" target="_blank" rel="nofollow noopener noreferrer">TROCCO ユーザーAPI</a>を利用したちょっとした便利tipsとして、TROCCOユーザーの棚卸しを実施してみましょう。
<h2 id="%E5%85%B7%E4%BD%93%E7%9A%84%E3%81%AA%E3%82%84%E3%82%8A%E6%96%B9" data-line="9" class="code-line">
<a class="header-anchor-link" href="#%E5%85%B7%E4%BD%93%E7%9A%84%E3%81%AA%E3%82%84%E3%82%8A%E6%96%B9" aria-hidden="true"></a> 具体的なやり方</h2>
<h3 id="step1%3A-trocco-api-key%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B" data-line="11" class="code-line">
<a class="header-anchor-link" href="#step1%3A-trocco-api-key%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B" aria-hidden="true"></a> STEP1: TROCCO API Keyを取得する</h3>
<aside class="msg message">!<div class="msg-content">
TROCCO API機能の利用にはAdvanced plan、または Professional planのご契約が必要です
</div></aside>
TROCCO API keyの取得方法については公式ドキュメントに記載がありますので、そちらを見ながら取得してください。 
<iframe id="zenn-embedded__4b1513ca80f3d" src="https://embed.zenn.studio/card#zenn-embedded__4b1513ca80f3d" data-content="https%3A%2F%2Fdocuments.trocco.io%2Fapidocs%2Foverview%23trocco-api-key%25E3%2581%25AE%25E4%25BD%259C%25E6%2588%2590" frameborder="0" scrolling="no" loading="lazy"></iframe><a href="https://documents.trocco.io/apidocs/overview#trocco-api-key%E3%81%AE%E4%BD%9C%E6%88%90" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://documents.trocco.io/apidocs/overview#trocco-api-keyの作成</a>
<h3 id="step2%3A-api%E3%81%8B%E3%82%89%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E4%B8%80%E8%A6%A7%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B" data-line="23" class="code-line">
<a class="header-anchor-link" href="#step2%3A-api%E3%81%8B%E3%82%89%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E4%B8%80%E8%A6%A7%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B" aria-hidden="true"></a> STEP2: APIからユーザー一覧を取得する</h3>
今回はPythonで取得します。 
筆者はColaboratory上にコードを実行しました。
<div class="code-block-container">
<div class="code-block-filename-container">ユーザー一覧を取得する</div>
<pre class="language-py"><code class="language-py code-line" data-line="28">import requests

TROCCO_HOST = "https://trocco.io"
TROCCO_USERS_ENDPOINT = "/api/users"

TROCCO_API_KEY = "" # https://trocco.io/api_keys から取得できるAPI keyに置換する

header_content = {
 'accept': "application/json",
 'Authorization': f"Token {TROCCO_API_KEY}" # tips: 先頭に `Token ` という固定値をつける必要がある
}

# APIからデータ取得
res = requests.get(TROCCO_HOST + TROCCO_USERS_ENDPOINT, headers=header_content)
print(res.status_code) # 200が返ってきたら後続の作業を実施する
</code></pre>
</div><h3 id="step3%3A-pandas-dataframe%E3%81%AB%E6%95%B4%E5%BD%A2%E3%81%97%E3%80%81%E6%9C%80%E8%BF%91%E3%83%AD%E3%82%B0%E3%82%A4%E3%83%B3%E3%81%97%E3%81%A6%E3%81%84%E3%81%AA%E3%81%84%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E3%82%92%E6%8A%BD%E5%87%BA%E3%81%99%E3%82%8B" data-line="47" class="code-line">
<a class="header-anchor-link" href="#step3%3A-pandas-dataframe%E3%81%AB%E6%95%B4%E5%BD%A2%E3%81%97%E3%80%81%E6%9C%80%E8%BF%91%E3%83%AD%E3%82%B0%E3%82%A4%E3%83%B3%E3%81%97%E3%81%A6%E3%81%84%E3%81%AA%E3%81%84%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E3%82%92%E6%8A%BD%E5%87%BA%E3%81%99%E3%82%8B" aria-hidden="true"></a> STEP3: pandas DataFrameに整形し、最近ログインしていないユーザーを抽出する</h3>
次にデータを整形していきます。まずJSONから取得したタイムスタンプのデータをpandasのdatetime型に変換しましょう。
<div class="code-block-container">
<div class="code-block-filename-container">データ整形</div>
<pre class="language-py"><code class="language-py code-line" data-line="51">TIMESTAMP_COLUMNS = ["last_sign_in_at", "created_at", "updated_at"]

# pandas DataFrameに変換
users_df = pd.DataFrame.from_dict(res.json()["items"])

# timestampカラムをdatetime型に変換
for col in TIMESTAMP_COLUMNS:
 users_df[col] = pd.to_datetime(users_df[col])
</code></pre>
</div>さっそく整形されたデータを確認しましょう
<div class="code-block-container">
<div class="code-block-filename-container">スキーマとデータを確認</div>
<pre class="language-py"><code class="language-py code-line" data-line="64">display(users_df.dtypes)
users_df.head()
</code></pre>
</div><img src="https://storage.googleapis.com/zenn-user-upload/6f6a16ae6281-20241129.png" alt="作成されたデータフレーム" loading="lazy" class="md-img">
最終ログインが昨年時点のユーザー一覧を抽出しましょう。
<div class="code-block-container">
<div class="code-block-filename-container">最終ログインが昨年以前のユーザー一覧 ※最終ログイン日昇順</div>
<pre class="language-py"><code class="language-py code-line" data-line="73">users_df[users_df["last_sign_in_at"] &lt; '2024-01-01'].sort_values("last_sign_in_at")
</code></pre>
</div>もし対象者が最近TROCCOを使っておらず、今後も使う予定がなさそうなユーザーが見つかったらアカウント特権管理者に依頼して削除してもらいましょう。 
削除の方法は以下から確認ください。
<iframe id="zenn-embedded__f6efd7cdf48b6" src="https://embed.zenn.studio/card#zenn-embedded__f6efd7cdf48b6" data-content="https%3A%2F%2Fdocuments.trocco.io%2Fdocs%2Fuser-deletion" frameborder="0" scrolling="no" loading="lazy"></iframe><a href="https://documents.trocco.io/docs/user-deletion" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://documents.trocco.io/docs/user-deletion</a>
他にも最終ログイン日時を半年以内を絞ったり、作成が古いユーザーを目検していっても良いかもしれません。 
TROCCOの大掃除も済ませて良い年を迎えましょう!
<h3 id="%E5%88%A9%E7%94%A8%E3%81%97%E3%81%9F%E3%82%B3%E3%83%BC%E3%83%89" data-line="86" class="code-line">
<a class="header-anchor-link" href="#%E5%88%A9%E7%94%A8%E3%81%97%E3%81%9F%E3%82%B3%E3%83%BC%E3%83%89" aria-hidden="true"></a> 利用したコード</h3>
全体の流れは以下のgistにて公開しています。
<iframe id="zenn-embedded__7e18ad87c46e8" src="https://embed.zenn.studio/gist#zenn-embedded__7e18ad87c46e8" data-content="https%3A%2F%2Fgist.github.com%2Fpaulxll%2F3b4566ec6d55d1cf17f9370324401b90" frameborder="0" scrolling="no" loading="lazy"></iframe>
「Open in Colab」ボタンから環境構築不要で実行できるので※、ぜひ試してみてください! 
※TROCCOにIP制限をかけていない場合に限ります。IP制限をかけている場合、許可済みIPアドレスからTROCCOにアクセスできる環境にて実行ください。
<h2 id="%E5%8F%82%E8%80%83" data-line="96" class="code-line">
<a class="header-anchor-link" href="#%E5%8F%82%E8%80%83" aria-hidden="true"></a> 参考</h2>
<ul data-line="98" class="code-line">
<li data-line="98" class="code-line"><a href="https://documents.trocco.io/apidocs/overview" target="_blank" rel="nofollow noopener noreferrer">TROCCO API リファレンス</a></li>
<li data-line="99" class="code-line"><a href="https://qiita.com/advent-calendar/2024/trocco" target="_blank" rel="nofollow noopener noreferrer">TROCCO Advent calendar 2024</a></li>
</ul>

年末だしTROCCO APIを活用してTROCCOユーザーの棚卸しをしよう!

STEP2: APIからユーザー一覧を取得する

STEP3: pandas DataFrameに整形し、最近ログインしていないユーザーを抽出する

Discussion