> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lumos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Jenkins

## After this article

You will be able to connect Jenkins to Lumos to sync users, groups, and roles. This is a read-only integration.

## Capabilities

| Functionality | Type | Sync | Provision | Description |
| - | - | - | - | - |
| Users | Account | Yes | No | User accounts |
| Groups | Permission | Yes | No | Groups |
| Roles | Permission | Yes | No | Roles |

## Required plan and roles

* **Jenkins plugins:** install the **Role-based Authorization Strategy** and **People View** plugins, and set the authorization strategy to **Role-Based** so the connector can read roles.
* **Jenkins role:** the API user needs admin privileges, including the **Overall/Administer** permission, so Lumos can enumerate all users and roles.
* **Deployment:** this works only for cloud deployments or on-prem deployments that are externally accessible.

## Read-only access vs provisioning

**Is read-only possible?** Yes, and it's the only mode this connector offers. Lumos only syncs users, groups, and roles from Jenkins.

**What read-only requires.** The same admin API user and **Overall/Administer** permission described above, then follow the steps below to connect.

**Watch out for.** There is no provisioning variant of this connector. User, group, or role changes have to happen in Jenkins directly, since this connection only ever reads data into Lumos.

## Instructions

**Phase 1: Prepare Jenkins**

1. Install the **Role-based Authorization Strategy** and **People View** plugins.
2. Set the authorization strategy to **Role-Based**.
3. Create or identify an admin user and generate an **API Token** for it. Note the user's **Username** and your Jenkins **Hostname**.

**Phase 2: Connect in Lumos**

1. Click the Jenkins card in your Lumos integrations (reconnect an existing card or add a new one).
2. Enter the **Username**, **API Token**, and **Hostname**.
3. Click **Connect**.

## API Endpoints Used

<Note>
  The API endpoints this integration uses are available to logged-in Lumos customers. [Log in](/login) to view them.
</Note>

## Troubleshooting

**Users are not syncing.** Confirm the integration shows as Connected, verify users have active accounts in Jenkins, check that the API user can enumerate all users, and review your Jenkins security realm settings. Contact Lumos support if users still don't appear.

**"Insufficient permissions" error.** Make sure the API user has admin privileges and the **Overall/Administer** permission. Check the authorization strategy settings, confirm that matrix-based security (if used) includes the needed permissions, and review any plugin-based authorization configurations.