Group (Full)

Groups contain a set of users, and can be used in place of users in some operations, such as collaborations.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.

id string

example"11446498"

The unique identifier for this object

type string

example"group"

group

Value is always group

created_at string / date-time

example"2012-12-12T10:53:43-08:00"

When the group object was created

description string

example"Support Group - as imported from Active Directory"max length255

Human readable description of the group.

external_sync_identifier string

example"AD:123456"

An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an Active Directory Object ID or a Google Group ID. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.

group_type string

example"managed_group"

The type of the group.

Value is one of managed_group,all_users_group

invitability_level string

example"admins_only"

Specifies who can invite the group to collaborate on items.

When set to admins_only the enterprise admin, co-admins, and the group's admin can invite the group.

When set to admins_and_members all the admins listed above and group members can invite the group.

When set to all_managed_users all managed users in the enterprise can invite the group.

Value is one of admins_only,admins_and_members,all_managed_users

member_viewability_level string

example"admins_only"

Specifies who can view the members of the group (Get Memberships for Group).

admins_only - the enterprise admin, co-admins, group's group admin
admins_and_members - all admins and group members
all_managed_users - all managed users in the enterprise

Value is one of admins_only,admins_and_members,all_managed_users

modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

When the group object was last modified

name string

example"Support"

The name of the group

permissions object

Describes the permissions that the current user has for this group.

permissions.can_invite_as_collaborator boolean

exampletrue

Specifies if the user can invite the group to collaborate on any items.

provenance string

example"Active Directory"max length255

Keeps track of which external source this group is coming from (e.g. "Active Directory", "Google Groups", "Facebook Groups"). Setting this will also prevent Box users from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.

Response Example

{
  "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"
}