> ## 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.

# TalentLMS

## After this article

You will be able to connect TalentLMS to Lumos to sync users and their last activity, and to suspend or deprovision users during offboarding.

## Capabilities

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

| Deprovisioning Action | Type | Description |
| - | - | - |
| Suspend | User | Suspend a user in TalentLMS |
| Deprovision | User | Deprovision a user in TalentLMS |

Lumos is currently unable to pull in **roles** for this integration. Activity tracking is supported via the TalentLMS timeline (last user activity).

## Required plan and roles

* **TalentLMS role:** an **Administrator** of your TalentLMS portal must perform the setup. The API key is generated from the Administrator Dashboard.
* **Credential:** the portal-wide TalentLMS API key, enabled under **Account Settings → Basic settings → Security → Enable API**.
* **Permission scoping:** the API key is not scoped. It carries full API access. Lumos uses it to list users, read activity, and (for offboarding) suspend or deprovision users. Roles cannot be synced (see Capabilities).

## Read-only access vs provisioning

**Is read-only possible?** No. The TalentLMS API key isn't scoped. It carries full API access for the whole portal, so there's no narrower credential that limits Lumos to reading data only.

**What full provisioning requires.** The same portal-wide API key, enabled by an Administrator under Account Settings → Basic settings → Security → Enable API. That single key is what Lumos uses both to read users and to suspend or deprovision them, so no additional credential is needed for those offboarding actions to work.

**Watch out for.** Regenerating or disabling the API key in TalentLMS breaks the existing connection immediately, since it's the only credential the integration has. TalentLMS also can't sync roles regardless of how the key is configured.

## Instructions

**Phase 1: Enable the API in TalentLMS**

1. Log in to your TalentLMS portal as an admin (e.g. `https://hogwarts.talentlms.com`).
2. Note the subdomain of your portal (`hogwarts` in the example).
3. Go to the **Administrator Dashboard** → **Account Settings**.
4. In **Basic settings**, find the **Security** section and click **Enable API**.
5. Copy the generated API key.

**Phase 2: Connect in Lumos**

1. Find the TalentLMS card in your Lumos integrations (reconnect an existing card or add a new one).
2. Paste your portal subdomain into the **Talent LMS Domain** field.
3. Paste the generated key into the **API Key** field.
4. 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

**Roles do not appear in Lumos.** This is a known limitation: the TalentLMS integration cannot sync roles. Only user accounts and activity are available.

**Connection fails.** Verify the **Talent LMS Domain** field contains only the subdomain (e.g. `hogwarts`, not the full URL), and that the API is still enabled under **Account Settings → Basic settings → Security**. Regenerating or disabling the key there invalidates the existing connection.