組織の一覧取得（クエリで条件を指定）
Garoonの組織の一覧をクエリで条件を指定して取得できます。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/base/organizations
パッケージ版（Windows環境）
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/base/organizations
パッケージ版（Linux環境）
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/base/organizations
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
必要なアクセス権
なし
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| limit | 数値 |
省略可 |
取得する組織の制限数を指定します。 要求パラメータで指定された条件に一致する組織がさらにある場合でも、組織数は指定した値より少なくなる可能性があります。 デフォルト値：100 |
| offset | 数値 | 省略可 |
取得する組織の先頭からスキップする数を指定します。 |
| name | 文字列 | 省略可 | 組織名を指定します。 |
リクエストの例
GET /g/api/v1/base/organizations HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
レスポンスの例
処理が成功すると、リクエストパラメータで指定された条件で、組織の内容がJSON形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| organizations[].id | 数値 |
組織ID |
| organizations[].name | 文字列 |
組織名 |
| organizations[].code | 文字列 | 組織コード |
| organizations[].parentOrganization | 文字列 | 親組織ID |
| organizations[].childOrganizations.id | 数値 | 子組織ID |
組織に所属するユーザーの一覧取得（クエリで条件を指定）
指定された組織に属するユーザーの一覧をクエリで条件を指定して取得できます。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).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
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
必要なアクセス権
なし
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| id | 数値 | 必須 | 組織IDを指定します。 |
| limit | 数値 |
省略可 |
取得するユーザーの制限数を指定します。 要求パラメータで指定された条件に一致するユーザーがさらにある場合でも、ユーザー数は指定した値より少なくなる可能性があります。 デフォルト値：100 |
| offset | 数値 | 省略可 |
取得するユーザーの先頭からスキップする数を指定します。 |
リクエストの例
GET /g/api/v1/base/organizations/1/users HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
レスポンスの例
処理が成功すると、リクエストパラメータで指定された条件で、ユーザーの内容がJSON形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| id | 数値 |
GaroonユーザーID |
| name | 文字列 |
Garoonユーザーの表示名 |
| code | 文字列 |
Garoonユーザーのログイン名 |
制限事項
共通仕様の制限事項 をご確認ください。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。