ユーザーの一覧を取得する

ユーザーの一覧を取得します。

URL

環境

クラウド版

https://sample.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

HTTP メソッド

GET

利用できるバージョン

• クラウド版 Garoon
• パッケージ版 Garoon 5.0 以降

必要なアクセス権

なし

リクエスト

パラメーター

リクエストパラメーターは、URL クエリパラメーターとして送信してください。
ただし、 Garoon REST API リクエストを送信する API を使って実行する場合は、リクエストボディとして指定できます。

リクエストの例

URL

https://sample.cybozu.com/g/api/v1/base/users?limit=10

ヘッダー

1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。

ボディ

1
2
3

{
  "limit": 10
}

レスポンス

プロパティ

プロパティ名	型	説明
users[].id	数値	Garoon のユーザー ID ユーザーを追加したタイミングで自動的に割り振られるGaroon 固有の ID です。 この値は、User API の ユーザーを取得する API におけるリクエストパラメーターの ids やレスポンスの user[].id の値とは異なります。 User API で取得したユーザー情報と紐付ける場合は、users[].code の値を利用してください。 詳細は、次のページを参照してください。 Garoon API と User API で取得できるユーザー情報・組織情報の違いと注意点
users[].name	文字列	ユーザーの表示名
users[].code	文字列	ユーザーのログイン名 パッケージ版 Garoon の場合、ログイン名を公開する設定が必要です。 詳細は ユーザー情報の項目を変更する を参照してください。
hasNext	真偽値	次のユーザー情報があるどうか true：次のユーザー情報がある false：次のユーザー情報がない

レスポンスの例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "users": [
    {
      "id": "1",
      "name": "User1",
      "code": "user1"
    }
  ],
  "hasNext": false
}

サンプルコード

curl を使ったリクエスト

1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/base/users?limit=10' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='

Garoon REST API リクエストを送信する API を使ったリクエスト

1
2
3
4

const body = {
  limit: 10
};
await garoon.api('/api/v1/base/users', 'GET', body);