For the complete documentation index, see llms.txt. This page is also available as Markdown.

Lucid Integration Setup

Getting Started

Use this guide to connect Lucid to your BalkanID tenant. You will need an API key from the Lucid developer portal and access to the Integrations section in BalkanID.

Requirements:

Before you begin, collect the following value from Lucid:

  • API Key

The API key inherits the access of the person who creates it, and its grants are fixed when it is issued. Only an account owner or account admin can create a key with the AccountAdmin grant, which is required to read users. If you need different grants later, create a new key.

Configure Lucid within your BalkanID tenant

  1. To create the API Key, sign in to Lucid and open the developer portal.

  2. Go to API Keys and create a new key.

  3. Set an expiration, then enable the grants listed under Integration Scopes below.

  4. Copy the key when it is shown. Lucid displays it once and it cannot be retrieved again.

  5. In BalkanID, go to Integrations and click Add integration.

The BalkanID Integrations page with the Add integration button in the top right
Integrations
  1. Search for Lucid, select it, and click Next.

The Connect a new application step with the Lucid application selected
Connect a new application
  1. Set the Primary application owner and the Description, if any. Set up Secondary Application Owner(s), if any.

  2. Under Direct Configuration, paste your key into the API Key field, then click Next.

The Direct Configuration section showing the API Key field
Direct Configuration
  1. Fill Optional Configuration, if required.

The Optional Configuration step with reviewer settings and fulfillment options
Optional Configuration
  1. Once you have filled in the information, click Save. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read Connected and the integration Message will read Data available.

Integration Scopes

Lucid API key grants are selected when the key is created and cannot be changed afterwards.

Read Only Scopes
Lifecycle Management Scopes

AccountAdmin — reads the users on your account and the administrative roles they hold

N/A

TeamsReadonly — reads your teams and their members

N/A

LicensesAdmin — reads your subscriptions and the licences assigned from them

N/A

A key without TeamsReadonly or LicensesAdmin still syncs users and their administrative roles; the integration reports the types it could not read rather than failing.

What BalkanID extracts

Type
Description

Users

Every user on the Lucid account, with their email, username and whether they can sign in

Admin roles

The administrative roles a user holds. Lucid assigns these directly, and a user with no elevated access holds none

Teams

Teams on the account and their members

Subscriptions

The seat pools licences are drawn from, and which users hold a licence

Lucid does not report a last sign-in time for users on any of its APIs, so BalkanID cannot show last login for a Lucid identity. Lucid's subscription records also carry no product name, so a licence is identified by its subscription rather than by product.

Last updated

Was this helpful?