Customer Portal

The aprity Customer Portal is a dedicated web app where your team can browse, search, and share the documentation that aprity generates for your Salesforce org. It opens in any modern browser and signs you in with your Salesforce account, so there is no separate password to manage.

The Customer Portal is available on every plan -- Documentation, Intelligence, and Trial. It is the primary delivery surface for all aprity-generated documentation.

What you can do

• Browse the latest documentation. Navigate by object, process, rule, flow, or integration directly from the sidebar.
• Search across the org. Client-side search hits every page in the latest scan -- field names, automation names, rule labels.
• Open deep-links. Every page has a stable URL of the form ?scanId=…&pageId=…. Paste it anywhere ; the recipient gets the same page after logging in.
• Submit inline feedback. Spot a wrong description or a missing automation ? Click the feedback button next to any rule or section. Your comment lands in the aprity backoffice for the documentation team to review.
• Switch between scans. Past scans stay available within your retention window (see Plan Comparison). The portal lets you flip back to compare history.
• Run impact analysis. On Intelligence and Trial plans, ask "what breaks if I change or delete this field/object ?" and get a deterministic answer powered by aprity's knowledge tools. See Impact Analysis.
• Ask the Help Agent. On Intelligence and Trial plans, the portal hosts a dedicated Help Agent page for natural-language questions about your org. See Help Agent.

Accessing the portal

aprity provisions a portal URL for your tenant on the form :

https://{your-slug}.app.aprity.ai/

Your {slug} is decided at onboarding (typically your company short name). Your aprity contact provides the exact URL the first time the portal is enabled for your tenant.

Bookmark it, share it with your team, and put it in your internal wiki / Confluence so people find it without having to ask.

First login

1. Open https://{your-slug}.app.aprity.ai/ in any modern browser (Chrome, Edge, Safari, Firefox).
2. Click Sign in with Salesforce.
3. A Salesforce OAuth tab opens. Sign in with your usual Salesforce credentials.
4. Approve the consent prompt the first time. Your Salesforce admin has pre-authorized the connection for users whose profile is in the External Client App's allowed-profiles list -- if you see a "not authorized" error here, ask your admin to add your profile (see What your admin needs to do below).
5. You land on the portal home page, listing the latest successful scan.

The portal uses OAuth Authorization Code + PKCE against your Salesforce org. aprity never sees your Salesforce password -- only the OAuth tokens issued by Salesforce.

What your admin needs to do (one time)

If you are the first user from your tenant to access the portal, your Salesforce admin must have :

• Installed the aprity managed package and completed JWT Bearer setup. The portal reuses the same External Client App.
• Added the portal callback URL to that External Client App and enabled the three additional OAuth scopes (openid, profile, email). The aprity install guide for admins covers this.
• Assigned one of two permission sets to each user who needs portal access :
  • aprity User -- read access + submit feedback.
  • aprity Admin -- everything plus admin views (when applicable).

Without one of these permission sets, signing in returns a 401 even if Salesforce authentication succeeds.

Deep-linking and sharing

Every page in the portal has a stable, copy-pasteable URL. The URL pattern is :

https://{your-slug}.app.aprity.ai/scans?scanId=SCAN-…&pageId=…

Examples :

• Share a specific object documentation : https://acme.app.aprity.ai/scans?scanId=SCAN-2026-05-23&pageId=objects/Account
• Share a process page : https://acme.app.aprity.ai/scans?scanId=SCAN-2026-05-23&pageId=processes/Lead-Conversion
• Share a rule page : https://acme.app.aprity.ai/scans?scanId=SCAN-2026-05-23&pageId=rules/Account-OPP-VR-3

If the recipient is not logged in, they're prompted to sign in first, and the portal restores them to the deep-linked page after authentication completes. The URL itself doesn't leak any data -- it's just a pointer into your tenant's documentation, gated by the same SSO login as the home page.

Feedback workflow

Open any page and you'll see a small feedback control next to each rule or section :

1. Click Suggest a correction (or the thumb / pencil icon, depending on the section).
2. Pick a category (factual error, missing automation, unclear wording, …).
3. Write a short note and submit.

Your feedback is persisted in the aprity backoffice with your tenant and user context. The aprity documentation team reviews it and either updates the page on the next scan (when it is a deterministic fact) or flags the relevant prompt for refinement (when it is a narrative wording issue).

Limitations

• The portal always reflects the last successful scan. If you need to compare two versions of the documentation, switch scans from the scan picker rather than expecting cross-version diffs in a single view.
• Each portal is bound to a single aprity tenant (which can hold multiple Salesforce orgs). To access a different tenant, sign out and sign back in -- or use a separate browser profile if you need both open at once.
• Users without the aprity User or aprity Admin permission set in your Salesforce org cannot access the portal even when SSO succeeds. Add the permission set to grant access.
• The portal is read-only for end users (plus feedback submission). To change what the documentation contains, re-run a scan with adjusted scope ; corrections submitted via the inline feedback button are reviewed by the aprity documentation team for future scans.

Troubleshooting

Symptom	What to check
401 after signing in with Salesforce	The user is missing the aprity User or aprity Admin permission set. Ask your Salesforce admin to assign it.
Sign-in tab closes without redirecting	Often a redirect URI / proxy problem. Try in a non-corporate network ; if it persists, contact support@aprity.ai.
Pages appear empty or missing	Run a fresh scan from the managed app -- the portal always shows the last successful scan.
A shared deep-link returns a 404	The scan referenced in the link may be out of your retention window. Open the portal home page and pick a recent scan instead.
Slow loading on a large org	The portal does client-side search ; large orgs (thousands of rules) take a few seconds to load the search index. This is one-shot per session.

For anything else, contact support@aprity.ai.