Lucid SCIM API

📘

This feature is only available to users on Enterprise accounts. To upgrade, visit our pricing page or contact our sales team.

Lucid offers user provisioning, de-provisioning, and group/team management via CRUD operations against the users and groups on your Enterprise account using our SCIM REST API.

We offer two distinct SCIM integrations depending on your organizational needs:

• SCIM for admin management: Syncs your identity provider with Lucid organizational groups.
• SCIM for content access: Syncs your identity provider with Lucid teams.

For a detailed technical overview of SCIM, see Simple Cloud. To access the REST API, follow the steps below.

Enabling SCIM

1. Verify your subscription: Ensure you have an active Enterprise subscription for a Lucid product.

2. Choose your integration: Determine whether you need to configure SCIM for admin management or SCIM for content access. For a breakdown of the differences between these two integrations, see our SCIM overview for Lucid.

3. Generate a SCIM bearer token: This token authenticates your API requests and dictates which integration you are interacting with. Navigate to the appropriate integration page in your admin panel to generate it:

   • Admin > App integration > SCIM for admin management
   • Admin > App integration > SCIM for content access
     
     

     Note: If setting up SCIM for admin management, you may need to enable Auto-purchase licenses in Lucid. This allows your identity provider to act as the source of truth for automatic user licensing and de-licensing.

4. Configure your SCIM provider: Add the bearer token to your identity provider. If you use one of our natively supported providers, follow their specific setup instructions:

   • Okta
   • Azure

   If you use a different provider or are building a custom integration, the remainder of this documentation will walk you through setting up these calls.

5. Verify your setup: Once configured, you can view active and inactive users directly in the Lucid Admin Panel. For more details, see our User Management article.

SCIM Endpoints

All Lucid SCIM endpoints start with the Lucid base URL. You can confirm this URL on the same page where you generated your SCIM bearer token (Step 3).

Lucid SCIM base URL: https://users.lucid.app/scim/v2

Note: The base URL may be different for accounts in FedRAMP-certified environments.

Bearer Token Authorization

Authorize your API requests using the HTTP Authorization header. Format it as follows, replacing the example string with the specific bearer token you generated for your desired integration in Step 3:

Authorization: Bearer 1502c55ad68b4f3acdc969a7179a1313