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

# Zuora

*This connector runs in Read Only mode. Lumos syncs account and entitlement data from Zuora. Provisioning and deprovisioning actions aren't currently available.*

## After this article

You'll be able to connect Zuora to Lumos to sync users and global-level Zuora roles. The connector reads Zuora platform user access only. Billing data, subscriptions, invoices, and revenue information aren't synced.

## Capabilities

| Functionality | Type | Sync | Provision | Description |
| - | - | - | - | - |
| Users | Account | Yes | No | Syncs Zuora platform users. |
| Global Roles | Entitlement | Yes | No | Syncs global-level Zuora roles. |

**Activity tracking**

| Capability | Supported | Description |
| - | - | - |
| Activity tracking | No | Not currently available. The integration syncs user account data only. |

## Required plan and roles

* **Authentication method:** OAuth 2.0 (client credentials). You authorize Lumos through a secure OAuth flow rather than sharing a password, and you can revoke access anytime from your Zuora account settings.
* **Zuora tenant access:** an active Zuora tenant (Production or Sandbox) with an Administrator role.
* **OAuth client configuration:** the ability to create OAuth clients, with API access enabled on your Zuora subscription.
* **Required permissions:** read-only access to the tenant.

## Read-only access vs provisioning

**Is read-only possible?** Yes, and it's the only mode this connector supports. The native Zuora connector reads user and role data through OAuth 2.0 client credentials, and provisioning or deprovisioning isn't part of the native connector.

**What read-only requires.** An OAuth client created in Zuora with Client Credentials as the grant type, using an Administrator account with API access enabled on your Zuora subscription, as described below.

**Watch out for.** Provisioning and deprovisioning would need Zuora's SCIM API, which isn't part of this native connector today. Don't expect deprovisioning actions to appear for Zuora users, and remember that billing, subscription, and invoice data are never synced either way.

## Instructions

**Phase 1: Create an OAuth client in Zuora**

1. Log in to your Zuora tenant at zuora.com.
2. Go to **Settings** > **Administration** > **Manage Users**.
3. Create or select a user for the integration. A dedicated API user is recommended.
4. Go to **Settings** > **Administration** > **OAuth Clients**.
5. Click **Create OAuth Client**.
6. Provide the configuration:
   * **Client Name:** Lumos Integration
   * **Client Type:** Confidential
   * **Authorized Grant Types:** Client Credentials
7. Click **Create**.
8. Copy the **Client ID** and **Client Secret** immediately and store both values securely.

**Phase 2: Configure Zuora in Lumos**

1. In Lumos, go to **Integrations** > **Add Integration**.
2. Search for and select **Zuora**.
3. Enter your OAuth credentials:
   * **Client ID:** from Phase 1
   * **Client Secret:** from Phase 1
   * **Account ID:** your Zuora account ID, used for multi-entity orgs

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

**Provisioning or deprovisioning isn't available.** The native Zuora connector is read-only and is limited to user roles and last login. Provisioning and deprovisioning would require SCIM, which isn't part of the native connector today.

**Billing data is missing.** This is expected. The integration syncs Zuora platform user access only. Billing data, subscriptions, invoices, and revenue information aren't synced.