---
schema_version: "1"
id: 3a0395bd826c6804d202879ac1d2ee9c87c498c1d16c5391e05f5db23e1ce859
title: Installation Prerequisites
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/api-community-manager/installation-prerequisites.md
canonical_url: https://docs.mulesoft.com/api-community-manager/installation-prerequisites
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 196f868917275f7c4a02245e2d4c03a3545b9abbd229e2a1907b67d5cb429324
description: MuleSoft Documentation Site
latest: true
---
---
product: API Community Manager
---

# Installation Prerequisites

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To install Anypoint API Community Manager, you must follow these prerequisite steps.

## Enable Digital Experiences

Follow the steps in
[Enable Digital Experiences](https://help.salesforce.com/s/articleView?id=sf.networks_enable.htm&type=5)
to enable digital experiences inside your Salesforce organization.

## Set Salesforce Admin Role

Installing, updating, or configuring Anypoint API Community Manager must be done by a user account
with the **System Administrator** profile in the API Community Manager Salesforce organization. You
must set permissions and a role for your Salesforce API Community Manager organization administrator
user:

1.  Log in to your Salesforce organization.

2.  In **Setup**, use the **Quick Find** box to find and click **Users**.

3.  Locate your username and click **Edit**.

4.  Set the role for your account by selecting from the **Role** list.

    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](https://help.salesforce.com/s/articleView?id=000322715&language=en_US&mode=1&type=1)
    for instructions to create a role in your organization.

    If you create a role, enter a role name such as `Salesforce_ACM_org_admin_user`.

5.  Enable the option **Salesforce CRM Content User**.

6.  Click **Save**.

## Add the Monitoring Viewer Permission

Add the Monitoring Viewer permission to view metrics for applications on the **My Applications**
details page:

1.  Log in to Anypoint Platform and go to **Access Management**.

2.  Select **Teams** and select **Community Users**.

    If you don’t see this team, refer to the Exchange Viewer permission steps in
    [Configure Users](https://docs.mulesoft.com/api-community-manager/guided-setup#configure-users) for instructions to create it.

3.  Select the **Permissions** tab and click **Add permissions**.

4.  Select **Anypoint Monitoring** > **Monitoring Viewer** and click **Next**.

5.  Select all business groups that apply and click **Next**.

6.  Click **Add Permissions**.

## Verify API Community Manager Entitlement

Verify API Community Manager entitlement for your Anypoint organization:

1.  Log in to your Anypoint Platform organization.

2.  Choose the correct URL for your cloud and open the URL in your browser:

    - US cloud: `https://anypoint.mulesoft.com/accounts/api/profile`

    - EU cloud: `https://eu1.anypoint.mulesoft.com/accounts/api/profile`

    - MuleSoft Government Cloud: `https://gov.anypoint.mulesoft.com/accounts/api/profile`

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

## Prepare Identity Provider Data

### If You Already Have an Anypoint Platform Identity Provider

If you already have an Anypoint Platform identity provider, get identity provider data from your
current configuration:

1.  If you are using SAML:

    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.

2.  If you are using OpenID Connect:

    1.  Copy the organization ID so you can use it in the installation.

### If You Do Not Already Have an Anypoint Platform Identity Provider

If you do not already have an Anypoint Platform identity provider (IdP), configure Salesforce as a
SAML IdP.

The following instructions use URLs for the US cloud that begin with
`https://anypoint.mulesoft.com/`. If you are using the EU cloud, substitute
`https://eu1.anypoint.mulesoft.com/`. If you are using MuleSoft Government Cloud, substitute
`https://gov.anypoint.mulesoft.com/`.

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**:
        `https://anypoint.mulesoft.com/accounts/login/<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 `https://anypoint.mulesoft.com/accounts/login/receive-id` in the **ACS URL**. SAML
        assertions are sent to this ACS URL.

    5.  Select **Enable Single Logout**.

    6.  Provide **Single Logout URL**: `https://anypoint.mulesoft.com/accounts/logout/receive-id`.

    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].my.salesforce.com`).

    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. If you do not want external users to be able to log in directly to the Anypoint organization,
    set **Sign On URL** to a value of a nonfunctioning URL, for example,
    `http://www.example.com/login`.

11. Set **Sign Off URL** to **Single Logout Endpoint**.

12. Set **Issuer** to **salesforce\_org\_domainname** (such as
    `https://[YourOrgDomain].my.salesforce.com`).

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

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

15. Click **Save**.

## Next Steps

After these prerequisite steps, continue to the [installation steps](https://docs.mulesoft.com/api-community-manager/install-acm).
