ÃÛ¶¹ÊÓƵ

DocumentationCampaignCampaign Classic v7 Documentation

Create your ÃÛ¶¹ÊÓƵ technical account create-service-account

Last update: Fri Nov 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Beginner
  • User
  • Admin

Server-to-Server authentication credentials allow your application’s server to generate access tokens and make API calls on behalf of your application itself.

Migrate existing integrations migrate-jwt

The Service Account (JWT) credential is being deprecated by ÃÛ¶¹ÊÓƵ. Campaign integrations with ÃÛ¶¹ÊÓƵ solutions and apps must now rely on OAuth Server-to-Server credential.

If you have implemented inbound or outbound integrations with Campaign before June 2024, you must upgrade your Campaign environment to v7.4.1 and migrate your Technical Account to oAuth as detailed . Existing Service Account (JWT) credentials will continue to work until January 27, 2025.

Once migration is done, you must associate your new credential to Campaign as explained in this section.

Create new OAuth technical account for new integrations oauth-service

To create your OAuth technical account for new integrations, follow these steps:

  1. Access ÃÛ¶¹ÊÓƵ Developer console and log in as System Administrator of your Organization.

    For more information on Admin roles, refer to this .

  2. Click Create a new project.

  3. Click Add to Project and select API.

  4. Select the product you want to integrate with Campaign and click Next.

  5. Choose OAuth Server-to-Server as authentication type and click Next.

  6. Select the Product profile link to your project.

    You can create a new one if needed.

  7. Then, click Save Configured API.

  8. From your project, under Credential select OAuth Server-to-Server and copy the following information:

    • Client ID
    • Client secret
    • Technical account ID
    • Organization ID

Add OAuth project credentials in Campaign add-credentials

Once the steps above have been executed, add your OAuth project credentials in ÃÛ¶¹ÊÓƵ Campaign.

NOTE
As a hosted or Managed Cloud Services customer, this steps is not needed: ÃÛ¶¹ÊÓƵ has already added your OAuth project credentials to your environment.

As an on-premise or hybrid customer, follow these steps:

  1. Login via SSH to each container where the ÃÛ¶¹ÊÓƵ Campaign instance is installed.

  2. Add your OAuth project credentials in ÃÛ¶¹ÊÓƵ Campaign by running the following command as neolane user. This will insert the Technical Account credentials in the instance configuration file.

    code language-none 
    nlserver config -instance:<instance_name> -setimsoauth:ims-org-id/client-id/technical-account-id/client-secret
    note note
    NOTE
    For versions older than 7.4.1, use setimsauth or setimsjwtauth instead of setimsoauth.
recommendation-more-help
601d79c3-e613-4db3-889a-ae959cd9e3e1