Skip to main content

How to Update Named Credentials

aprity uses Salesforce Named Credentials to securely communicate with its backend API. This guide is for advanced users who need to verify or update these endpoints.

Named Credentials Used by aprity​

Named CredentialPurpose
FR_APIAuthenticated API calls (HMAC-signed requests for scans, documentation, feedback)
FR_API_PublicPublic endpoints (health checks, registration)

Verifying Named Credentials​

  1. In Salesforce, go to Setup.
  2. In the Quick Find box, search for Named Credentials.
  3. Click Named Credentials.
  4. Locate FR_API and FR_API_Public in the list.
  5. Click on each to verify the endpoint URL and authentication settings.

When to Update Named Credentials​

Named Credentials typically do not need manual updates. However, you may need to verify them if:

  • Scans fail with authentication or connectivity errors.
  • You receive instructions from aprity support to update an endpoint.
  • Your org was recently migrated or restored from a sandbox.
warning

Do not modify Named Credential URLs unless instructed by aprity support. Incorrect URLs will prevent the application from communicating with the backend.

Updating a Named Credential​

  1. Navigate to Setup > Named Credentials.
  2. Click Edit next to the credential you need to update.
  3. Update the URL field with the value provided by aprity support.
  4. Click Save.
  5. Test the connection by navigating to the aprity app and checking that the Generate tab loads correctly.
info

Named Credentials are configured automatically during the initial aprity package installation. Manual intervention is only needed in exceptional circumstances.