Skip to main content

Aprimo — Authentication

B
Written by Ben Keeling

How to register a Client Credentials integration in Aprimo, add it to Medialake as an access key, and understand exactly what the connection can reach.



​

What to expect

Aprimo is connected with credentials that you create in your own Aprimo tenant. There is no Aprimo sign-in or consent screen during setup: nobody is redirected to Aprimo to log in. Instead, an Aprimo administrator registers an integration that uses the OAuth 2.0 Client Credentials flow, a Medialake administrator saves its Client ID, Client Secret, and your tenant name as an access key, and Medialake authenticates to Aprimo server-side from then on.

A Client Credentials registration acts on behalf of the user selected in the registration. Aprimo returns only the records that user is allowed to access, so the user — not the registration — defines what Medialake can see. We follow the principle of least privilege: the recommended setup uses a dedicated user with read and download rights only.

The Aprimo connector searches records, reads their fields and thumbnails, and downloads the latest master file of each record it syncs. To fetch a file it creates an Aprimo download order, which is how Aprimo's API delivers file content. It does not upload, edit, or delete records, files, fields, or classifications in Aprimo.

 Aprimo administrator       Medialake                  Aprimo
      │  register integration   │                         │
      │  (Client Credentials)   │                         │
      │──────────────────────────────────────────────────▶│
      │                         │                         │
 Medialake administrator
      │  save access key        │                         │
      │────────────────────────▶│                         │
      │                         │  client ID + secret     │
      │                         │  for access token       │
      │                         │────────────────────────▶│
      │                         │  short-lived token      │
      │                         │◀────────────────────────│
      │                         │                         │
 Team member
      │  connect, choose        │                         │
      │  what to sync           │                         │
      │────────────────────────▶│                         │
      │                         │  search records,        │
      │                         │  download files         │
      │                         │────────────────────────▶│


​

Before you begin

You will need:

  • Aprimo rights to create integration registrations. Aprimo's documentation lists the Security or System Administration domain right for this.

  • Your Aprimo tenant name: the first part of your Aprimo address. For https://yourcompany.dam.aprimo.com, the tenant name is yourcompany.

  • Administrator privileges in Medialake, to save the access key.

>Keep the credentials private. Aprimo cannot show a registration's Client Secret again later. Store it in an approved password manager or secret-management system. Do not email it, paste it into a support ticket, or commit it to source control. Medialake stores the values you enter encrypted and never shows them again.


​

Step 1: Choose a dedicated Aprimo user

Every request Medialake makes runs as the user you select in the registration, with that user's permissions.

  1. In Aprimo, create a dedicated user for the integration, for example medialake_readonly, or choose an existing user that is not tied to a person.

  2. Give the user access to the records Medialake should sync, and permission to download their files.

  3. Do not give the user rights to create, edit, or delete content, or to administer Aprimo.

Using a dedicated user rather than a personal account keeps the connection independent of any individual and makes its access easy to review and revoke.


​

Step 2: Register a Client Credentials integration in Aprimo

  1. In Aprimo, open the integration registrations page. Aprimo's documentation places it at Administration → Integration → Registrations.

  2. Click New and give the registration a recognizable name, such as Medialake.

  3. Set OAuth Flow Type to Client Credentials.

  4. In User, select the dedicated user from Step 1.

  5. Set the Client Secret and store it securely. Medialake accepts a secret of 16 to 128 characters with no spaces.

  6. Optionally adjust the Access Token Lifetime. Medialake requests a new token whenever one expires, so any value works.

  7. Save the registration and copy its Client ID.

Aprimo notes that a new registration can take up to 15 minutes to take effect.

Medialake requests only the api scope, which is Aprimo's scope for REST API access.


​

Step 3: Add the credentials to Medialake

You need administrator privileges in Medialake for this step.

  1. In Medialake, open Administration → Integrations from the sidebar.

  2. Open the Aprimo integration.

  3. In the Access Keys section, click Create New Setting.

  4. In the New access key panel, enter a Name for the key, for example Marketing Aprimo app. The name is shown in the access key list and next to every account that connects with it.

  5. Under Credentials, fill in each field:

| Field | What to enter |

| --- | --- |

| Aprimo Client ID | The Client ID from Step 2. |

| Aprimo Client Secret | The Client Secret from Step 2. |

| Aprimo Tenant | Your tenant name only, for example yourcompany. Do not enter https://, .aprimo.com, or a full URL. |

  1. Under Who can use it?, choose the teams that can connect Aprimo with this key, or make it available to all teams.

  2. Click Save access key.

Medialake checks the format of each value before saving: the Client ID must be 8 to 64 letters, numbers, periods, underscores, or hyphens; the Client Secret must be 16 to 128 characters with no spaces; and the tenant name may contain only letters, numbers, and hyphens.


​

Connect Aprimo and choose what to sync

With the access key saved, any team member who is allowed to connect sources, on a team that can use the key, can add Aprimo:

  1. Open Connections → Catalogue from the side menu.

  2. Find Aprimo and click Connect.

  3. Under Access key, select the key saved in Step 3.

  4. Optionally click Test to check the credentials with Aprimo before connecting.

  5. Click Connect.

There is no Aprimo login screen. Medialake requests an access token from https://yourcompany.aprimo.com/login/connect/token using the Client Credentials grant, then calls Aprimo's REST API at https://yourcompany.dam.aprimo.com.

Aprimo content is offered as three preset searches rather than a folder tree. Each one can be selected, but not opened:

Selection

What it syncs

All Assets (Images & Videos)

Records that have a file and whose content type is image or video.

All Records

Every record that has at least one file.

All Records Since 2024

Records that have a file and were created on or after January 1, 2024.

Nothing is synced until you select at least one of them. For each record, Medialake syncs the latest version of the master file, and skips records whose file type Medialake does not support. A new Aprimo source syncs automatically once a week by default; you can change this to daily or monthly.


​

Limiting what Medialake can access

Aprimo enforces what the connection can reach through the registration's user. The credentials can only access records that user can access, so restricting that user's rights is the strongest control.

The selections you choose in Medialake control what is synced, but they do not narrow the credentials themselves. For the narrowest possible connection, give the registration's user access only to the content that needs syncing, and review its rights periodically.


​

What Medialake can and cannot do

With the configuration above, Medialake can:

  • Request access tokens with the registration's Client ID and Client Secret

  • Read the list of field groups, to confirm the credentials work

  • Search the records the registration's user can access

  • Read record fields, file details such as name, extension, size, and dates, and thumbnails

  • Look up classification names, so that classification and option-list field values appear as readable labels

  • Create a download order for the latest master file of a synced record, with Aprimo's notifications for that order turned off, and download the delivered file

Medialake does not:

  • See any Aprimo user's password

  • Access records the registration's user cannot access

  • Upload, replace, edit, or delete records, files, fields, or classifications

  • Change users, registrations, or settings in Aprimo


​

Staying connected

Aprimo access tokens are short-lived. When Aprimo rejects an expired token, Medialake requests a new one with the stored Client ID and Client Secret and retries the request. No sign-in or user action is needed.

The connection stops working, and the source is marked unauthorized in Medialake, if Aprimo refuses the stored credentials. That happens when the registration is deleted, or its user is deactivated or loses access. To restore it, save a new access key with working credentials and switch the source to that key. To switch, open the source's General tab, click Change Key in its Access Keys section, select the new key, and click Save.

If Aprimo returns a temporary error or asks Medialake to slow down, Medialake waits and retries automatically.


​

Revoking access

To revoke Medialake's access from Aprimo:

  • Delete the integration registration created for Medialake.

  • Alternatively, deactivate the registration's user, which removes the permissions the registration acts with.

In Medialake, an administrator can also delete the access key from the Aprimo integration's Access Keys section. Remove the Aprimo source in Medialake as well if it should no longer sync.


​

Troubleshooting

Symptom

What to check

"The Aprimo Tenant format is invalid." when saving

Enter only the tenant name, for example yourcompany, without https://, dots, or .aprimo.com.

"The Aprimo Client Secret format is invalid." when saving

The secret must be 16 to 128 characters with no spaces. Check for spaces picked up when pasting. If your secret is shorter, register a new integration with a longer one, because Aprimo does not let you change a registration's secret.

"The Aprimo Client ID format is invalid." when saving

The Client ID must be 8 to 64 letters, numbers, periods, underscores, or hyphens. Check for spaces picked up when pasting.

"A setting with this title already exists in the group. Choose a different title."

Another Aprimo access key already uses that name. Choose a different Name.

Test reports "The provider rejected these credentials."

Check the Client ID, Client Secret, and tenant name, and that the registration's OAuth Flow Type is Client Credentials. A registration created in the last 15 minutes may not have taken effect yet.

Test reports "These credentials look right, but the provider couldn't confirm them just now."

Aprimo did not give a definite answer, for example because of a temporary error. Try again in a few minutes.

"No integration settings available for this service." when connecting

No Aprimo access key is available to your team. Ask a Medialake administrator to save one, or to add your team under Who can use it?

The source becomes unauthorized

The registration was deleted, or its user was deactivated or lost access. Save a new access key with working credentials and switch the source to it.

An expected record is missing

The registration's user cannot access it, it has no file, its file type is not supported, or it falls outside the selected search (for example, created before 2024 for All Records Since 2024).

A record appears but its file will not download

Confirm the registration's user can download that record's master file in Aprimo.

If the issue continues, contact [email protected] with your tenant name, the access key's name, and the error message. Do not include the Client Secret.


​

Further reading


Questions about connecting Aprimo? Contact [email protected].

Did this answer your question?