kintone User APIの使い方ガイド：ユーザー情報の取得・管理を自動化しよう

1. はじめに

kintoneは、サイボウズが提供する業務アプリ作成プラットフォームです。ノーコードで業務アプリを作れるだけでなく、REST APIを使って外部サービスとの連携も可能です。

その中でも「User API」は、kintone上のユーザー情報や組織情報を取得できる便利なAPIです。

この記事では、「User API」を活用して、ユーザー情報の取得・管理を自動化する方法をご紹介します。業務効率化のヒントや、実際のAPI活用ユースケースまで幅広くカバーしています。

お知らせ①

🌟無料＆登録不要でプラグインのお試しが可能！🌟

kintoneユーザーの皆さん！

エムザスのkintoneプラグインはもう試しましたか？🤔
エムザスでは以下のようなプラグインを開発しています！👇

EMレポ - レコードの内容をPDF / Excelに出力できるプラグイン

EMsheet - kintoneのレコードをExcelのように表示して編集できるプラグイン

EMdocMaker - アプリの関連図や定義書を出力し、アプリの分析ができるプラグイン

       

EMログ - 標準の監査ログでは取得できないアプリの操作ログを取得できるプラグイン

   

 

 

 

 

デモ環境で、ほとんどの機能が今すぐお試しいただけます✨

＼無料 & 登録不要！／

デモ環境で今すぐプラグインを試す！

 

さらに、お客様のドメインで無料で3ヶ月間、すべての機能を試すこともできます！🎉

＼たった1分で申し込み完了！／

3ヶ月無料でフル機能お試しを申し込む！

それでは、本題に入ります！

2. kintone User APIの概要

利用できるAPIの種類

kintoneのUser APIでは、主に以下の情報が取得できます：

• ユーザー一覧
• 個別ユーザー情報
• 所属組織（部署）
• グループ情報

ユーザー管理の可視化や他システムとの連携に役立ちます。

認証方法

User APIを使うには認証が必要です。主な認証方法は以下の2つです。

• APIトークン認証（推奨）
• ベーシック認証

APIトークンはアプリ単位で発行でき、セキュリティを保ちつつ柔軟に管理できます。

公式ドキュメント

APIの詳細仕様やレスポンスフォーマットは、以下の公式ドキュメントで確認できます。

👉 kintone REST APIドキュメント – User API

3. 事前準備

APIトークンの取得方法

1. kintoneのアプリ設定画面にアクセス
2. 「APIトークン」を選択
3. 必要な権限（ユーザー情報の「閲覧」など）を付与
4. トークンを発行して控える

必要な権限

• アプリに「ユーザー管理」権限が必要
• トークンに「ユーザー情報の閲覧」権限が付与されていること

使用ツール例

APIリクエストの検証や開発には、以下のツールが便利です。

• Postman
• curl（コマンドライン）
• JavaScript（Node.jsやブラウザ）

4. User APIの基本操作

4.1 ユーザー一覧の取得

• エンドポイント：GET /v1/users.json

パラメータ例

GET https://{サブドメイン}.cybozu.com/v1/users.json?offset=0&size=100

GET https://{サブドメイン}.cybozu.com/v1/users.json?offset=0&size=100

curl 実行例

curl -X GET https://{サブドメイン}.cybozu.com/v1/users.json \
  -H "X-Cybozu-API-Token: {API_TOKEN}"

curl -X GET https://{サブドメイン}.cybozu.com/v1/users.json \
  -H "X-Cybozu-API-Token: {API_TOKEN}"

4.2 ユーザー詳細の取得

パラメータ：code（ユーザーコード）

エンドポイント：GET /v1/user.json

curl -X GET "https://{サブドメイン}.cybozu.com/v1/user.json?code=tanaka" \
  -H "X-Cybozu-API-Token: {API_TOKEN}"

curl -X GET "https://{サブドメイン}.cybozu.com/v1/user.json?code=tanaka" \
  -H "X-Cybozu-API-Token: {API_TOKEN}"

4.3 組織一覧の取得

• エンドポイント：GET /v1/organizations.json

4.4 グループ一覧の取得

• エンドポイント：GET /v1/groups.json

5. 実践ユースケース

5.1 ユーザー一覧をスプレッドシートに連携

Google Apps Script (GAS) や Node.js を使って、定期的にユーザー一覧を取得し、Google スプレッドシートに自動書き込みすることが可能です。人事部門や総務部門でのユーザー一覧管理に最適です。

5.2 部署ごとに分類して可視化

取得したユーザー情報と組織情報を突き合わせることで、部署別のユーザー構成を一覧表示できます。Power BI や Google データポータルを使えば、視覚的に管理することもできます。

5.3 退職者や未使用ユーザーの抽出

定期的にAPIで取得したユーザーリストと、勤怠システムや社内アクティビティと突き合わせることで、休眠アカウントや不要なユーザーの洗い出しが可能です。

6. 注意点とベストプラクティス

• APIトークンは厳重に管理：GitHubなどに公開しない
• ユーザー情報は読み取り専用：User APIでは更新・削除は不可
• リクエスト制限（Rate Limit）：過剰なアクセスを避ける

7. まとめ

kintoneのUser APIを活用することで、ユーザー情報の管理が自動化され、日々の運用負担を大幅に軽減できます。APIは読み取り専用ですが、情報の「見える化」や「可視化連携」にとって非常に強力なツールです。

ブログの一覧ページへ