Newer Version Available

This content describes an older version of this product. View Latest

UserManagementSettings

Represents a selection of user management options that appear on the User Management Settings Setup page. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

UserMangementSettings are stored in the UserManagement.settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

Manage org-wide settings for certain options. User Management Settings are available in API version 46.0 and later.

Fields

Field Field Type Description
enableContactlessExternalIdentityUsers boolean If you enable Enable Contactless External Identity Users (true), and your org has the External Identity User license, you can create contactless users. Having external identity users without contact information reduces the overhead of managing external identity users. The External Identity User license is available to customers who purchase Identity for Customers and Partners.

The default is not enabled (false). Available in API version 47.0 and later.

enableEnhancedPermsetMgmt boolean If you enable Enhanced Permission Set Component Views (true), you can work with permission sets more easily. For example, when you have large numbers of Apex class assignments for permission sets, you can enable a paginated result set, standard filtering, and sorting.
enableEnhancedProfileMgmt boolean If you enable Enhanced Profile Lists Views (true), you can quickly view, customize, and edit list data .
enableNewProfileUI boolean If you enable Enhanced Profile User Interface (true), you can use the streamlined, enhanced profile user interface to browse, search, and modify settings. You can use only one user interface at a time.
enableUserSelfDeactivate boolean If you enable User Self Deactivate (true), users can deactivate their Community or Chatter accounts.
enableScrambleUserData boolean If you enable Let Users Scramble Their User Data (true), users can request that Salesforce remove all their personal data. Because Salesforce can’t delete information, it scrambles their data. Scrambling a user’s data is unrecoverable. So this org-wide setting serves as an extra precaution. If a user requests it, you scramble the data programmatically with the obfuscateUser Apex method. You can use the method, for example, in a custom Apex trigger, workflow, or the Developer Console.

This field is available in API version 47.0 and later.

Declarative Metadata Sample Definition

The following is an example of a UserManagementSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<UserManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata" 
3xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4    <enableCanAnswerContainUsername>true</enableCanAnswerContainUsername>
5    <enableCanSaveUserPerm xsi:nil="true"/>
6    <enableConcealPersonalInfo>true</enableConcealPersonalInfo>
7    <enableContactlessExternalIdentityUsers>false</enableContactlessExternalIdentityUsers>
8    <enableEnhancedPermsetMgmt>false</enableEnhancedPermsetMgmt>
9    <enableEnhancedProfileMgmt>true</enableEnhancedProfileMgmt>
10    <enableNewProfileUI>false</enableNewProfileUI>
11    <enableScrambleUserData>false</enableScrambleUserData>
12    <enableUserSelfDeactivate>false</enableUserSelfDeactivate>
13</UserManagementSettings>

The following is an example package.xml manifest 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>UserManagement</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.