Garoon APIドキュメント

組織に所属するユーザーの一覧を取得する

目次

組織に所属するユーザーの一覧を取得する

固定リンクがコピーされました

指定された組織に属するユーザーの一覧を取得します。

URL

固定リンクがコピーされました

クラウド版

https://sample.cybozu.com/g/api/v1/base/organizations/ORGANIZATION_ID/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/organizations/ORGANIZATION_ID/users
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/base/organizations/ORGANIZATION_ID/users
パスパラメーター
パラメーター名 説明
ORGANIZATION_ID ユーザーが所属する組織ID

HTTPメソッド

固定リンクがコピーされました

GET

利用できるバージョン

固定リンクがコピーされました

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

必要なアクセス権

固定リンクがコピーされました

なし

リクエスト

固定リンクがコピーされました

パラメーター

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

パラメーター名 型 必須 説明
limit 数値 省略可 取得するユーザーの件数
1から1,000まで指定できます。省略すると100が設定されます。
指定された条件に一致するユーザーがさらにある場合でも、指定した値より取得できるユーザーの数は少なくなる可能性があります。
offset 数値 省略可 取得するユーザーの先頭からスキップする数
省略すると、0が設定されます。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/base/organizations/1/users?limit=30

ヘッダー
1
2
3

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

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

ボディ
1
2
3

{
  "limit": 30
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
users 配列 指定した組織に所属するGaroonのユーザー情報の一覧
並び順はusers[].idの昇順です。
users[].id 数値 GaroonユーザーID
users[].name 文字列 Garoonユーザーの表示名
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/organizations/1/users?limit=30' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
1
2
3
4
5

const body = {
  limit: 30
};

await garoon.api('/api/v1/base/organizations/1/users', 'GET', body);