salesforce Dreamforce On-Demand
Contact Us 1-800-596-4880
  1. Homepage
  2. API Community Manager
  3. Install

  4. Guided Setup

Guided Setup

Use the guided setup to setup API Community Manager.

If you have multiple identity providers in your organization, follow the instructions in Manual Setup.

Prerequisites

To set up API Community Manager with guided setup, complete the prerequisite steps and then follow these steps.

Open Guided Setup

From the Anypoint API Community Manager control panel, open the Salesforce App Launcher and search for API Community Manager Guided Setup.

Connect with Your Anypoint Organization

To connect your API Community Manager instance to your Anypoint organization:

  1. Select your organization’s Anypoint management plane, which may be the US control plane, the EU control plane, the MuleSoft Government Cloud control plane, or another control plane.

  2. If your Anypoint Platform user has organization administrator credentials:

    1. If your user has multi-factor authentication enabled, open Access Management > Users > your user’s page > Settings and enable Exempt from MFA requirement.

    2. Select I have organization administrator credentials and enter your Anypoint Platform username and password.

      The system creates a certificate named Anypoint in Salesforce, creates a connected app in Anypoint Platform using the certificate, creates a named credential in Salesforce using the client ID from the Anypoint Platform connected app and the identity provider information, configures the external data source, and grants Exchange contributor permissions to the impersonated user from the Salesforce administrator.

  3. If your Anypoint Platform user account does not have organization administrator credentials:

    1. Ask your organization administrator to use the following steps to create a connected app and give you the Client ID and IDP ID.

    2. Select I don’t have organization administrator credentials and enter the Client ID and IDP ID from your organization administrator.

Create a Connected App

To create a connected app if you are an organization administrator:

  1. In Salesforce, create a key pair for communication between Salesforce and Anypoint Platform:

    1. Click Setup > Security > Certificate and Key Management > Create Self-Signed Certificate.

    2. Set Label/Name to Anypoint.

    3. Disable Exportable Private Key.

    4. Set Key Size to 2048 or larger.

    5. Click Save.

    6. Click Download Certificate to save the public key from the key pair to your local machine.

  2. Click Access Management > Connected Apps > Create App.

  3. Enter a name for the app.

  4. Enable App acts on behalf of a user.

  5. In the section Grant types, enable JWT Bearer.

  6. Copy the public key from the downloaded file and paste it into the public key text area.

  7. Verify that the public key certificate has this format:

    -----BEGIN CERTIFICATE-----
PUBLIC KEY
-----END CERTIFICATE-----

  8. Set Website URL to https://login.salesforce.com.

  9. In the section Redirect URIs, add http://localhost.

    Each connected app requires one or more redirect URIs, but this configuration does not use them.

  10. In the section Who can use this application?, select Members of this organization only.

  11. In the section Scopes, add Background Access and Full Access.

  12. Click Save.

  13. Copy the client ID.

    Do not copy the client secret, because this configuration uses the certificate instead.

  14. To find the identity provider ID, run this request:

    curl --location --request GET 'https://anypoint.mulesoft.com/accounts/api/organizations/<YOUR_ORG_ID>/identityProviders' \
--header 'Authorization: Bearer <TOKEN>'

    Replace <YOUR_ORG_ID> with your organization ID and replace <TOKEN> with your token.

    In the response, find the line with the provider_id:

    "provider_id": "01234567-89ab-cdef-0123-456789abcdef",

  15. Copy this identity provider ID to use as the IDP ID.

Configure Users

Give your user the Exchange contributor permission:

  1. In your Anypoint Platform organization, click Access Management > Users.

  2. Select your user.

  3. Click Permissions > Add permissions.

  4. Ensure that your user has the permission Exchange Contributor in each business group.

Give community users the Exchange viewer permission:

  1. Ensure that you have Exchange Administrator permissions.

  2. In your Anypoint Platform organization, navigate to Access Management and click Teams.

  3. Create a new team named Community Users.

  4. Click Settings.

  5. Set the parent team to everyone in the organization.

  6. In External IdP Groups, set Group Name to Community User and set Type to Member.

  7. Click Permissions > Add permissions and add the permission Exchange Viewer.

    When prompted, select all business groups with any assets that you want community users to be able to view.

Set Profile Permissions

After the connection with your Anypoint organization is established, click Continue to open the API Community Manager diagnostics tool, review your installation, and update the guest user and member user permissions. After the installation and permissions are verified, create your first community.

See Also