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
Configure Lucid within your BalkanID tenant
To create the API Key, sign in to Lucid and open the developer portal.
Go to API Keys and create a new key.
Set an expiration, then enable the grants listed under Integration Scopes below.
Copy the key when it is shown. Lucid displays it once and it cannot be retrieved again.
In BalkanID, go to Integrations and click Add integration.

Search for Lucid, select it, and click Next.

Set the Primary application owner and the Description, if any. Set up Secondary Application Owner(s), if any.
Under Direct Configuration, paste your key into the API Key field, then click Next.

Fill Optional Configuration, if required.

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.
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
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
Last updated
Was this helpful?

