ユーザーの取得（GET）

ユーザーの一覧取得（クエリで条件を指定）

Garoonユーザーの一覧をクエリで条件を指定して取得できます。

HTTP メソッド

GET

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/base/users

パッケージ版（Windows環境）

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/base/users

パッケージ版（Linux環境）

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/base/users

使用可能なガルーンのバージョン

• クラウド版 Garoon
• パッケージ版 Garoon バージョン 5.0.0以降

必要なアクセス権

なし

リクエストパラメータ

パラメータ名	指定する値	必須	説明
limit	数値	省略可	取得するユーザーの制限数を指定します。 要求パラメータで指定された条件に一致するユーザーがさらにある場合でも、ユーザー数は指定した値より少なくなる可能性があります。 使用できる値は1〜1000です。 デフォルト値：100
offset	数値	省略可	取得するユーザーの先頭からスキップする数を指定します。 指定できる数値は0から無制限です。
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ユーザーのログイン名

制限事項

共通仕様の制限事項 をご確認ください。