Skip to main content

Registering Your Organization

After installing the managed package, you need to register your Salesforce org with aprity. Registration links your org to your aprity account and enables documentation generation.

What you need​

  • The aprity managed package installed (see Installing the Managed Package)
  • The Aprity_Admin permission set assigned to your user
  • An activation code provided by aprity (received via email when you signed up, or from your account manager)

:::info No activation code? If you do not have an activation code, visit aprity.ai to sign up for a trial or contact your account manager for a license key. :::

Registration steps​

Step 1: Open the aprity app​

  1. Click the App Launcher in Salesforce.
  2. Search for and open aprity.

Step 2: Enter your activation code​

  1. On the aprity home screen, you will see the Registration panel.
  2. Enter your activation code in the field provided.
  3. Click Register.

Registration screen with activation code field

Step 3: Wait for automatic registration​

aprity automatically communicates with the aprity cloud platform to:

  • Validate your activation code
  • Register your Salesforce org ID
  • Link your org to your aprity account and plan
  • Confirm the features available on your plan

This process takes a few seconds. Once complete, the home screen updates to show your organization details and plan information.

Registration complete screen

tip

Registration is a one-time operation per org. You do not need to repeat this step unless you uninstall and reinstall the package.

What happens during registration​

When you register, aprity records the following information:

  • Your Salesforce Organization ID (18-character ID)
  • Your org's instance URL
  • The plan and features associated with your activation code
  • The tenant your org belongs to (for multi-org setups)

No metadata or data from your org is read during registration. Metadata extraction only occurs when you explicitly run a scan.

Verifying registration​

After registration, the aprity home screen displays:

  • Your organization name and ID
  • Your current plan (Trial, Starter, Professional, or Enterprise)
  • Available features and scan limits
  • The connection status (will show as "Not Connected" until you configure JWT authentication)

Troubleshooting​

ProblemSolution
"Invalid activation code"Double-check the code for typos. Activation codes are case-sensitive. Contact support if the issue persists.
"Organization already registered"Your org is already linked to an aprity account. Contact support if you need to transfer the registration.
Registration hangs or times outCheck your network connectivity. Ensure outbound HTTPS to *.aprity.ai is not blocked (see Prerequisites).

Next step​

Your org is now registered. The next step is to configure secure connectivity so aprity can read your metadata. Proceed to Configuring JWT Bearer Authentication.