> For the complete documentation index, see [llms.txt](https://www.cakewalk.security/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.cakewalk.security/docs/platform-overview/connections-and-integrations/identity-sources/lucca.md).

# Lucca

Lucca connects to Cakewalk with an API key you create in Lucca's security settings; for the shared flow, see [Connecting an HRIS](/docs/platform-overview/connections-and-integrations/connecting-an-hris.md).

### ✅ Before You Start

* Your Lucca user roles must include **Other → Lucca → Roles and API Key management**.
* To check: click your user icon in the top bar, click **Settings** under Administration, then under **Settings → Security** click **API Keys**. Verify you can see the **Generate API Key** button. If you cannot, ask a system administrator to assign the "Roles and API Key management" role to your account.

### 🛠 Connect

1. In Cakewalk, go to **Settings → Data Sources → Users** and select Lucca.
2. Note your Lucca domain: it appears in the URL bar in the form `https://example.ilucca.net`.
3. In Lucca, click your user icon in the top bar, click **Settings** under Administration, then under **Settings → Security** click **API Keys** and click **Generate a new API Key**.
4. Enter a name for the key under "Key name" and select at least one permission to create it: start with **Collaborators → View / create / edit users**, you can fine tune permissions later. Enter the email address of someone in IT or HR under "Technical contact", select **Internal use** for "API key usage" and click **Generate a new API key**.
5. Copy the new key with the copy button to its right, enter your Lucca domain and paste the key into the connection flow, then click **Continue**.
6. Back on Lucca's API Keys page, locate the key you created by its name and open its role administration. In the Roles page, find the key by name in the sidebar on the left and click it.
7. Enable each permission the connection flow requests: under the **Permissions** tab, open the parent permission with the plus icon, then check the requested sub permissions. Repeat for every requested permission, then click **Save** in the bottom right corner. The connection flow shows the exact list.
8. Click **Set up integration** in the connection flow.

The first sync starts immediately. Sync details and cadence: [Connecting an HRIS](/docs/platform-overview/connections-and-integrations/connecting-an-hris.md).

### 📚 Related

* [HRIS and IdP](/docs/platform-overview/connections-and-integrations/hris-and-idp.md)
* [Connecting an HRIS](/docs/platform-overview/connections-and-integrations/connecting-an-hris.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.cakewalk.security/docs/platform-overview/connections-and-integrations/identity-sources/lucca.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.