Contact Free trial Login

Installation Prerequisites

To install Anypoint API Community Manager you will need:

  1. An Anypoint admin user account.

  2. A Salesforce API Community Manager organization admin user with a role.

    To update your user role and permissions:

    1. Log in to your Salesforce organization.

    2. In Setup, search for Users using the Quick Find box and click Users.

    3. Locate your username and click Edit.

    4. Set the Role for your account.

      This can be any role from the list, but cannot be none.

      If you don’t see any roles in the list, refer to the Salesforce knowledge article Add roles to the role hierarchy for instructions to create a role in your organization.

    5. Select Salesforce CRM Content User.

    6. Click Save.

  3. The Anypoint API Community Manager entitlement for your Anypoint organization.

    To check the entitlement:

    1. Log in to your Anypoint Platform organization.

    2. Navigate in your browser to

    3. Verify that under the Entitlements property, the apiCommunityManager value is true.

  4. Identity provider data.

Prepare Identity Provider Data

If You Already Have Anypoint Identity Provider

If you already have Anypoint Identity Provider, get identity provider data from your current configuration:

  1. Click Access Management > Identity Providers.

  2. On SAML 2.0 click Edit.

  3. Copy the issuer and the audience so you can use them in the installation.

If You Do Not Already Have Anypoint Identity Provider

If you do not already have Anypoint Identity Provider (IdP), configure Salesforce as a SAML IdP:

  1. In Setup, search for App Manager using the Quick Find box and click App Manager.

  2. Click New Connected App in the top right.

  3. Provide this information in the Basic Information section.

    1. Connected App Name: Anypoint.

    2. Contact Email: Enter your email address.

  4. Provide this information in the Web App Settings section.

    1. Provide the Start URL:<your_anypoint_domain_name> or the location where you want users to be sent in Anypoint Platform.

      You can find your Anypoint organization domain name by clicking Access Management > Organization and then selecting the root organization.

    2. Select Enable SAML.

    3. Provide any string as Entity Id. This is also the Audience configuration in Anypoint Platform.

    4. Provide in the ACS URL. SAML assertions are sent to this ACS URL.

    5. Select Enable Single Logout.

    6. Provide Single Logout URL:

    7. Set Single Logout Binding to HTTP Post.

    8. Set Subject Type to Username.

    9. Set Name ID Format to unspecified nameID format.

    10. Set Issuer to salesforce_org_domainname (such as https://[YourOrgDomain]

    11. Set IdP Certificate to Default IdP Certificate.

    12. Click Save.

Configure external identity in your Anypoint organization:

  1. In the Salesforce organization, click Setup, use the Quick Find box to search for Identity Provider, and click Identity Provider.

  2. Click Enable Identity Provider.

  3. Save.

  4. Use the Quick Find box to search for App Manager, choose the app named Anypoint, and in the last column of the table, click the arrow and click Manage.

  5. Make a note of the URIs under the SAML Login Information to use them in the Anypoint configuration in these steps.

  6. Click Download metadata and retrieve the public key in the <ds:X509Certificate> tag inside the XML file.

  7. Log in to your Anypoint organization.

  8. Navigate to Access Management > Identity Providers > SAML 2.0.

  9. Set Sign On URL to IdP-Initiated Login URL.

  10. Set Sign Off URL to Single Logout Endpoint.

  11. Set Issuer to match the Salesforce account: salesforce_org_domainname.

  12. Set the Public Key to the public key extracted from the <ds:X509Certificate> tag in the metadata XML you downloaded.

  13. Set Audience to match the Entity Id you set in the Salesforce account.

  14. Select Enable new non-SSO users.

  15. Click Save.

Next Steps

After you have confirmed that you have these prerequisites, continue to the installation steps.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub