Group

Represents a set of public groups, which can have users, roles, and other groups.

Declarative Metadata File Suffix and Directory Location

The file suffix for group components is .group and components are stored in the groups directory of the corresponding package directory.

Version

Group components are available in API version 24.0 and later.

Fields

Members of the public group are not migrated when you deploy the group type.

Note

This metadata type represents the valid values that define a group:

Field Name	Field Type	Description
doesIncludeBosses	boolean	Indicates whether the managers have access (`true`) or do not have access (`false`) to records shared with members of the group. This field is only available for public groups.
fullName	string	The unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the Metadata component. Corresponds to Group Name in the user interface.
name	string	Required. The name of the group. Corresponds to Label in the user interface.

Declarative Metadata Sample Definition

The following is the definition of a group.

1<?xml version="1.0" encoding="UTF-8"?>
2<Group xmlns="http://soap.sforce.com/2006/04/metadata">
3    <doesIncludeBosses>true</doesIncludeBosses>
4    <fullName>admin</fullName>
5    <name>test</name>
6</Group>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide