Admin Guide Overview
This guide covers the administrative tasks required to set up, configure, and maintain aprity in your Salesforce organization.
Who Is an Admin?
An aprity Admin is a Salesforce user who has been assigned the Aprity_Admin permission set. Admins have access to:
- Generate tab — Launch documentation scans
- Connectors tab — Manage third-party integrations (Confluence)
- Schedule tab — Configure automated recurring scans
- All features available to standard users
Admin vs User Permissions
| Capability | Aprity_Admin | Aprity_User |
|---|---|---|
| View scan results | Yes | Yes |
| Download documentation | Yes | Yes |
| Submit feedback | Yes | Yes |
| Launch new scans | Yes | No |
| Retry failed scans | Yes | No |
| Configure scheduling | Yes | No |
| Manage connectors | Yes | No |
| Access On-Demand Docs | Yes | Yes |
| View Execution Graph | Yes | Yes |
Key Admin Tasks
- Installing the managed package — AppExchange installation and initial setup
- Registering your org — Activation code and registration
- Configuring JWT authentication — Connected App and certificate setup
- Assigning permission sets — Grant Aprity_Admin or Aprity_User to your users via Setup > Permission Sets
- Managing Named Credentials — The API endpoint is configured automatically during registration
- Plan management — Understanding and upgrading your plan
- Certificate rotation — Re-download a new certificate from aprity and re-upload to your Connected App when the current one expires
Security Model
aprity uses a multi-layered security model:
- JWT Bearer authentication — No passwords stored, certificate-based
- HMAC request signing — Every API call is cryptographically signed
- Tenant isolation — Complete data separation between organizations
- Azure hosting — Data stored in Azure France Central with encryption at rest