Developer tools in Lucid

Written by:  Ashley M
Last updated:  

Developer tools enable users on Team and Enterprise accounts to create, test, and distribute apps built on Lucid’s REST and extension APIs. Read this article to learn how to add Developer tools to your account as a user, and how to permit or restrict access as an admin.

Plan availability: Team and Enterprise.

Developer tools basics

With the Developer platform, users on Team and Enterprise accounts can build their own applications for:

  • External embeds
  • Internal embeds
  • Lucid Cards
  • Shape libraries
  • Data syncing and visualization 

There are two ways to make Developer tools available for a user:

  • Users on the account can opt themselves in through Account Settings.
    • This does not grant the developer role. Roles can only be assign by an admin.
  • An account owner and account admins can assign a user the developer role in the Lucid admin panel.

Developer tools are available to all users on Team and Enterprise accounts. Enterprise account admins can restrict access to Developer tools in the Lucid admin panel.

Developer tools include the Developer portal and the Developer menu. The Developer portal allows you to create new apps and OAuth 2.0 credentials, and is where you can distribute apps.

the-lucid-developer-portal.png

The Developer menu in the Lucidchart and Lucidspark editors allow developers to test apps built on Lucid’s Extension API.

Tip: If you have questions or want to share what you're building, post in the Lucid for Developers Community space. For an additional resource, see the Lucid Development Guide

Developer tools opt-in

If you are a licensed user on a Team or Enterprise account and you want to use Developer tools, follow these steps:

  1. Log in to your Lucid account.
  2. Click your profile image or initials in the upper-right corner.
  3. Select Account Settings.
  4. From the menu to the left, select User Settings.
  5. Scroll down to “Developer Settings”.
  6. Click the box to “Enable Developer tools”.
    access-developer-tools-in-account-settings.png

Note: If you are unable to complete these steps, it is likely that you are either an unlicensed user or your admin has restricted licensed users' ability to opt in to Developer tools through Account Settings. If you want to use Developer tools, first confirm in Account Settings that you are currently licensed and then contact your admin to be granted Developer role permissions. Opting in to Developer tools in your Account Settings does not grant you the developer role. 

Access the Developer portal

To access and create new apps, open the Developer portal by following these steps:

  1. Navigate to the Lucid Home Page.
  2. Select Developer from the bottom-left of the navigation menu.

Access the Developer menu

To open the Developer menu and test apps built on Lucid’s Extension API:

  1. In a Lucid document, open the More menu.
  2. Hover your cursor over "Developer".

how-to-access-the-developer-menu-in-lucidspark.png

For admins: Assign the developer role enterprise-tag.png

The developer role is only available on Enterprise accounts. The account owner and account admin can assign the developer role to a user on the account and grant them access to Developer tools, even if access to “Developer controls” is restricted in the Lucid admin panel. Here’s how:

  1. Log in to your Lucid account.
  2. Select Admin from the left-side panel.
  3. Click Users in the left-side menu.
  4. Select a user, or multiple users, by checking the box(es) on the far left-hand side of the user’s row.
  5. Click Actions.
    • Alternatively, you can clickthree dot icon in custom shape library.png the three-dot actions menu on the far right-hand side of a user’s row.
  6. Select Edit Roles.
  7. Check the box next to “Developer privileges”.
  8. Click Confirm.

To revoke developer role privileges from a user on your account, follow the steps above and uncheck the box next to “Developer privileges”.

Note: Account owners have the developer role by default. However, for security, account admin don’t have the developer role by default and cannot assign it to themselves. 

For admins: Manage SCIM API enterprise-tag.png

A SCIM bearer token is needed for an app to use Lucid’s SCIM API, which is only accessible by the account owner and account admin.

To obtain the SCIM bearer token:

  1. Select Admin from the left-side menu.
  2. Expand the “App integration” dropdown from the left-side menu.
  3. In the “Enabled integrations” section of the page, locate the SCIM app tile.
  4. Select Settings.
  5. Copy the generated bearer token.

Note: To regenerate a bearer token, repeat steps 1-5 as outlined above.

For admins: Restrict access enterprise-tag.png

Developer controls are only available on Enterprise accounts. When Developer controls are toggled off, users cannot enable Developer tools themselves through their Account Settings.

However, even when Developer controls are restricted at the account level, the account owner and account admin can still assign Developer role permissions to select users, which grants them access to use Developer tools.

To restrict access to Developer tools and disable users’ ability to opt themselves in:

  1. In your Lucid account, select Admin from the left-side panel.
  2. Click Security in the left-side menu.
  3. Select User feature controls from the menu to the left.
  4. Under “Developer controls”, click the toggle next to “Allow users to unlock developer tools”.
  5. Click Save changes in the upper-right corner.

section-of-the-lucid-admin-panel-to-restrict-access-to-developer-tools.png

Note: If you restrict access to Developer tools in the Lucid admin panel after the developer role has been granted to users, you will also need to remove developer role privileges from those users individually to revoke their access.

Give feedback on this article

Have feedback about this article? Tell us about your experience here

Did you find what you were looking for?

Still have a question or want to share what you have learned? Visit our Community   to get help and collaborate with others.