Skip to main content

​
After this article

You will be able to connect Contentful to Lumos to sync organization users for Access Reviews and offboarding, and to remove users from your Contentful organization when they are deprovisioned.

​
Capabilities

​
Required plan and roles

  • Contentful plan: your organization needs the Enterprise or Premium plan. The integration requires access to the Contentful User Management API.
  • Contentful role: the person connecting must be able to view the Organization Settings page (needed to retrieve the Organization ID).
  • Permission scoping: Lumos reads organization users and can remove a user’s organization membership (deprovisioning). It does not create users or manage other Contentful resources.

​
Read-only access vs provisioning

Is read-only possible? No, the scopes Lumos requests will have all read information as well as the ability to deprovision users. Watch out for. The connector only removes a user’s organization membership. It does not create Contentful users, and it does not manage other Contentful resources beyond organization membership. If your plan is below Enterprise or Premium, the User Management API is not available and the connection or sync fails.

​
Instructions

Phase 1: Find your Organization ID in Contentful
  1. Log in to Contentful at app.contentful.com and select the correct Contentful Organization.
  2. Click the Organization name in the top-left corner and open the Organization Settings and Subscriptions page.
  3. Get the Organization ID from the URL. For example, app.contentful.com/account/organizations/lumos has the organization ID lumos.
Phase 2: Connect in Lumos
  1. Find the Contentful card in your Lumos integrations (reconnect an existing card or add a new one).
  2. Paste your Organization ID into the field before hitting Connect Integration.
  3. Click Connect.

​
API Endpoints Used

​
Troubleshooting

Connection fails or no users sync. Confirm your Contentful plan is Enterprise or Premium. The User Management API isn’t available on lower plans. Wrong or unrecognized Organization ID. The Organization ID is the URL slug on the Organization Settings page (app.contentful.com/account/organizations/<org-id>), not the display name. Make sure you copied it from the organization you intend to connect.