> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Groups リソース
企業内に作成されたグループ。
## Group
任意のグループAPIエンドポイントからデフォルトで返されるグループのStandard版の表示。
| プロパティ | 型 | 必須 | 説明 |
| ------------- | -------------- | --- | --------------------------------------------------------- |
| `id` | `string` | はい | このオブジェクトの一意の識別子。 |
| `type` | `enum` | はい | 値は常に`group`になります。 使用可能なオプション: `group`. |
| `name` | `string` | いいえ | グループの名前。 |
| `group_type` | `enum` | いいえ | グループのタイプ。 使用可能なオプション: `managed_group`, `all_users_group`. |
| `created_at` | `string` | いいえ | グループオブジェクトが作成された日時。 |
| `modified_at` | `string` | いいえ | グループオブジェクトが最後に変更された日時。 |
```json 例 theme={null}
{
"id": "11446498",
"type": "group",
"name": "Support",
"group_type": "managed_group",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
```
## Groups
グループのリスト。
| プロパティ | 型 | 必須 | 説明 |
| ------------- | ------------------------------ | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `total_count` | `integer` | いいえ | コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
| `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 |
| `offset` | `integer` | いいえ | このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
| `order` | array of `object` | いいえ | 項目が返される順序。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
| `entries` | array of [グループ (Full)](#-full) | いいえ | グループのリスト。 |
```json 例 theme={null}
{
"total_count": 5000,
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"entries": [
{
"id": "11446498",
"type": "group",
"name": "Support",
"group_type": "managed_group",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"provenance": "Active Directory",
"external_sync_identifier": "AD:123456",
"description": "Support Group - as imported from Active Directory",
"invitability_level": "admins_only",
"member_viewability_level": "admins_only",
"permissions": {
"can_invite_as_collaborator": true
}
}
]
}
```
## グループ (Base)
グループのBase版の表示。
| プロパティ | 型 | 必須 | 説明 |
| ------ | -------------- | -- | -------------------------------------- |
| `id` | `string` | はい | このオブジェクトの一意の識別子。 |
| `type` | `enum` | はい | 値は常に`group`になります。 使用可能なオプション: `group`. |
```json 例 theme={null}
{
"id": "11446498",
"type": "group"
}
```
## グループ (Full)
グループは複数のユーザーを含み、グループを使用するとコラボレーションなどの一部の操作をユーザーの代わりに実行できます。
| プロパティ | 型 | 必須 | 説明 |
| -------------------------- | -------------- | --- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `string` | はい | このオブジェクトの一意の識別子。 |
| `type` | `enum` | はい | 値は常に`group`になります。 使用可能なオプション: `group`. |
| `name` | `string` | いいえ | グループの名前。 |
| `group_type` | `enum` | いいえ | グループのタイプ。 使用可能なオプション: `managed_group`, `all_users_group`. |
| `created_at` | `string` | いいえ | グループオブジェクトが作成された日時。 |
| `modified_at` | `string` | いいえ | グループオブジェクトが最後に変更された日時。 |
| `provenance` | `string` | いいえ | このグループの元になっている外部ソース ("Active Directory"、"Google Groups"、"Facebook Groups"など) を追跡します。また、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。 |
| `external_sync_identifier` | `string` | いいえ | このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。このフィールドの値には、Active DirectoryオブジェクトIDやGoogleグループIDなどを使用できます。Boxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。 |
| `description` | `string` | いいえ | グループについての人間が判読できる説明。 |
| `invitability_level` | `enum` | いいえ | 項目でのコラボレーションにグループを招待できるユーザーを指定します。 `admins_only`に設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。 `admins_and_members`に設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。 `all_managed_users`に設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。 使用可能なオプション: `admins_only`, `admins_and_members`, `all_managed_users`. |
| `member_viewability_level` | `enum` | いいえ | グループのメンバーを表示できるユーザーを指定します (グループのメンバーを取得)。 - `admins_only` - 企業の管理者、共同管理者、グループのグループ管理者。 - `admins_and_members` - すべての管理者とグループメンバー。 - `all_managed_users` - 企業のすべての管理対象ユーザー。 使用可能なオプション: `admins_only`, `admins_and_members`, `all_managed_users`. |
| `permissions` | `object` | いいえ | グループに対して認証済みユーザーが持っている権限。 |
```json 例 theme={null}
{
"id": "11446498",
"type": "group",
"name": "Support",
"group_type": "managed_group",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"provenance": "Active Directory",
"external_sync_identifier": "AD:123456",
"description": "Support Group - as imported from Active Directory",
"invitability_level": "admins_only",
"member_viewability_level": "admins_only",
"permissions": {
"can_invite_as_collaborator": true
}
}
```
## グループ (Mini)
グループのIDや名前を含むグループのMini版の表示。
| プロパティ | 型 | 必須 | 説明 |
| ------------ | -------------- | --- | --------------------------------------------------------- |
| `id` | `string` | はい | このオブジェクトの一意の識別子。 |
| `type` | `enum` | はい | 値は常に`group`になります。 使用可能なオプション: `group`. |
| `name` | `string` | いいえ | グループの名前。 |
| `group_type` | `enum` | いいえ | グループのタイプ。 使用可能なオプション: `managed_group`, `all_users_group`. |
```json 例 theme={null}
{
"id": "11446498",
"type": "group",
"name": "Support",
"group_type": "managed_group"
}
```