Box開発者向けドキュメントポータル
ログイン

Group

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

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

詳細バリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPI応答で返されます。

string
11446498

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

string
group

次の値に固定: group

string
managed_group

グループのタイプ。

次の値のいずれか1つ: managed_group,all_users_group

string
Support

グループの名前

string / date-time
2012-12-12T10:53:43-08:00

グループオブジェクトが作成された日時

string / date-time
2012-12-12T10:53:43-08:00

グループオブジェクトが最後に変更された日時

string
Support Group - as imported from Active Directory255

グループについての人間が判読できる説明。

string
AD:123456

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

string
admins_only

フォルダでのコラボレーションにグループを招待できるユーザーを指定します(コラボレーションの作成)。

admins_onlyに設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。

admins_and_membersに設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。

all_managed_usersに設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。

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

string
admins_only

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

  • admins_only - 会社の管理者、共同管理者、グループのグループ管理者
  • admins_and_members - すべての管理者とグループメンバー
  • all_managed_users - 会社内のすべての管理対象ユーザー

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

string
Active Directory255

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

これはグループを一方向に同期する場合に適しています。

レスポンスの例

{
  "id": 11446498,
  "type": "group",
  "created_at": "2012-12-12T10:53:43-08:00",
  "group_type": "managed_group",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "name": "Support"
}