AEM Integration Setup Guide

​

Before you start

• An AEM as a Cloud Service program and Author environment
• AEM Cloud Manager access to commit to an Adobe-managed repository and run a config pipeline (Deployment Manager role required)
• Permissions to manage product profiles in the Adobe Admin Console and to create OAuth credentials in the Adobe Developer Console
• A Profound account

​

Setup guide

1

Select the AEM environment

• Open Adobe Cloud Manager.
• Sign in under the organization that owns the AEM program you intend to use with Profound.
• Select and open the program, then select Environments in the left sidebar.
• Open the environment you intend to use and copy its base Author URL. It should look like: https://author-p12345-e67890.adobeaemcloud.com.

2

Prepare your AEM environment for API access

To enable API access in your environment, follow Adobe’s AEM APIs setup guide.Once done, confirm that you have the correct product profile to use with the AEM API:

• Go back to your AEM program environment page in Adobe Cloud Manager (where you left off in Step 1).
• Open the environment’s action menu and select Manage Access > Author Profiles. Adobe Admin Console opens your environment’s page.
• Confirm that the AEM Sites Content Managers - author… profile exists for your program and environment.

3

Assign a Developer role to the credential creator

To authenticate with Profound, create an OAuth credential. You, or anyone with a Developer role in your AEM Sites Content Managers product profile, can create it.To assign a Developer role to the credential creator, continue where you left off in Step 2:

• On your environment’s page in Adobe Admin Console, select the AEM Sites Content Managers - author… product profile.
• Open the Developers tab, then select Add developers.
• Add the email or username of the person creating the OAuth credential, then select Save.

Learn more about assigning developers to Adobe product profiles in Adobe’s Manage developers in Adobe Admin Console guide.

4

Create the OAuth Server-to-Server credential

• Open the Adobe Developer Console. If you’re following these steps in sequence, you should already be signed in under the organization that owns your Author AEM environment (same as in Step 1).
• Select Create new project in the Quick start section, or go to Projects in the top navigation menu and select Create new project.
• On the project page, select Edit project, give your project a descriptive name (such as Profound integration credentials), then select Save.
• Select Add to Project > API.
• On the Add an API page, filter the API list by Experience Cloud, select AEM CS Sites Content Management, then select Next.
• Select Server-to-Server > OAuth Server-to-Server as the authentication type.
• Select the Author product profile you prepared in Step 2, then save the configuration.

The AEM Sites Content Management API also provides the folder access Profound uses. No additional credentials are required.

5

Retrieve the connection values

After you save the API configuration, Adobe Developer Console returns you to the project page. In the Credentials section, select your new OAuth Server-to-Server credential. From the credential page, copy the values you need to create the AEM integration in Profound:

• Client ID
• Client Secret
• Scopes — copy the complete value exactly as Adobe displays it
• Organization ID — optional; copy it only if the AEM tenant requires the x-gw-ims-org-id header

6

Register the client ID with the AEM environment

Before you can use the credential, register its client ID with your Author environment.

• Back in Adobe Cloud Manager, open the program and select Repositories in the left sidebar.
• Identify the Adobe-managed repository and branch used by your environment’s config pipeline.
• Select Access Repo Info and copy the repository URL and access credentials.
• Using your regular development workflow, clone the repository onto your machine and create or update the config/api.yaml file in the root directory with the following configuration:
  kind: "API"
  version: "1"
  metadata:
    envTypes: ["dev", "stage", "prod"]
  data:
    allowedClientIDs:
      author:
        - "<CLIENT_ID>"
  

Replace <CLIENT_ID> with the client ID you copied from Developer Console in Step 5.If you already have other API credentials configured, keep the existing configuration and add the client ID to the author list under allowedClientIDs.

Learn more about managing repositories and configuring pipelines in the following Adobe resources:

• AEM API client ID registration guide
• Manage repositories in Cloud Manager
• Use config pipelines guide
• Invoke OpenAPI-based AEM APIs using OAuth Server-to-Server authentication tutorial

7

Deploy API configuration with a config pipeline

• Still on your program page in Adobe Cloud Manager, select Pipelines in the left sidebar.
• Select Add Pipeline, then select Add Non-Production Pipeline for the development environment, or Add Production Pipeline for stage and production.
• In the Add Pipeline dialog, select Deployment Pipeline, give your pipeline a descriptive name, then select Continue.
• On the next screen, fill in the values as follows:
  • Select code to deploy: Targeted deployment
  • Include: Config
  • Eligible Deployment Environments: select your AEM environment from the dropdown
  • Repository, Git Branch, Code Location: the repository, branch, and config directory from Step 6
• Select Save.

Your new config pipeline appears in the list of pipelines in the Pipelines section. Select the pipeline, then select Run selected. Wait for the deployment to complete successfully.

Learn more about deploying config pipelines in the following Adobe resources:

• Use config pipelines guide
• Cloud Manager CI/CD pipelines overview

8

Add an AEM S2S integration in Profound

• In Profound, go to Integrations in the left sidebar.
• Search for Adobe Experience Manager (S2S) and select it.
• In the Adobe Experience Manager (S2S) integration view, select + Add account.
• In the Connect Adobe Experience Manager (S2S) dialog, enter the Author URL from Step 1 and the client secret, client ID, scopes, and organization ID you retrieved in Step 5.
• Select Connect account.

If the connection succeeds, your AEM environment appears in the list of connected accounts.Revoke Profound’s access to your AEM environment at any time by selecting Revoke in the integration account action menu.

9

Verify the connection

To make sure Profound has all the permissions it needs to work with your AEM environment, verify that the AEM Agent nodes run successfully.

• In Profound, create a new Agent, or open an existing Agent draft.
• Add the Adobe Experience Manager List Content Fragments and Get Content Fragment nodes, then select the connected AEM instance.
• Select Test node (a play icon) in the node configuration panel and confirm that the AEM output contains the expected data.
• If you intend to create or update content fragments with Profound Agents, test the Create Content Fragment and Update Content Fragment nodes the same way.

Delete test content directly in the AEM environment. Current Profound Agent nodes don’t include a delete operation.

​

Rotating AEM credentials

​

Rotate a client secret only

​

Rotate the entire OAuth credential

1. Generate a new credential as described in Step 4 of the setup guide.
2. Deploy the new client ID in config/api.yaml as instructed in Step 6 of the setup guide.
3. Update the credentials in Profound.

​

Best practices

• Use an Author environment only. Profound doesn’t connect to AEM Publish or Preview. Learn more about environments in AEM as a Cloud Service tutorials.
• Test the read and write Profound Agent nodes separately to verify their folder and repository permissions.
• Always store your client secret and other credentials in an approved secret manager, and never include them in screenshots, tickets, or source control.