--- schema_version: "1" id: c48914e436e800dc58b30efad959ae2f5198803f6b10436c94c86ade07e4394f title: Security Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_System_Security.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_Security.htm source_site: developer.salesforce.com content_type: documentation content_hash: 787493ddb135c656d8f1375347040441c265d979598edd8eff00192ac681c6a0 description: Contains methods to securely implement Apex applications.Creates a list of sObjects from the source records, which are stripped of fields that fail the field-level security checks for the current user. The method also provides an option to enforce an object-level access check.Creates a list of sObjects from the source records, which are stripped of fields that fail the field-level security checks for the current user.Creates a list of sObjects from the source records, which are stripped of fields that fail field-level and object-level access checks. Apex enforces field-level security (FLS) and object permissions as per the specified permission set, in addition to the running user’s permissions. --- # Security Class Contains methods to securely implement Apex applications. ## Namespace [System](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_System.htm "The System namespace provides classes and methods for core Apex functionality.") ## Usage In the context of the current user’s create, read, update, or upsert access permission, use the Security class methods to: - Strip fields that aren’t visible from query and subquery results - Remove inaccessible fields before a DML operation without causing an exception - Sanitize SObjects that have been deserialized from an untrusted source - **[Security Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_Security.htm#apex_System_Security_methods)** ## Security Methods The following are methods for Security. - **[stripInaccessible(accessCheckType, sourceRecords, enforceRootObjectCRUD)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_Security.htm#apex_System_Security_stripInaccessible)** Creates a list of sObjects from the source records, which are stripped of fields that fail the field-level security checks for the current user. The method also provides an option to enforce an object-level access check. - **[stripInaccessible(accessCheckType, sourceRecords)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_Security.htm#apex_System_Security_stripInaccessible_2)** Creates a list of sObjects from the source records, which are stripped of fields that fail the field-level security checks for the current user. - **[stripInaccessible(accessCheckType, sourceRecords, enforceRootObjectCRUD, permissionSetId)(Developer Preview)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_Security.htm#apex_System_Security_stripInaccessible_3)** Creates a list of sObjects from the source records, which are stripped of fields that fail field-level and object-level access checks. Apex enforces field-level security (FLS) and object permissions as per the specified permission set, in addition to the running user’s permissions. ### stripInaccessible(accessCheckType, sourceRecords, enforceRootObjectCRUD) Creates a list of sObjects from the source records, which are stripped of fields that fail the field-level security checks for the current user. The method also provides an option to enforce an object-level access check. #### Signature public static System.SObjectAccessDecision stripInaccessible(System.AccessType accessCheckType, List sourceRecords, Boolean enforceRootObjectCRUD) #### Parameters - **accessCheckType**: Type: [System.AccessType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_System_AccessType.htm "Specifies the access check type for the fields of an sObject.") Uses values from the [AccessType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_System_AccessType.htm "Specifies the access check type for the fields of an sObject.") enum. This parameter determines the type of field-level access check to be performed. To check the current user's field-level access, use the [Schema.DescribeFieldResult](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fields_describe.htm#apex_methods_system_fields_describe "Contains methods for describing sObject fields.") methods —isCreatable(), isAccessible(), or isUpdatable(). - **sourceRecords**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_sobject.htm#apex_methods_system_sobject "Contains methods for the sObject data type.") A list of sObjects to be checked for fields that aren’t accessible in the context of the current user’s operation. - **enforceRootObjectCRUD**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") Indicates whether an object-level access check is performed. If this parameter is set to true and the access check fails, the method throws an exception. The default value of this optional parameter is true. #### Return Value Type: [System.SObjectAccessDecision](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_SObjectAccessDecision.htm#apex_class_System_SObjectAccessDecision "Contains the results of a call to the Security.stripInaccessible method and methods to retrieve those results.") #### Example In this example, the user doesn’t have permission to create the Probability field of an Opportunity. List opportunities = new List{ new Opportunity(Name='Opportunity1'), new Opportunity(Name='Opportunity2', Probability=95) }; // Strip fields that are not creatable SObjectAccessDecision decision = Security.stripInaccessible( AccessType.CREATABLE, opportunities); // Print stripped records for (SObject strippedOpportunity : decision.getRecords()) { System.debug(strippedOpportunity); } // Print modified indexes System.debug(decision.getModifiedIndexes()); // Print removed fields System.debug(decision.getRemovedFields()); //Lines from output log //|DEBUG|Opportunity:{Name=Opportunity1} //|DEBUG|Opportunity:{Name=Opportunity2} //|DEBUG|{1} //|DEBUG|{Opportunity={Probability}} ### stripInaccessible(accessCheckType, sourceRecords) Creates a list of sObjects from the source records, which are stripped of fields that fail the field-level security checks for the current user. #### Signature public static System.SObjectAccessDecision stripInaccessible(System.AccessType accessCheckType, List sourceRecords) #### Parameters - **accessCheckType**: Type: [System.AccessType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_System_AccessType.htm "Specifies the access check type for the fields of an sObject.") Uses values from the [AccessType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_System_AccessType.htm "Specifies the access check type for the fields of an sObject.") enum. This parameter determines the type of field-level access check to be performed. To check the current user's field-level access, use the [Schema.DescribeFieldResult](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fields_describe.htm#apex_methods_system_fields_describe "Contains methods for describing sObject fields.") methods —isCreatable(), isAccessible(), or isUpdatable(). - **sourceRecords**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_sobject.htm#apex_methods_system_sobject "Contains methods for the sObject data type.") A list of sObjects to be checked for fields that aren’t accessible in the context of the current user’s operation. #### Return Value Type: [System.SObjectAccessDecision](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_SObjectAccessDecision.htm#apex_class_System_SObjectAccessDecision "Contains the results of a call to the Security.stripInaccessible method and methods to retrieve those results.") #### Example In this example, the user doesn’t have permission to read the ActualCost field of a Campaign. List campaigns = new List{ new Campaign(Name='Campaign1', BudgetedCost=1000, ActualCost=2000), new Campaign(Name='Campaign2', BudgetedCost=4000, ActualCost=1500) }; insert as system campaigns; // Strip fields that are not readable SObjectAccessDecision decision = Security.stripInaccessible( AccessType.READABLE, \[SELECT Name, BudgetedCost, ActualCost from Campaign WITH SYSTEM\_MODE\]); // Print stripped records for (SObject strippedCampaign : decision.getRecords()) { System.debug(strippedCampaign); // Does not display ActualCost } // Print modified indexes System.debug(decision.getModifiedIndexes()); // Print removed fields System.debug(decision.getRemovedFields()); //Lines from output log //|DEBUG|Campaign:{Name=Campaign1, BudgetedCost=1000, Id=701xx00000011nhAAA} //|DEBUG|Campaign:{Name=Campaign2, BudgetedCost=4000, Id=701xx00000011niAAA} //|DEBUG|{0, 1} //|DEBUG|{Campaign={ActualCost}} ### stripInaccessible(accessCheckType, sourceRecords, enforceRootObjectCRUD, permissionSetId)(Developer Preview) Creates a list of sObjects from the source records, which are stripped of fields that fail field-level and object-level access checks. Apex enforces field-level security (FLS) and object permissions as per the specified permission set, in addition to the running user’s permissions. #### Signature ![Note](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note.png) #### Note Feature is available as a developer preview. Feature isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don’t implement functionality developed with these commands or tools in a production environment. You can provide feedback and suggestions for the “Permission Sets with User Mode” feature in the [Trailblazer Community](https://trailhead.salesforce.com/trailblazer-community/groups/0F94S000000GvrW "HTML (New Window)"). This feature is available in scratch orgs where the ApexUserModeWithPermset feature is enabled. If the feature isn’t enabled, Apex code with this feature can be compiled but not executed. public static System.SObjectAccessDecision stripInaccessible(System.AccessType accessCheckType, List sourceRecords, Boolean enforceRootObjectCRUD, Id permissionSetId) #### Parameters - **accessCheckType**: Type: [System.AccessType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_System_AccessType.htm "Specifies the access check type for the fields of an sObject.") Uses values from the [AccessType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_System_AccessType.htm "Specifies the access check type for the fields of an sObject.") enum. This parameter determines the type of field-level access check to be performed. To check the current user's field-level access, use the [Schema.DescribeFieldResult](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fields_describe.htm#apex_methods_system_fields_describe "Contains methods for describing sObject fields.") methods —isCreatable(), isAccessible(), or isUpdatable(). - **sourceRecords**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_sobject.htm#apex_methods_system_sobject "Contains methods for the sObject data type.") A list of sObjects to be checked for fields that aren’t accessible in the context of the current user’s operation. - **enforceRootObjectCRUD**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") Indicates whether an object-level access check is performed. If this parameter is set to true and the access check fails, the method throws an exception. The default value of this optional parameter is true. - **permissionSetId**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") Permissions in the specified permission set are enforced in additon to the running user’s permissions. #### Return Value Type: [System.SObjectAccessDecision](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_System_SObjectAccessDecision.htm#apex_class_System_SObjectAccessDecision "Contains the results of a call to the Security.stripInaccessible method and methods to retrieve those results.")