Enforce Field-Level Security With the stripInaccessible Method (Beta)

Use the stripInaccessible method to enforce field-level data protection. This method can be used to strip the fields from query and subquery results that the user can’t access. The method can also be used to remove inaccessible sObject fields before DML operations to avoid exceptions and to sanitize sObjects that have been deserialized from an untrusted source.

As a beta feature, stripInaccessible method 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. You can provide feedback and suggestions for this feature in the Security.stripInaccessible group in the IdeaExchange.

Note

The field- and object-level data protection is accessed through the Security and SObjectAccessDecision classes. The access check is based on the field-level permission of the current user in the context of the specified operation - create, read, update, or upsert. The stripInaccessible method checks the source records for fields that don’t meet field-level security check for the current user and creates a list of sObjects. The return list is identical to the source records, except that the fields that are inaccessible to the current user are removed. The sObjects returned by the getRecords method contain records in the same order as the sObjects in the sourceRecords parameter of the stripInaccessible method. Fields that aren’t queried are null in the return list, without causing an exception.

The ID field is never stripped by the stripInaccessible method to avoid issues when performing DML on the result.

Note

To identify inaccessible fields that were removed, you can use the isSet method. For example, the return list contains Contact object and the custom field social_security_number__c is inaccessible to the user. Because this custom field fails the field-level access check, the field is not set and isSet returns false.

1SObjectAccessDecision securityDecision = Security.stripFields(sourceRecords);
2Contact c = securityDecision.getRecords()[0];
3System.debug(c.isSet('social_security_number__c')); // prints "false"

The stripInaccessible method doesn’t support AggregateResult SObject. If the source records are of AggregateResult SObject type, an exception is thrown.

Note

The following are some examples where the stripInaccessible method can be used.

Example

This example code removes inaccessible fields from the query result. A display table for campaign data must always show the BudgetedCost. The ActualCost must be shown only to users who have permission to read that field.

1Security.SObjectAccessDecision securityDecision = 
2         Security.stripInaccessible(AccessType.READABLE,
3                 [SELECT Name, BudgetedCost, ActualCost FROM Campaign];
4                 );
5
6    // Construct the output table
7    if (securityDecision.getRemovedFields().get('Campaign').contains('ActualCost')) {
8        for (Campaign c : securityDecision.getRecords()) {
9        //System.debug Output: Name, BudgetedCost
10        }
11    } else {
12        for (Campaign c : securityDecision.getRecords()) {
13        //System.debug Output: Name, BudgetedCost, ActualCost
14        }
15}

Example

This example code removes inaccessible fields from the subquery result. The user who doesn’t have permission to read the Phone field of a Contacts object.

1List<Account> accountsWithContacts =
2	[SELECT Id, Name, Phone,
3	    (SELECT Id, LastName, Phone FROM Account.Contacts)
4	FROM Account];
5  
6   // Strip fields that are not readable
7   SObjectAccessDecision decision = Security.stripInaccessible(
8	                                   AccessType.READABLE,
9	                                   accountsWithContacts);
10 
11// Print stripped records
12   for (Integer i = 0; i < accountsWithContacts.size(); i++) 
13  {
14      System.debug('Insecure record access: '+accountsWithContacts[i]);
15      System.debug('Secure record access: '+decision.getRecords()[i]);
16   }
17 
18// Print modified indexes
19   System.debug('Records modified by stripInaccessible: '+decision.getModifiedIndexes());
20 
21// Print removed fields
22   System.debug('Fields removed by stripInaccessible: '+decision.getRemovedFields());

Example

This example code removes inaccessible fields from sObjects before DML operations. The user who doesn’t have permission to create Rating for an Account can still create an Account. The method ensures that no Rating is set and doesn’t throw an exception.

1List<Account> newAccounts = new List<Account>();
2Account a = new Account(Name='Acme Corporation');
3Account b = new Account(Name='Blaze Comics', Rating=’Warm’);
4newAccounts.add(a);
5newAccounts.add(b);
6
7SObjectAccessDecision securityDecision = Security.stripInaccessible(
8AccessType.CREATABLE,
9newAccounts);
10
11// No exceptions are thrown and no rating is set
12insert securityDecision.getRecords();
13
14System.debug(securityDecision.getRemovedFields().get('Account')); // Prints "Rating"
15System.debug(securityDecision.getModifiedIndexes()); // Prints "1"

Example

This example code sanitizes sObjects that have been deserialized from an untrusted source. The user doesn’t have permission to update the AnnualRevenue of an Account.

1String jsonInput =
2'[' +
3'{' +
4'"Name": "InGen",' +
5'"AnnualRevenue": "100"' +
6'},' +
7'{' +
8'"Name": "Octan"' +
9'}' +
10']';
11
12List<Account> accounts = (List<Account>)JSON.deserializeStrict(jsonInput, List<Account>.class);
13SObjectAccessDecision securityDecision = Security.stripInaccessible(
14AccessType.UPDATABLE,
15accounts);
16
17// Secure update
18update securityDecision.getRecords(); // Doesn’t update AnnualRevenue field
19System.debug(String.join(securityDecision.getRemovedFields().get('Account'), ', ')); // Prints "AnnualRevenue"
20System.debug(String.join(securityDecision.getModifiedIndexes(), ', ')); // Prints "0”

Apex Developer Guide

Enforce Field-Level Security With the stripInaccessible Method (Beta)

Example

Example

Example

Example

See Also