組織に所属するユーザーの一覧を取得する
組織に所属するユーザーの一覧を取得する
指定された組織に属するユーザーの一覧を取得します。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/base/organizations/組織 ID
/users
パッケージ版
- Windows 環境
- http://
サーバーの IP アドレスまたはホスト名
/scripts/インストール識別子
/grn.exe/api/v1/base/organizations/組織 ID
/users - Linux 環境
- http://
サーバーの IP アドレスまたはホスト名
/cgi-bin/インストール識別子
/grn.cgi/api/v1/base/organizations/組織 ID
/users
パスパラメーター
パラメーター名 | 説明 |
---|---|
組織 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
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
id | 数値 | Garoon のユーザー ID |
name | 文字列 | Garoon ユーザーの表示名 |
code | 文字列 | Garoon ユーザーのログイン名 |
hasNext | 真偽値 | 次のユーザー情報があるかどうか
|
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
Garoon REST API リクエストを送信する API を使ったリクエスト
|
|