Group

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

This type extends Metadata and inherits its fields.

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

Introduced in API version 24.0.

As of Spring ’20 and later, only authenticated internal and external users can access this type.

• Type: string
• Required: No
• Introduced: API version 62.0
• Description: The description for the group.

• Type: boolean
• Required: No
• Introduced: API version 18.0
• Description: Required. Indicates whether records shared with users in this group are also shared with users higher in the role hierarchy (true) or not (false). This field corresponds to the Grant Access Using Hierarchies checkbox on the group’s detail page.

• Type: string
• Required: No
• Description: 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.

• Type: string
• Required: Yes
• Description: Required. The name of the group. Corresponds to Label in the user interface.

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>

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.