How to migrate Adobe credentials from JWT to OAuth Server-to-Server

Adobe has deprecated Service Account (JWT) credentials in favor of the new OAuth Server-to-Server credentials.

While the Service Account (JWT) credentials have been marked as deprecated, they will continue to work until January 27, 2025. Therefore, you must migrate your application or integration to use the new OAuth Server-to-Server credential before January 27, 2025.

For Adobe information about the benefits of migrating, the deprecation timeline, and how to migrate, see https://developer.adobe.com/developer-console/docs/guides/authentication/ServerToServerAuthentication/migration/

To migrate:

Follow the migration documentation provided by Adobe to create your OAuth Server-to-Server credentials in the Adobe Developer Console.
Update the following properties in your adobeDataSupplier.yaml data supplier .yaml file with the migrated values:
- clientId
- clientSecret
- scope
- orgId
- technicalAccountId
- imsExchange
Remove the following properties used by the JWT:
- metascopes
- tokenExpTime
- privateKeyPath

For information about creating the OAuth Server-to-Server credentials in a new project, see Accessing Adobe Client Credentials under External data suppliers on the Adobe Analytics tab.

Example of a migrated configuration file: adobe-analytics/dataSuppliers/adobeDataSupplier.yaml

class: info.magnolia.analytics.adobe.datasource.AdobeDataSupplier
credentials:
  parameters:
    serviceUrl: https://analytics.adobe.io/api/exchan213/reports
    imsHost: https://ims-na1.adobelogin.com
    imsExchange: https://ims-na1.adobelogin.com/ims/token/v3
    companyId: <your companyId>
    clientId: <your clientId>
    clientSecret: <your clientSecret>
    scope: <your scope>
    orgId: <your orgId>
    technicalAccountId: <your technicalAccountId>
parameters:
  rsid: emagmgnl
  gFilterType: dateRange
  startDate: '2024-01-01'
  endDate: '2024-01-15'
  metricId: metrics/revenue
  dimension: variables/daterangeday

Feedback

DX Core

How to migrate Adobe credentials from JWT to OAuth Server-to-Server

Location

Main doc sections