SecuritySettings | Metadata API Developer Guide

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

SecuritySettings values are stored in a single file named Security.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

Security settings are available in API version 27.0 and later. API versions 26 and earlier are no longer available.

Fields

Field Name	Field Type	Description
canUsersGrantLoginAccess	boolean	If `true`, users can grant login access to Support. If `false`, only an admin can grant login access. Users can’t grant login access to managed packages that are licensed to your entire Salesforce org. Only admins with the Manage Users permission enabled on their profiles can grant access to these publishers. Also, some managed packages don’t have login access. If a package isn’t listed on the Login Access Policies page, login access isn’t available for that package. Note
enableAdminLoginAsAnyUser	boolean	If `true`, the Administrators Can Log in as Any User field is enabled. The default isn’t enabled (`false`).
enableAuditFieldsInactiveOwner	boolean	If `true`, this setting enables audit fields and updating the owner for records that are owned by inactive users. The default value is `false`. This field is available in API version 47.0 and later.
enableAuraSecureEvalPref	boolean	If `true`, this setting prevents the creation of function expressions in dynamically created Aura components. The default is `false`. This field is available in API version 47.0 and later.
enableRequireHttpsConnection	boolean	Deprecated in API version 47.0 and later.
isTLSv12Required	boolean	Indicates whether connections to or from your Salesforce org must use TLS 1.2 or higher (`true`) or not (`false`). This field has a default value of `false`. Removed in API version 51.0 and later.
isTLSv12RequiredCommunities	boolean	Indicates whether connections with your Salesforce sites and portals or Experience Cloud sites must use TLS 1.2 or higher (`true`) or not (`false`). This field has a default value of `false`. Removed in API version 51.0 and later.
networkAccess	NetworkAccess	The trusted IP address ranges from which users can always log in without requiring computer activation.
passwordPolicies	PasswordPolicies	The requirements for passwords and logins, and assistance with retrieving forgotten passwords.
sessionSettings	SessionSettings	The settings for session expiration and security.
singleSignOnSettings	SingleSignOnSettings	The settings for single sign-on (SSO).

NetworkAccess

Represents your org’s trusted IP address ranges for network access.

Field	Field Type	Description
ipRanges	IpRange[]	The trusted IP address ranges from which users can always log in without requiring computer activation. To add an IP range, deploy all existing IP ranges, including the one you want to add. Otherwise, the existing IP ranges are replaced with the ones you deploy. To remove all the IP ranges, leave the networkAccess field blank (<networkAccess></networkAccess>). Note

IpRange

Defines a range of trusted IP addresses for network access.

Field	Field Type	Description
description	string	The description of the trusted IP range. Use this field to identify the range, such as which corporate network corresponds to this range. Available in API version 34.0 and later.
end	string	The IP address that defines the high end of a range of trusted addresses.
start	string	The IP address that defines the low end of a range of trusted addresses.

PasswordPolicies

Represents your org’s password and login policies, which show up under Security Controls | Password Policies.

Field	Field Type	Description
apiOnlyUserHomePageURL	string	The URL to which users with the “API Only User” permission are redirected instead of the login page.
complexity	Complexity (enumeration of type string)	The types of characters that must be used in a user’s password. Valid values are: `NoRestriction`—Has no requirements and is the least secure option. `AlphaNumeric`—The default setting. Requires at least one alphabetic character and one number. This value is the default value. `SpecialCharacters`—Requires at least one alphabetic character, one number, and one of the following characters: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { \| } ~. `UpperLowerCaseNumeric`—Requires at least one number, one uppercase letter, and one lowercase letter. This value is available in API version 31.0 and later. `UpperLowerCaseNumericSpecialCharacters`—Requires at least one number, one uppercase letter, one lowercase letter, and one of the following characters: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { \| } ~. This value is available in API version 31.0 and later. `Any3UpperLowerCaseNumericSpecialCharacters`—Requires at least three of the following options: one number, one uppercase letter, one lowercase letter, and one special character (! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { \| } ~). This value is available in API version 46.0 and later.
enableSetPasswordInApi	boolean	Deprecated in API version 51.0. Removed in API version 52.0.
expiration	Expiration (enumeration of type string)	The length of time until a user password expires and must be changed. Valid values are: `Never` `ThirtyDays` `SixtyDays` `NinetyDays`. This value is the default value. `SixMonths` `OneYear`
historyRestriction	string	The number of previous passwords saved for users so that they must always reset a new, unique password. Valid values are `0` through `24` passwords remembered. The maximum value of 24 applies to API version 31.0 and later. In earlier versions, the maximum value is 16. The default value is `3`.
lockoutInterval	LockoutInterval (enumeration of type string)	The duration of the login lockout. Valid values are: `FifteenMinutes`. This value is the default value. `ThirtyMinutes` `SixtyMinutes` `Forever` (must be reset by admin)
maxLoginAttempts	MaxLoginAttempts (enumeration of type string)	The number of login failures allowed for a user before the user is locked out. Valid values are: `NoLimit` `ThreeAttempts` `FiveAttempts` `TenAttempts`. This value is the default value.
minimumPasswordLength	string	The minimum number of characters required for a password. The number can contain from 5 to 50 characters (default is 8). Available in API version 35.0 and later. Before API version 35.0, specify minimum password length with the enumeration `minPasswordLength`, with valid values `FiveCharacters`, `EightCharacters` (default), `TenCharacters`, `TwelveCharacters` (API version 31.0 and later), and `FifteenCharacters` (API version 34.0 and later).
minimumPasswordLifetime	boolean	If Require a minimum 1 day password lifetime is enabled (`true`), passwords can’t be changed more than one time during a 24-hour period. The default is `false`. Available in API version 31.0 and later.
obscureSecretAnswer	boolean	If enabled (`true`), hide answers to security questions as the user types. The default is `false`. If your org uses the Microsoft Input Method Editor (IME) with the input mode set to Hiragana, when you type ASCII characters, they’re converted in to Japanese characters in normal text fields. However, the IME doesn’t work properly in fields with obscured text. If your org’s users can’t properly enter their passwords or other values after enabling this feature, disable the feature. Note
passwordAssistanceMessage	string	The text that appears in the Account Lockout email and at the bottom of the Confirm Identity screen for users resetting their passwords.
passwordAssistanceURL	string	The URL that users can click to retrieve forgotten passwords.
questionRestriction	QuestionRestriction (enumeration of type string)	The restriction on whether the answer to the password hint question can contain the password itself. Valid values are: `None` `DoesNotContainPassword`. This value is the default value.

SessionSettings

Represents your org’s session expiration and security settings.

Field	Field Type	Description
allowUserAuthenticationByCertificate	boolean	If enabled (`true`), users can authenticate with a PEM-encoded X.509 digital certificate. Not enabled by default. Available in API version 47.0 and later.
canConfirmEmailChangeInLightningCommunities	boolean	If Require email confirmations for email address changes is enabled (`true`), when users change their email address, they receive an email at the new address with a link. After they click the link, their new email address takes effect. For orgs created before Winter ‘20, the field isn’t enabled by default. For new orgs, this field is always enabled. To disable the field (not recommended), contact Salesforce Customer Support. Available in API version 47.0 and later.
canConfirmIdentityBySmsOnly	boolean	Prevents identity verification by email for users who have registered other verification methods, such as SMS or Salesforce Authenticator. If no other verification methods are configured, users are verified by email. By default, this setting is disabled (`false`) for existing orgs. For new orgs, this setting is enabled (`true`) by default. Available in API version 48.0 and later.
disableTimeoutWarning	boolean	Indicates whether the session timeout warning popup is disabled (`true`) or enabled (`false`).
enableBuiltInAuthenticator	boolean	Indicates whether users can verify their identity with a built-in authenticator that's already on their device (`true`), such as Touch ID or Windows Hello, or not (`false`). The default value is `false`.
enableCSPOnEmail	boolean	Indicates whether a content security policy is enabled for the email template. A content security policy helps prevent cross-site scripting attacks by listing allowed sources of images and other content.
enableCSRFOnGet	boolean	Indicates whether Cross-Site Request Forgery (CSRF) protection on GET requests on non-setup pages is enabled (`true`) or disabled (`false`).
enableCSRFOnPost	boolean	Indicates whether Cross-Site Request Forgery (CSRF) protection on POST requests on non-setup pages is enabled (`true`) or disabled (`false`).
enableCacheAndAutocomplete	boolean	Indicates whether the user’s browser is allowed to store usernames and auto-fill the User Name field on the login page (`true`) or not (`false`).
enableClickjackNonsetupSFDC	boolean	Indicates whether clickjack protection for non-setup Salesforce pages is enabled (`true`) or disabled (`false`).
enableClickjackNonsetupUser	boolean	Indicates whether clickjack protection for customer Visualforce pages with standard headers turned on is enabled (`true`) or disabled (`false`).
enableClickjackNonsetupUserHeaderless	boolean	Indicates whether clickjack protection for customer Visualforce pages with standard headers turned off is enabled (`true`) or disabled (`false`). Available in API version 34.0 and later.
enableClickjackSetup	boolean	Indicates whether clickjack protection for setup pages is enabled (`true`) or disabled (`false`).
enableContentSniffingProtection	boolean	Indicates if the browser is prevented from inferring the MIME type from the document content and from executing malicious files (JavaScript, Stylesheet) as dynamic content. This field is available in API version 39.0 and later.
enableLightningLogin	boolean	If enabled (`true`), users can use Lightning Login (Salesforce Authenticator) to log in instead of a password. Available in API Version 47.0 and later.
enableLightningLoginOnlyWithUserPerm	boolean	If enabled (`true`), only users with the Lightning Login User permission can log in with Salesforce Authenticator instead of a password. Available in API version 47.0 and later.
enableOauthCorsPolicy	boolean	If set to `true`, enables Cross-Origin Resource Sharing (CORS) for these OAuth endpoints: `/services/oauth2/token` `/services/oauth2/revoke` `/services/oauth2/introspect` Default setting is `false`. Available in API version 50.0 and later.
enablePostForSessions	boolean	Indicates whether cross-domain session information is exchanged using a POST request instead of a GET request, such as when a user is using a Visualforce page. In this context, POST requests are more secure than GET requests. Available in API version 31.0 and later.
enableSMSIdentity	boolean	If enabled (`true`), the default, users can receive a one-time password in a text message (SMS) to verify their identity. Users must verify their mobile phone number before they can receive SMS messages.
enableU2F	boolean	If enabled (`true`), users can use a physical U2F-compatible security key for multi-factor authentication (MFA) and identity verification. The default is `false`. Available in API version 47.0 and later.
enableUpgradeInsecureRequests	boolean	Indicates if HTTPS is required for connecting to third-party domains. This setting is enabled by default on accounts created after the Summer ’17 release. Note This field is available in API version 42.0 and later.
enableXssProtection	boolean	Indicates if protection against reflected cross-site scripting attacks is enabled. If a reflected cross-site scripting attack is detected and XSS protection is enabled, the browser shows a blank page with no content. This field is available in API version 39.0 and later.
enforceIpRangesEveryRequest	boolean	If `true`, the IP addresses in Login IP Ranges are enforced when a user accesses Salesforce (on every page request), including access from a client app. If `false`, the IP addresses in Login IP Ranges are enforced only when a user logs in. This field affects all user profiles that have login IP restrictions. Available in API version 34.0 and later.
enforceUserDeviceRevoked	boolean	If enabled, and a UserDevice’s status is set to revoked, that device can’t log in from a Salesforce app. Logins from browsers aren’t affected. This field is available in API version 50.0 and later.
forceLogoutOnSessionTimeout	boolean	If enabled (`true`), the default, when sessions time out for inactive users, current sessions become invalid. The browser refreshes and returns to the login page. To access the org, the user must log in again. Available in API version 31.0 and later.
forceRelogin	boolean	If `true`, an admin who is logged in as another user must log in again to their original session, after logging out as the secondary user. If `false`, the admin isn’t required to log in again.
hasRetainedLoginHints	boolean	If you enable Remember me until logout (`true`), usernames (login hints) are cached until the user logs out. If a session times out, usernames appear on the Switcher as inactive. If `false` (default), usernames aren't cached for SSO sessions.
hasUserSwitching	boolean	If Enable user switching is`true` (default), users can log in to other orgs by selecting their profile picture and using the Switcher. You must also enable the Enable caching and autocomplete on login page setting. If `false`, the Switcher isn’t enabled and your org doesn’t appear in Switchers on other orgs.
hstsOnForcecomSites	boolean	Indicates whether Visualforce, Salesforce sites, or Experience Cloud sites must use HTTPS. Available in API version 41.0 and later.
identityConfirmationOnEmailChange	boolean	Indicates if a user’s identity is confirmed when changing their email address, instead of requiring a relogin. This field is available in API version 42.0 and later.
identityConfirmationOnTwoFactorRegistrationEnabled	boolean	Indicates if users are required to confirm their identities when adding a verification method such as Salesforce Authenticator for multi-factor authentication (MFA), instead of requiring a relogin. (Multi-factor authentication was formerly called two-factor authentication.) This field is available in API version 40.0 and later.
lockSessionsToDomain	boolean	Indicates whether the current UI session for a user is associated with a specific domain. This check helps prevent unauthorized use of the session ID in another domain. The value is `true` by default for orgs created with the Spring ’15 release or later. Available in API version 33.0 and later.
lockSessionsToIp	boolean	Indicates whether user sessions are locked to the IP address from which the user logged in (`true`) or not (`false`).
lockerServiceAPIVersion	string	The API version that Lightning Locker enforces for security of custom Lightning components. The default value matches the Salesforce API version of the current release. Only valid Salesforce API versions between 46.0 and the current release can be specified. The version must be a specified as a string in the format `"nn.0"`, such as `"48.0"`. This field is available in API version 47.0 and later.
logoutURL	string	The URL to which users are redirected when they log out of Salesforce. If no value is specified, the default is https://`MyDomainName`.my.salesforce.com. Available in API version 34.0 and later.
redirectionWarning	boolean	Indicates whether users see an alert when they click a link in a web tab that redirects them outside the salesforce.com domain. Available in API version 42.0 and later.
referrerPolicy	boolean	Indicates whether the referrer header hides sensitive information that could be present in the full URL. If `true`, then the referrer header displays only `salesforce.com`. If `false`, then the header displays the entire URL. For a Visualforce user, if referrerPolicy is set to `true`, then the referrer header displays only force.com, salesforce-sites.com, or sites.com. If `false`, then the header displays the entire URL. Available in API version 42.0 and later. When a request is made from a domain within salesforce.com, force.com, salesforce-sites.com, or site.com, the referrer header displays the entire URL. Note
requireHttpOnly	boolean	Sets the `HttpOnly` attribute on session cookies, making them inaccessible via JavaScript. If `true`, session ID cookie access is restricted. If `false`, access is restricted. If you have a custom or packaged application that uses JavaScript to access session ID cookies, your application breaks if requireHttpOnly is set to `true`. The application can't access the cookie. Note This field is available in API version 40.0 and later.
requireHttps	boolean	Determines whether HTTPS is required to log in to or access Salesforce. This option is enabled by default for security reasons and can’t be disabled. To change to HTTP, contact Salesforce Customer Support. This field is available in API version 40.0 and later.
securityCentralKillSession	boolean	Deprecated in API version 36.0 to 50.0. Removed in API version 51.0 and later.
sessionTimeout	SessionTimeout (enumeration of type string)	The length of time after which users without activity are prompted to log out or continue working. Valid values are: `FifteenMinutes` `ThirtyMinutes` `SixtyMinutes` `TwoHours` `FourHours` `EightHours` `TwelveHours` `TwentyFourHours`—Available in API version 38.0 and later.
sidToken3rdPartyAuraApp	boolean	Reserved for future use.
useLocalStorageForLogoutUrl	boolean	Redirects all expired tabs in your browser to your custom logout URL (`true`). By default, this option is enabled for all new orgs and is available in API version 52.0 and later. For orgs created prior to the Summer ‘21 release, the default setting is `false`. Before enabling this setting, review these considerations. This setting uses the browser’s local storage to store the custom logout URL. Verify that this setting doesn’t interfere with your custom login integrations.

SingleSignOnSettings

Represents your org’s single sign-on (SSO) settings. These settings are available API version 47.0 and later.

Field Name	Field Type	Description
enableCaseInsensitiveFederationID	boolean	If you enable Make Federation ID case-insensitive (`true`), the Federation ID field on a user object isn’t case-sensitive. If disabled (`false`), the Federation ID field remains case-sensitive. The default is `false`.
enableForceDelegatedCallout	boolean	If you enable Force Delegated Authentication Callout (`true`), a callout to the SSO endpoint occurs regardless of login restriction failures. If disabled (`false`), the default, and if a user’s first login attempt fails due to login restrictions within the Salesforce org, a call isn’t made to the SSO endpoint.
enableMultipleSamlConfigs	boolean	If `true` (default), you can configure multiple SAML providers. After enabling the setting, it can’t be disabled.
enableSamlJitProvisn’tioning	boolean	If you enable User Provisioning Enabled (`true`), you can provision users through a SAML assertion (called just-in-time provisioning). Requires EnableSamlLogin to be `true` and enableMultipleSamlConfigs to be `false`. The default is enabled (`false`).
enableSamlLogin	boolean	If you enable SAML Enabled (`true`), users can SSO into Salesforce from providers via SAML. The default isn’t enabled (`false`).
isLoginWithSalesforceCredentialsDisabled	boolean	If Disable login with Salesforce credentials is `true`, users are redirected to third-party identity providers for authentication. The default is enabled (`false`). If you enabled this feature prior to the Summer ‘20 release and want to disable it prior to July 27, 2020, contact Customer Support. Note

Declarative Metadata Sample Definition

The following is a sample security.settings metadata file.

1<?xml version="1.0" encoding="UTF-8"?>
2<SecuritySettings xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <enableAdminLoginAsAnyUser xsi:nil="true"/>
4    <enableAuraSecureEvalPref xsi:nil="true"/>
5    <enableAuditFieldsInactiveOwner xsi:nil="true"/>
6    <enableSetRequiredHttpsConnection xsi:nil="true"/>
7    <networkAccess/>
8    <passwordPolicies>
9        <complexity>NoRestriction</complexity>
10        <expiration>Never</expiration>
11        <historyRestriction>0</historyRestriction>
12        <lockoutInterval>FifteenMinutes</lockoutInterval>
13        <maxLoginAttempts>TenAttempts</maxLoginAttempts>
14        <minimumPasswordLength>5</minimumPasswordLength>
15        <minimumPasswordLifetime>false</minimumPasswordLifetime>
16        <obscureSecretAnswer>false</obscureSecretAnswer>
17        <questionRestriction>DoesNotContainPassword</questionRestriction>
18    </passwordPolicies>
19    <sessionSettings>
20        <allowUserAuthenticationByCertificate>false</allowUserAuthenticationByCertificate>
21        <disableTimeoutWarning>false</disableTimeoutWarning>
22        <enableCSPOnEmail>true</enableCSPOnEmail>
23        <enableCSRFOnGet>true</enableCSRFOnGet>
24        <enableCSRFOnPost>true</enableCSRFOnPost>
25        <enableCacheAndAutocomplete>true</enableCacheAndAutocomplete>
26        <enableClickjackNonsetupSFDC>true</enableClickjackNonsetupSFDC>
27        <enableClickjackNonsetupUser>false</enableClickjackNonsetupUser>
28        <enableClickjackNonsetupUserHeaderless>false</enableClickjackNonsetupUserHeaderless>
29        <enableClickjackSetup>true</enableClickjackSetup>
30        <enableContentSniffingProtection>true</enableContentSniffingProtection>
31        <enableLightningLogin>true</enableLightningLogin>
32        <enableLightningLoginOnlyWithUserPerm>false</enableLightningLoginOnlyWithUserPerm>
33        <useLocalStorageForLogoutUrl>false</useLocalStorageForLogoutUrl>
34        <enablePostForSessions>false</enablePostForSessions>
35        <enableSMSIdentity>true</enableSMSIdentity>
36        <enableU2F>false</enableU2F>
37        <enableUpgradeInsecureRequests>true</enableUpgradeInsecureRequests>
38        <enableXssProtection>true</enableXssProtection>
39        <enforceIpRangesEveryRequest>false</enforceIpRangesEveryRequest>
40        <forceLogoutOnSessionTimeout>true</forceLogoutOnSessionTimeout>
41        <forceRelogin>true</forceRelogin>
42        <hasRetainedLoginHints>false</hasRetainedLoginHints>
43        <hasUserSwitching>true</hasUserSwitching>
44        <hstsOnForcecomSites>false</hstsOnForcecomSites>
45        <identityConfirmationOnEmailChange>true</identityConfirmationOnEmailChange>
46        <identityConfirmationOnTwoFactorRegistrationEnabled>true</identityConfirmationOnTwoFactorRegistrationEnabled>
47        <lockSessionsToDomain>true</lockSessionsToDomain>
48        <lockSessionsToIp>false</lockSessionsToIp>
49        <lockerServiceCSP>true</lockerServiceCSP>
50        <redirectionWarning>true</redirectionWarning>
51        <referrerPolicy>true</referrerPolicy>
52        <requireHttpOnly>false</requireHttpOnly>
53        <requireHttps>false</requireHttps>
54        <sessionTimeout>TwoHours</sessionTimeout>
55    </sessionSettings>
56    <singleSignOnSettings>
57
58        <enableCaseInsensitiveFederationID>false</enableCaseInsensitiveFederationID>
59        <enableForceDelegatedCallout>false</enableForceDelegatedCallout>
60        <enableMultipleSamlConfigs>true</enableMultipleSamlConfigs>
61        <enableSamlJitProvisioning>false</enableSamlJitProvisioning>
62        <enableSamlLogin>false</enableSamlLogin>
63        <isLoginWithSalesforceCredentialsDisabled>true</isLoginWithSalesforceCredentialsDisabled>
64
65    </singleSignOnSettings>
66</SecuritySettings>

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>Security</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.