- Print
- DarkLight
Connection
Dedicated OAuth App
LumApps supports an extension for OAuth authentication through the API with client credentials flow.
Creating an OAuth App
LumApps allows an OAuth client credentials flow to interact with its API. To configure an OAuth app, you will need admin access to your instance settings page. You will need to share with your Unleash Representative the following information.
Application ID
Application Secret
Customer ID
Site Url (Haussman Cell)
Email of an admin user
On the settings page, under the extensions section, click on Installed Extensions.
Search for the OAuth application manager and ensure it is activated.
If the OAuth application manager extension is not installed, install it from the Extension Library.
From the Settings tab of the extension, click on Add a new OAuth Application.
Name the application Unleash.
You can choose if you want to impersonate a specific user or impersonate any user.
Save and copy the new Application ID and Application Secret.
Grab additional instance details by pressing CTRL+? or CTRL+SHIFT+?.
The shortcut will open a Debug Info window.
Copy the Customer ID and Haussman Cell.
Domain Delegation
As documented here, the LumApps connection supports an OAuth2 service account delegation flow. Unleash has created a service account that needs to be shared with the LumApps team. Contact the LumApps team at support@lumapps.com
and provide them with access to the Unleash service account - 780897467552-pkmkek4fecblgj2j24cbr97q27q856dp.apps.googleusercontent.com
.
LumApps does not have a self-serve connection screen. If you wish to connect it, please contact your Unleash representative for assistance.
You will need to prepare the following:
Site URL - Your LumApps instance URL.
Customer ID.
Email - An email of the user on whose behalf you want to act.
The email affects which resources will be synced to Unleash based on that user's permissions.
Supported Resources
The integration currently supports the following resources:
Pages
Posts
Sync
The integration does not support incremental updates, and therefore sync is scheduled every 24 hours.
API Calls
The table below outlines the primary endpoints utilized by the integration:
Endpoint | Docs | Purpose |
---|---|---|
/api/lumsites/v1/instance/list | https://neptune-dot-lumapps-api.appspot.com/docs/instance/list | List all available instances for customer |
/api/lumsites/v1/community/post/list | https://neptune-dot-lumapps-api.appspot.com/docs/community/post/list | List all posts |
/api/lumsites/v1/content/lis | https://neptune-dot-lumapps-api.appspot.com/docs/content/list | List all pages |
/api/lumsites/v1/user/directory/get | https://neptune-dot-lumapps-api.appspot.com/docs/user/directory/get | Fetch user information |
Example Questions
What is the paternity leave policy at ACME for the USA branch?
Who manages access to LumApps groups?
How do I reset my LumApps password?
Who is the admin for LumApps in our organization?
What is the process for creating a new community in LumApps?