{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/Group--Full", "title": "Group (Full)", "type": "object", "x-box-resource-id": "group--full", "x-box-variant": "full", "description": "Groups contain a set of users, and can be used in place of\nusers in some operations, such as collaborations.", "allOf": [ { "$ref": "#/components/schemas/Group" }, { "properties": { "provenance": { "type": "string", "description": "Keeps track of which external source this group is\ncoming from (e.g. \"Active Directory\", \"Google Groups\",\n\"Facebook Groups\"). Setting this will\nalso prevent Box users from editing the group name\nand its members directly via the Box web application.\nThis is desirable for one-way syncing of groups.", "maxLength": 255, "example": "Active Directory" }, "external_sync_identifier": { "type": "string", "description": "An arbitrary identifier that can be used by\nexternal group sync tools to link this Box Group to\nan external group. Example values of this field\ncould be an Active Directory Object ID or a Google\nGroup ID. We recommend you use of this field in\norder to avoid issues when group names are updated in\neither Box or external systems.", "example": "AD:123456" }, "description": { "type": "string", "description": "Human readable description of the group.", "maxLength": 255, "example": "Support Group - as imported from Active Directory" }, "invitability_level": { "type": "string", "example": "admins_only", "description": "Specifies who can invite the group to collaborate\non items.\n\nWhen set to `admins_only` the enterprise admin, co-admins,\nand the group's admin can invite the group.\n\nWhen set to `admins_and_members` all the admins listed\nabove and group members can invite the group.\n\nWhen set to `all_managed_users` all managed users in the\nenterprise can invite the group.", "enum": [ "admins_only", "admins_and_members", "all_managed_users" ] }, "member_viewability_level": { "type": "string", "example": "admins_only", "description": "Specifies who can view the members of the group\n(Get Memberships for Group).\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n enterprise", "enum": [ "admins_only", "admins_and_members", "all_managed_users" ] }, "permissions": { "allOf": [ { "type": "object", "description": "The permissions that the authenticated user has for a group.", "properties": { "can_invite_as_collaborator": { "type": "boolean", "description": "Specifies if the user can invite the group to collaborate on any items.", "example": true } } }, { "description": "Describes the permissions that the current user has\nfor this group." } ] } } } ] }