Restricted collections are hidden from view unless users have signed in to become entitled to the collections.

The product associated with a collection determines whether a collection is restricted. When you define a product, you can set the product type to Free, Entitled, or Restricted. As a general rule, the "Entitled" option is for commercial apps such as digital magazines that include purchase options (see Paywalls and article preview in AEM Mobile apps). The "Restricted" option is primarily used for apps that include direct entitlement sign-in to determine which content users are permitted to view.

Restricted collections are supported on all platforms: iOS, Android, Windows, and Desktop Web Viewer.

For additional details, watch the Use Restricted Collections video.

Restricted collections are hidden until the user signs in.

  1. In the Access tab of project settings, select Enable Entitlement and specify entitlement settings.

    For details, see Entitlement in AEM Mobile apps. If you want to create a custom sign-in experience such as allowing users to sign in through Facebook or Google, see Custom authentication in AEM Mobile apps.

  2. (Optional) In the Content tab of project settings, specify the default setting for collections.


    If most or all of your collections should be hidden unless the user signs in, select Restricted to set the default for new collections.

  3. Publish collections.

    Publishing a collection adds the Product ID to Products & Subscriptions (unless you created the Product ID beforehand and selected it when editing the collection).

  4. In the Products & Subscriptions section of the On-Demand Portal (, set the product type to "Restricted" for products that are associated with collections that should be hidden unless the user is entitled to them.

  5. Build a non-preflight app and test entitlement.

    Restricted collections should not appear as items in the app menu or as cards in browse pages until you sign in. To sign in, choose Account from the app menu, and then sign in. Once you sign in, the app checks the entitlement service to determine which collections the user is entitled to. Any restricted collection to which the user is entitled should appear in the app.

    Preflight apps do not support entitlement options.

Guidance for using restricted collections

If your app includes restricted collections, make sure that your browse page accounts for cards that can be shown or hidden. Avoid a "fixed-design" approach in which hiding or showing cards can fracture the design. Organize your content and design your cards and layouts to present a more consistent browse page regardless of whether the user is signed in.

Design a browse page that works well whether a user is signed in (left) or not signed in (right).

If users are entitled to a collection, they have access to all articles in the collection but not necessarily to sub-collections.

You have the option of using a restricted collection as a "gateway" to content. In other words, all content within a restricted collection can be free, but the only way to see the collection is through signing in. If you use a restricted collection as a gateway, be aware that using navto:// links to articles or collections behind the paywall might allow users access to content that they should not have access to.

Limitations and restrictions

There is a limit of 100 restricted collections within a parent collection. There is no overall limit of restricted collections.

If you change the product type to or from Restricted, you must re-publish the collection associated with that product. You don't need to re-publish the parent collection.

At this time, if you create a navto link to a restricted collection, the collection browse page will appear even if the user is not entitled to that collection. In the near future, the plan is to include a paywall for browse pages of restricted collections. Until that feature is implemented, we recommend that you avoid navto links to restricted collections.