DelegateGroup

Represents a group of users who have the same administrative privileges. These groups are different from public groups used for sharing.

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

DelegateGroup components have the suffix .delegateGroup and are stored in the delegateGroups folder. The file prefix must match the developer name of the delegate group. For example, a delegate group with a developer name of MyDelegateGroup would have a file name of MyDelegateGroup.delegateGroup.

Version

DelegateGroup components are available in API version 36.0 and later.

Special Access Rules

Only users with the “View Setup and Configuration” permission can be delegated administrators. As of Spring ’20 and later, only users with “View Setup” or “Configuration” permission can access this object.

Fields

Field Name	Field Type	Description
customObjects	string[]	The custom objects associated with the group. Delegated administrators can customize nearly every aspect of each of those custom objects, including creating a custom tab. However, they can’t create or modify relationships on the objects or set organization-wide sharing defaults. Delegated administrators must have access to custom objects to access the merge fields on those objects from formulas.
groups	string[]	The groups with users assigned by delegated administrators.
label	string	Required. The delegated group’s non-API name.
loginAccess	boolean	Required. Allows users in this group to log in as users in the role hierarchy that they administer (`true`) or not (`false`). Depending on your organization settings, individual users must grant login access to allow their administrators to log in as them.
permissionSetGroups	string[]	The permission set groups that can be assigned to users in specified roles and all subordinate roles by delegated administrators.
permissionSets	string[]	The permission sets that can be assigned to users in specified roles and all subordinate roles by delegated administrators.
profiles	string[]	The profiles that can be assigned to users by delegated administrators.
roles	string[]	The roles and subordinates for which delegated administrators of the group can create and edit users.

Declarative Metadata Sample Definition

The following is an example of a DelegateGroup component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DelegateGroup xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>MyDelegateGroup</label>
4    <loginAccess>true</loginAccess>
5    <name>MyDelegateGroup</name>
6    <profiles>Chatter Free User</profiles>
7    <profiles>Chatter Moderator User</profiles>
8    <profiles>Marketing User</profiles>
9    <permissionSetGroups>My Permission Set Group</permissionSetGroups>
10    <permissionSets>My Permset</permissionSets>
11    <roles>LesserBossMan</roles>
12</DelegateGroup>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>DelegateGroup</name>
6    </types>
7    <version>66.0</version>
8</Package>

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