Index
ユーザーの一覧取得（クエリで条件を指定）
Garoonユーザーの一覧をクエリで条件を指定して取得できます。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/base/users
パッケージ版（Windows環境）
以下は、ヘルプに記載している Windows のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/base/users
パッケージ版（Linux環境）
以下は、ヘルプに記載している Linux のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/base/users
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
必要なアクセス権
なし
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| limit | 数値 |
省略可 |
取得するユーザーの制限数を指定します。 要求パラメータで指定された条件に一致するユーザーがさらにある場合でも、ユーザー数は指定した値より少なくなる可能性があります。 デフォルト値 ：100 |
| offset | 数値 | 省略可 |
取得するユーザーの先頭からスキップする数を指定します。 |
| name | 文字列 | 省略可 |
ユーザー検索の名前を指定します。
|
リクエストの例
GET /g/api/v1/base/users HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
レスポンスの例
処理が成功すると、リクエストパラメータで指定された条件で、ユーザーの内容がJSON形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| users[].id | 数値 |
GaroonユーザーID |
| users[].name | 文字列 |
Garoonユーザーの表示名 |
| users[].code | 文字列 |
Garoonユーザーのログイン名 |
| hasNext | 真偽値 |
次のユーザー情報がある場合は true を返します。 |
JavaScript サンプル
XMLHttpRequest
制限事項
共通仕様の制限事項 をご確認ください。
お世話になっております。
ユーザー情報の取得でEmailアドレスは取得可能になる予定はありますでしょうか？
スケジュールの登録の際のイベントで、リマインドメールを送信したいと考えております。
お世話になります。
パッケージ版ガルーンにてユーザーAPIを実行時に、
クラウド版ガルーンでは取得できる「customItemValues」が取得できません。
こちらについては仕様になりますでしょうか。
masahiro.kokubo 様
お世話になっております。cybozu developer network 運営局です。
「ユーザーAPI」とは、本記事「ユーザーの取得」の API ではなく、User API を指しておりますでしょうか。
https://developer.cybozu.io/hc/ja/articles/205309740
User API で取得できる「customItemValues」は、cybozu.com 共通管理の「カスタマイズ項目」の値です。
https://jp.cybozu.help/general/ja/admin/list_useradmin/list_user/profile/custom_fields/feature.html
パッケージ版Garoon には「カスタマイズ項目」を設定できないので、「customItemValues」を取得することもできません。
お手数ですが、ご確認のほどよろしくお願いいたします。
cybozu developer network 運営局 様
お世話になっております、小久保です。
ご返信誠にありがとうございます、内容確認させて頂きました。
UserAPIとGaroonAPIそれぞれ別のものでしたね、誤認しておりました。
確かにパッケージ版ガルーンではCybozu共通設定の画面はありません。
パッケージ版ガルーンですと[ユーザー情報の項目]画面で(システム管理（基本システム） > ユーザー > ユーザー情報の項目)
(ttp://localhost/scripts/cbgrn/grn.exe/system/user/user_column_list?)
ユーザーのプロフィールに表示する事のできる項目をカスタマイズできますが
こちらに追加した項目を、APIで取得するという手段は無いという理解でよろしいでしょうか？
masahiro.kokubo 様
お世話になっております。cybozu developer network 運営局です。
小久保様のご認識の通り、
追加したユーザー情報の項目を API で取得することはできません。
本記事の API で取得できるのは、次の値となります。
・ユーザーID
・表示名
・ログイン名
お力になれず申し訳ありませんが、ご確認のほどよろしくお願いいたします。
cybozu developer network 運営局 様
お世話になります、小久保です。
本件について現時点の仕様は承知しました。
今後のアップデートで実装されたら嬉しい内容です。
ご丁寧にありがとうございました。