Subscriptions

A subscription connects an application to a Tealium API. When you subscribe, you select scopes that determine which resources and actions the application’s access tokens cover. You must create at least one application before you can subscribe to APIs. For more information, see Applications and Scopes.

We recommended subscribing to APIs through the application process. For more information, see Applications.

Subscribe to an API from the API Catalog

If you already have an application configured, you can subscribe to an API directly from the API catalog:

1. Go to API Catalog and select an API.
2. Click Subscribe.
3. Select a plan and click Next: Select Scopes. Plans determine the security mechanism (for example, OAuth2 or JWT) and may have different rate limits.
4. Select scopes and click Next: Select Application. Check the resource and action pairs your application needs. Tokens include only the scopes you select.
5. Select the application for this subscription and click Next: Review.
6. Select accounts and profiles (Tealium users only). Select the Tealium accounts and profiles this subscription should have access to.
7. Review and click Confirm Subscription.

Subscribe an existing application to additional APIs

1. Navigate to Applications and select an application.
2. Click Subscribe to APIs.
3. Select the APIs you want to subscribe to and click Next: Configure Scopes.
4. Select scopes. Check each resource and action pair your application needs. Tokens include only the scopes you select. Request only what your application requires. When you are done, click Next: Review.
5. Select accounts and profiles and click Next: Review.
6. Select engines (if applicable). For APIs that require engine-level access, such as the Moments API, a Select Engines step appears. Choose specific engines per profile, or select All engines (current and future) to include engines added later. You can skip this step and grant engine access later.
7. Review your configuration and confirm.

Engine selection

The engine selection step appears when one or more APIs in the subscription require engine-level authorization. Engines are grouped by account and profile.

• Select individual engines by name or ID.
• Select All engines (current and future) to grant a wildcard that automatically includes engines created after the subscription.
• Disabled engines can still be selected. They appear with a disabled badge.
• Engine selection is optional. If you skip this step, the application has no engine access until a resource owner grants it via Third-Party App Access.

For more information on granting engine access to third-party applications, see Third-party app access.

Subscription status

After you subscribe to an API, the subscription enters one of the following states:

Manage subscriptions

Go to the Subscriptions to view all subscriptions across your applications. You can filter the list by application or by API using the dropdowns at the top of the page. Hover over a scopes chip to see the specific permissions assigned to that subscription.

To edit or close a subscription, go to the application details page and open the Subscriptions section.

Edit a subscription

You can add or remove account access and scopes on an active subscription at any time.

1. Go to the application details page.
2. Open the Subscriptions section.
3. To edit accounts and profiles active on the subscription, click the edit icon next to Account Access.
4. To edit scopes, click the edit icon next to the subscription.
5. Add or remove scopes as needed.
6. Click Save.

Existing access tokens continue to work with their original scopes until they expire. Tokens expire after 1 hour. New token requests use the updated scope set.

If any resource owners have granted your application access to their accounts, changing scopes may trigger a scope drift notification for them to review the changes.