DocumentationCommerceGetting Started

Configure the Commerce Admin Integration with Adobe ID

Last update: February 6, 2025
  • Topics:
  • Identity Management

CREATED FOR:

  • Beginner
  • Intermediate
  • Admin
  • Leader
  • User
Adobe Commerce feature Exclusive feature only in Adobe Commerce (Learn more)

This integration supports Commerce merchants with Admin users who have an Adobe ID and who want to streamline login to Adobe Commerce and Adobe Business products. It is optional and is enabled on a per-instance basis. Only Admin user workflows are affected when enabled.

IMPORTANT
Admin users should save their Commerce Admin credentials (username and password) and 2FA credentials before enabling this integration. These credentials are needed if the IMS integration is disabled.

Prerequisites

  • Adobe Commerce 2.4.5 or later
  • An Adobe.com account with access to the Adobe Admin Console.

The administrator who configures this integration needs the following credentials during module enablement:

  • Organization ID (obtained from Adobe Admin Console), which must be at least 24 characters in length. The authenticated user must belong to this IMS organization. For information about finding your organization ID, see Organizations in Experience Cloud.
  • 2FA should be enforced on the Organization level in Adobe Admin Console to enable the module. Check Authentication setings.
  • Client ID
  • Client secret
  • Client ID and client secret are available after retrieving API keys from the Adobe Developer Console.

Commerce Admin users must create an account with an Adobe ID to log in.

General steps

  • Get Adobe Org ID from the Adobe Admin Console
  • Generate a new project, IMS API keys, and secret from the Adobe Developer Console
  • Configure Adobe Commerce users in the Adobe Admin Console
  • Enable the AdminAdobeIms module.

A successful integration requires that all Adobe Commerce users have Admin user accounts with the same name and primary email address. If a matching Admin user account does not exist, a user with the required permissions (typically assigned the Administrator role) must manually create the Admin user account with the same name and email.

Configure the integration

After the followings steps are completed by an administrator or developer with system access, the Sign into Adobe Commerce with Adobe IMS button is displayed in the Commerce Admin login page for all Admin users.

Step 1: Get Adobe Org ID

Membership in at least one IMS organization is required to enable this feature. If you have an Adobe ID, you belong to at least one Adobe organization by default. Log in to the Adobe Admin Console to retrieve your organization ID.

Step 2: Generate a new project, IMS API keys, and secret

To create projects for an organization, the Adobe Admin account for the organization must have the system administrator or developer role. See the Developer Console Guide.

  1. Log in to Adobe Developer Console.

  2. Go to the Projects tab (adobe.io/projects) and click Create a new project.

  3. Click Add API on the newly created Project page.

  4. Select Adobe Services > Adobe Commerce with Adobe ID.

  5. Select Oauth 2.0 Web.

  6. Specify the Redirect URI: https://<hostname>/admin/adobe_ims_auth/oauth/imscallback/

  7. Specify the Redirect URI pattern: https://<hostname>/admin/adobe_ims_auth/oauth/imscallback/

    Escape any dots in the hostname by preceding the dots with \\. Adding a wildcard to the end of the URL supports the Adobe Commerce Admin secret key.

  8. Click Save configured API.

  9. Copy the Client ID and Client Secret keys from the created project.

Step 3: Configure Adobe Commerce users in the Adobe Admin Console

Before enabling the integration, verify that each Adobe Commerce Admin user account has a corresponding Adobe IMS account. Adobe Commerce users must belong to a specific Adobe organization to log in using an Adobe ID.

TIP
You can create multiple user accounts by uploading the user information from a CSV file. See Manage multiple users.

  1. In the Adobe Admin Console, navigate to Users > Users.

  2. Click Add User.

  3. Enter the email address of the user.

    If applicable, the recommended ID Type is populated automatically. You can change this setting to one of the product IDs in the list, which is based on your organization’s purchase plan.

    You can add up to ten users at one time. To add more, repeat the preceding steps after saving your changes.

  4. Click Save.

The user is added and displayed in the Users list.

Step 4: Enable the AdminAdobeIms module

The AdminAdobeIms module is responsible for the Adobe Commerce/Adobe IMS integration. After setting up the new project and copying your organization ID, client ID, and client secret, you can enable the AdminAdobeIms module.

Enter bin/magento admin:adobe-ims:enable. You are prompted to enter the following parameters. Use the values that were generated during project creation.

  • Organization ID
  • Client ID
  • Client secret
  • 2FA enabled

Adobe Commerce displays a message that indicates whether enablement succeeded or failed.

After successfully enabling this feature, you can transition other Adobe Commerce user accounts to Adobe IMS accounts. Adobe Commerce users must belong to the configured Adobe organization to log in using an Adobe ID.

recommendation-more-help
31746fd0-1ead-45b5-9192-1aaf582c5f66