グループ (Full) - Box Dev Docs

APIバージョン 2024.0 グループは複数のユーザーを含み、グループを使用するとコラボレーションなどの一部の操作をユーザーの代わりに実行できます。

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。

string

例 11446498このオブジェクトの一意の識別子。

type

string

例 group値は常にgroupになります。次の値に固定: group

created_at

string(date-time)

例 2012-12-12T10:53:43-08:00グループオブジェクトが作成された日時。

description

string

例 Support Group - as imported from Active Directoryグループについての人間が判読できる説明。

external_sync_identifier

string

例 AD:123456このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。このフィールドの値には、Active DirectoryオブジェクトIDやGoogleグループIDなどを使用できます。Boxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。

group_type

string

例 managed_groupグループのタイプ。次の値のいずれか1つ: managed_group,all_users_group

invitability_level

string

例 admins_only項目でのコラボレーションにグループを招待できるユーザーを指定します。admins_onlyに設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。admins_and_membersに設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。all_managed_usersに設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。次の値のいずれか1つ: admins_only,admins_and_members,all_managed_users

member_viewability_level

string

例 admins_onlyグループのメンバーを表示できるユーザーを指定します (グループのメンバーを取得)。

admins_only - 企業の管理者、共同管理者、グループのグループ管理者。
admins_and_members - すべての管理者とグループメンバー。
all_managed_users - 企業のすべての管理対象ユーザー。

次の値のいずれか1つ: admins_only,admins_and_members,all_managed_users

modified_at

string(date-time)

例 2012-12-12T10:53:43-08:00グループオブジェクトが最後に変更された日時。

name

string

例 Supportグループの名前。

permissions

object

このグループに対して現在のユーザーが持っている権限について説明します。

表示子属性

can_invite_as_collaborator

boolean

例 trueユーザーが項目でのコラボレーションにグループを招待できるかどうかを指定します。

provenance

string

例 Active Directoryこのグループの元になっている外部ソース (“Active Directory”、“Google Groups”、“Facebook Groups”など) を追跡します。また、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。

{
  "id": "11446498",
  "type": "group",
  "created_at": "2012-12-12T10:53:43-08:00",
  "description": "Support Group - as imported from Active Directory",
  "external_sync_identifier": "AD:123456",
  "group_type": "managed_group",
  "invitability_level": "admins_only",
  "member_viewability_level": "admins_only",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "name": "Support",
  "permissions": {
    "can_invite_as_collaborator": true
  },
  "provenance": "Active Directory"
}