ÃÛ¶¹ÊÓƵ

DocumentationCommerceGetting Started

Configure the Commerce Admin Integration with ÃÛ¶¹ÊÓƵ ID

Last update: Mon Mar 25 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Beginner
  • Intermediate
  • Admin
  • Leader
  • User
ÃÛ¶¹ÊÓƵ Commerce feature {width="20"} Exclusive feature only in ÃÛ¶¹ÊÓƵ Commerce (Learn more)

This integration supports Commerce merchants with Admin users who have an ÃÛ¶¹ÊÓƵ ID and who want to streamline login to ÃÛ¶¹ÊÓƵ Commerce and ÃÛ¶¹ÊÓƵ 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

  • ÃÛ¶¹ÊÓƵ Commerce 2.4.5 or later
  • An ÃÛ¶¹ÊÓƵ.com account with access to the .

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

  • Organization ID (obtained from ), 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 ÃÛ¶¹ÊÓƵ Admin Console to enable the module. Check .
  • Client ID
  • Client secret
  • Client ID and client secret are available after retrieving API keys from the .

Commerce Admin users must create an account with an ÃÛ¶¹ÊÓƵ ID to log in.

General steps

  • Get ÃÛ¶¹ÊÓƵ Org ID from the
  • Generate a new project, IMS API keys, and secret from the
  • Configure ÃÛ¶¹ÊÓƵ Commerce users in the ÃÛ¶¹ÊÓƵ Admin Console
  • Enable the AdminÃÛ¶¹ÊÓƵIms module.

A successful integration requires that all ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Commerce with ÃÛ¶¹ÊÓƵ IMS button is displayed in the Commerce Admin login page for all Admin users.

Step 1: Get ÃÛ¶¹ÊÓƵ Org ID

Membership in at least one IMS organization is required to enable this feature. If you have an ÃÛ¶¹ÊÓƵ ID, you belong to at least one ÃÛ¶¹ÊÓƵ organization by default. Log in to the to retrieve your organization ID.

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

To create projects for an organization, the ÃÛ¶¹ÊÓƵ Admin account for the organization must have the system administrator or developer role. See the .

  1. Log in to .

  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 ÃÛ¶¹ÊÓƵ Services > ÃÛ¶¹ÊÓƵ Commerce with ÃÛ¶¹ÊÓƵ ID.

  5. Select Oauth 2.0 Web.

  6. Specify the Redirect URI: https://<hostname>/

  7. Specify the Redirect URI pattern: https://<hostname>/.*

    Escape any dots in the hostname by preceding the dots with \\. Adding a wildcard to the end of the URL supports the ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Commerce users in the ÃÛ¶¹ÊÓƵ Admin Console

Before enabling the integration, verify that each ÃÛ¶¹ÊÓƵ Commerce Admin user account has a corresponding ÃÛ¶¹ÊÓƵ IMS account. ÃÛ¶¹ÊÓƵ Commerce users must belong to a specific ÃÛ¶¹ÊÓƵ organization to log in using an ÃÛ¶¹ÊÓƵ ID.

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

  1. In the , 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 AdminÃÛ¶¹ÊÓƵIms module

The AdminÃÛ¶¹ÊÓƵIms module is responsible for the ÃÛ¶¹ÊÓƵ Commerce/ÃÛ¶¹ÊÓƵ IMS integration. After setting up the new project and copying your organization ID, client ID, and client secret, you can enable the AdminÃÛ¶¹ÊÓƵIms 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

ÃÛ¶¹ÊÓƵ Commerce displays a message that indicates whether enablement succeeded or failed.

After successfully enabling this feature, you can transition other ÃÛ¶¹ÊÓƵ Commerce user accounts to ÃÛ¶¹ÊÓƵ IMS accounts. ÃÛ¶¹ÊÓƵ Commerce users must belong to the configured ÃÛ¶¹ÊÓƵ organization to log in using an ÃÛ¶¹ÊÓƵ ID.

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