Permission Sets Explained

aprity ships with two permission sets in the managed package: Aprity_Admin and Aprity_User. These permission sets control what each user can see and do within the aprity application.

Permission Set Comparison

Capability	Aprity_Admin	Aprity_User
View the aprity app	Yes	Yes
View scan results and history	Yes	Yes
View documentation in the web portal	Yes	Yes
Submit feedback on documentation	Yes	Yes
Access On-Demand Documentation	Yes	Yes
View Execution Graph (when enabled)	Yes	Yes
Launch new scans (Generate tab)	Yes	No
Retry failed scans	Yes	No
Configure scheduled scans (Schedule tab)	Yes	No
Manage connectors (Connectors tab)	Yes	No
Access Settings and JWT configuration	Yes	No
View usage, quotas, and plan details	Yes	No

What Each Permission Set Controls

Aprity_Admin

The Admin permission set grants full access to the aprity application. It includes:

• Tab visibility for all aprity tabs: Scans, Generate, Settings, Connectors, Schedule, Feedback, and On-Demand Docs, plus full access to the aprity web portal.
• Custom permissions that unlock administrative actions such as scan creation, retry, scheduling configuration, and connector management.
• Object-level access to all aprity custom objects for reading scan results, configuration data, and feedback entries.
• Field-level access to all fields on aprity custom objects.

Assign this permission set to Salesforce administrators and team leads who are responsible for generating and managing documentation.

Aprity_User

The User permission set grants read-only access to documentation. It includes:

• Tab visibility for consumer-facing tabs: Scans, Feedback, and On-Demand Docs, plus access to the aprity web portal where documentation is viewed.
• Object-level read access to scan results and feedback entries.
• Field-level read access to all relevant fields.

The Generate, Schedule, Connectors, and Settings tabs are not visible to users with only the Aprity_User permission set.

Assign this permission set to business analysts, developers, and other team members who need to read documentation but should not manage scans.

Assigning Permission Sets

Assign to a single user

1. Go to Setup > Users > Users.
2. Click on the user's name.
3. In the Permission Set Assignments related list, click Edit Assignments.
4. Move Aprity_Admin or Aprity_User from Available to Enabled.
5. Click Save.

Assign to multiple users at once

1. Go to Setup > Permission Sets.
2. Click on Aprity_Admin or Aprity_User.
3. Click Manage Assignments.
4. Click Add Assignments.
5. Select the users you want to assign and click Assign.

tip

You can also assign permission sets programmatically using Data Loader or the Salesforce CLI for large-scale rollouts.

Assign via Permission Set Group

For organizations that manage permissions through Permission Set Groups, you can add Aprity_Admin or Aprity_User to an existing group:

1. Go to Setup > Permission Set Groups.
2. Open the target group.
3. Click Permission Sets in Group and add the desired aprity permission set.

Common Scenarios

Business analyst team

Assign Aprity_User to all business analysts. They can view generated documentation in the web portal and submit feedback to improve documentation quality, but they cannot trigger new scans.

Admin and documentation lead

Assign Aprity_Admin to the documentation lead and Salesforce administrators. They control when scans run, configure scheduling, manage connectors, and handle JWT authentication.

Temporary scan access

If a user temporarily needs to run a scan (for example, during a project sprint), assign Aprity_Admin for the duration of the project, then reassign to Aprity_User afterward.

Verifying Assignments

To check which permission set a user has:

1. Go to Setup > Users > Users.
2. Click on the user's name.
3. Scroll to the Permission Set Assignments related list.
4. Confirm that either Aprity_Admin or Aprity_User is listed.

If a user reports missing tabs or features, the first troubleshooting step is always to verify their permission set assignment. See Missing Tabs or Features for additional guidance.