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

環境

クラウド版

https://sample.cybozu.com/g/api/v1/base/users

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

• IP_ADDRESS_OR_HOST_NAME：Garoonのインストール先のIPアドレスまたはホスト名
• INSTALL_IDENTIFER：Garoonのインストール識別子

Windows環境

http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/base/users

Linux環境

http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/base/users

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	配列	Garoonのユーザー情報の一覧 並び順はusers[].idの昇順です。
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);