Skip to main content

Code reviews rule: Missing permission set descriptions

Written by David Martin

Missing permission set descriptions

Why is this an issue?

Permission sets are granted on top of a profile, so orgs accumulate a lot of them, and a label such as Invoice Review does not say what access it actually grants. Descriptions help administrators:

  • Choose the right permission set when granting access

  • See what a permission set is meant to grant, and who should hold it, during an access review

Examples

Example of incorrect metadata:

<PermissionSet>
<label>Invoice Review</label>
<license>Salesforce</license>
</PermissionSet>

Example of correct metadata:

<PermissionSet>
<description>Lets invoice reviewers edit invoice totals during the month-end close.</description>
<label>Invoice Review</label>
<license>Salesforce</license>
</PermissionSet>

How can I fix violations?

Add a description saying what the permission set grants and who should hold it:

  1. In Setup, enter Permission Sets in the Quick Find box and select Permission Sets

  2. Open the permission set and click Edit

  3. Fill in the Description field

  4. Click Save

When should I disable this rule?

You may dismiss specific violations for permission sets that come with a Salesforce license, which you cannot edit.

Resources

Did this answer your question?