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

# Braintree

## After this article

You'll be able to connect Braintree to Lumos to sync users for visibility and Access Reviews. Braintree is a read-only integration today.

## Capabilities

| Functionality | Type | Sync | Provision | Description |
| :- | :- | :- | :- | :- |
| Users | Account | Yes | No | User account records |
| Roles | Entitlement | Yes | No | Braintree Gateway roles |

If you require user provisioning, Braintree follows the SCIM format so the generic SCIM connector will allow provisioning to Braintree.

## Required plan and roles

You authenticate with Braintree API credentials generated in your Braintree gateway. Create the credentials as a Braintree admin, then enter them on the connector card in Lumos.

This is a read-only connection. Lumos reads users from Braintree and doesn't write changes back.

## Read-only access vs provisioning

**Is read-only possible?** Yes, and it's the only mode available today. Braintree connects with API credentials generated in your Braintree gateway, and Lumos only reads users from Braintree, it doesn't write anything back.

## Instructions

**Phase 1: Get your Braintree credentials**

1. Log in to your Braintree gateway as an admin.
2. Generate the API credentials Braintree uses for programmatic access.
3. Copy the credentials so you can paste them into Lumos.

**Phase 2: Connect in Lumos**

1. Find the Braintree card in your Lumos integrations (reconnect an existing card or add a new one).
2. Enter your Braintree API credentials.
3. Click **Connect**.