Skip to main content

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

CapabilityAprity_AdminAprity_User
View scan resultsYesYes
Download documentationYesYes
Submit feedbackYesYes
Launch new scansYesNo
Retry failed scansYesNo
Configure schedulingYesNo
Manage connectorsYesNo
Access On-Demand DocsYesYes
View Execution GraphYesYes

Key Admin Tasks

  1. Installing the managed package — AppExchange installation and initial setup
  2. Registering your org — Activation code and registration
  3. Configuring JWT authentication — Connected App and certificate setup
  4. Assigning permission sets — Grant Aprity_Admin or Aprity_User to your users via Setup > Permission Sets
  5. Managing Named Credentials — The API endpoint is configured automatically during registration
  6. Plan management — Understanding and upgrading your plan
  7. 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