Integration with Lucca
Overview
This guide walks you through the steps required to integrate Lucca with MangoApps. It includes setup instructions, roles needed, security information, testing tips, and rollout best practices to ensure a successful implementation.
This integration supports automatic user provisioning and de-provisioning, user profile synchronization, and optional syncing of leave and absence data. Once configured, MangoApps will regularly pull data from Lucca based on the configured mappings.
Required Roles
To complete this integration, the following roles are required:
Lucca Administrator: Must have admin access to the Lucca instance to generate API keys and configure permissions.
MangoApps Administrator: Must have admin access to the MangoApps Admin Portal to set up and manage the integration.
Lucca Side Setup
This section outlines how to prepare your Lucca account for integration with MangoApps.
Sign in to Lucca and go to the Home page.
Locate your Lucca domain from the browser URL. For example, if your URL is https://merge.ilucca-demo.net/home, your domain is merge.ilucca-demo.net.
Generate an API Key
Click the gear icon (top-right corner), then select API Keys.
Click Generate a new API Key.
Name your key and assign these permissions:
consult/create/modify users(required)consult leaves(optional)make absence requests(optional)Provide a technical contact email.
In API key usage, choose Third-party publisher.
Click Generate a new API key.
Configure Role Permissions for the API Key
Click the Role Administration link after key generation.
Under the Co-workers tab, add these permissions:
see future employees(required)see former employees(required)view employee jobs(optional)view employee managers(optional)view employee qualification(optional)
Save the role configuration.
Copy the newly generated API Key for use in MangoApps.
MangoApps Side Setup
This section outlines the steps to configure MangoApps with your Lucca integration.
Go to the Admin Portal in MangoApps and navigate to Partner Integrations. Click the Add Integration button in the top right corner of the screen.
Select Lucca from the list integrations list.
Click "I am an admin" to proceed.
Review the read-only accesses MangoApps requests from Lucca and click Next.
Enter your Lucca domain in the domain field.
Enter the API Key copied from Lucca and click Next to complete the setup.
Once setup is complete, MangoApps will initiate the first sync. During this time, user mapping configuration will be unavailable until the sync finishes.
Configure User Mapping
After the initial sync, click Configure User Mapping.
In the pop-up menu, review and match Lucca fields to MangoApps profile fields.
Click Reset to System Default if you wish to start over from the default configuration.
If additional fields are needed, create custom profile fields in Admin Portal > Modules > People > Full Profile.
Save your mapping once complete.
Testing Considerations
Before going live, validate the integration:
Ensure that user data is syncing accurately.
Check that required fields are mapped correctly.
Test the de-provisioning flow by deactivating a user in Lucca and confirming their status updates in MangoApps after the next hourly sync.
Review optional data sync (leaves, job roles) if those permissions were enabled.
Security Considerations
This integration maintains strong security by:
Using API Keys for secure, scoped access.
Requiring admin permissions on both platforms to initiate the setup.
Supporting read-only access review prior to activation.
Automatically syncing user status to minimize manual user management.
Ensure that the technical contact listed in Lucca receives key lifecycle notifications.
End User Experience
End users will benefit from:
Seamless onboarding: Users are automatically created and updated in MangoApps based on Lucca data.
Consistent profiles: Profile fields reflect the most current data from Lucca.
No additional login steps: This is a backend sync, so no user action is needed.
If a user is deactivated in Lucca, they will automatically lose access in MangoApps after the next sync.
Rollout Recommendations
To ensure a smooth deployment:
Pilot the integration with a small user group.
Confirm mappings and test sync outcomes.
Train admins on how to update user mappings and custom fields.
Communicate changes to end users (if needed), especially around automatic de-provisioning.
Monitor syncs post-rollout using MangoApps Admin tools to ensure everything runs smoothly.
Last updated