Lucid Capabilities

After this article...

You'll understand the capabilities our Lucid integration provides, and how Lumos interacts with the Lucid API.

View users

The mapping between Lucid user statuses and Lumos user account statuses is below.

Lucid API endpoint: https://developer.lucid.co/scim/#get-all-users (we use the "active" field to determine a user's status)

View a user's entitlements

Lumos can retrieve the following user entitlements from Lucid.

• Role - Whether the user is a Billing Admin, Document Admin, Team Admin, etc.

• License - The Lucid products to which the user is licensed (Lucid, Lucidspark, LucidscaleCreator, LucidscaleExplorer).

Lucid API endpoints:

Role: https://developer.lucid.co/scim/#users (we use the "roles" list).

License: https://developer.lucid.co/scim/#users-resources (we use the "productLicenses" mapping)

Downgrade a user

In Lumos, downgrading a Lucid user changes their License to empty during the next Lucid sync.

In Lucid, this action removes all of the user's product licenses and add-ons. They'll be made a View-Only user that will be able to view and comment on documents, but not edit them. Downgrading a user will unassign all documents they've created. You'll need to visit the Lucid admin panel to reassign the documents to another licensed user within 30 days of downgrading.

Lucid API endpoint: https://developer.lucid.co/scim/#put-modify-user (we set the value to "false" for each "productLicenses" value mapped to the user, and set "addOns" to empty)

Suspend a user

In Lumos, suspending a Lucid user marks their Account Status as "Suspended" (or "Staged" if you've asked Lumos to enable this).

In Lucid, this action sets the user to inactive. This prevents them from logging in. We also remove all product licenses and add-ons, which will unassign all documents they've created. You'll need to visit the Lucid admin panel to reassign the documents to another licensed user within 30 days of downgrading.

Lucid API endpoint: https://developer.lucid.co/scim/#patch-modify-user (we set "active" to "false", and we also set the value to "false" for each "productLicenses" value mapped to the user, and set "addOns" to empty)).

Transfer data

In Lumos, transferring a user's Lucid data has no impact on their account status or listed entitlements.

In Lucid, this action transfers the following data from one user to another:

• Documents and folders owned by the fromUser. The toUser will also be given edit and share permissions to any team folder the fromUser has edit and share permissions for.

• Custom shape libraries

• Lucidscale objects (3rd party credentials, AWS accounts, GCP projects, and Azure subscriptions)

After transferring, the files and folders from the previous user will appear in the new user's Documents, under a folder called "From <previous_users_email_address>". After the transfer, the fromUser loses ownership of the objects described above. An email is also sent to both the fromUser and the toUser to notify them of the transfer.

By default, your Lucid Account Owner will be the recipient of documents that are automatically transferred upon delicensing or deleting a user. You can change the recipient of the transferred documents by navigating to the SCIM integration settings in the Lucid Admin Panel (more info here).

Lucid API endpoint: https://developer.lucid.co/rest-api/v1/#transfer-user-content71

Deprovision a user

In Lumos, deprovisioning a Lucid user marks their Account Status as "Deprovisioned".

In Lucid, this action permanently removes the user from Lucid. You'll need to visit the Lucid admin panel to reassign the documents to another licensed user within 30 days of deleting.

Useful links

Lucid API documentation