Skip to content

Integrating SailPoint with Lightspeed

Lightspeed (X-Series Retail) is a cloud-based point-of-sale and retail management platform from Lightspeed Commerce, used by retailers worldwide to manage sales, inventory, customers, and staff across one or more outlets. This document provides instructions to configure a new direct connection to a Lightspeed source. For a reference to the terminology specific to SailPoint products, refer to Source and Connector Definitions.

Note

To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the SaaS Release Notes page.

Supported Features

The Lightspeed connector supports the following:

Account Management

  • Aggregate Users
  • Entitlement Management (via Account Attributes)

Important

Quick Compliance connectors have the following manual aggregation limits within a 24-hour period:

  • Organization Admins: Limited to 3 manual account or entitlement aggregations per day per source. This limit is cumulative across all admins in the organization.
  • Regular Users: Limited to 1 manual account or entitlement aggregation per day per source.

These limits ensure that individual compliance statuses are kept up to date while maintaining continuous compliance monitoring. If you need to run additional aggregations beyond these limits, contact SailPoint Support.

Prerequisites

Ensure the following prerequisites are met before proceeding with the configuration:

  1. Log in to your Lightspeed (X-Series Retail) instance at https://<your-domain>.retail.lightspeed.app as an Administrator (primary user or a user with admin permissions).
  2. Go to Setup > Personal Tokens (also referred to as API Access in some Lightspeed deployments).
  3. Select Generate new token (or Add personal token), provide a meaningful name (for example, sailpoint-quick-compliance), and select an appropriate expiration if required.
  4. Select Generate/Save to create the token.
  5. Copy the generated token immediately, Lightspeed will not show the token again. This is your API Token.
  6. Identify the Base URL of your Lightspeed instance’s API. It has the form https://<your-domain>.retail.lightspeed.app/api/2.0 (or a versioned path such as 2026-04). For more information about the Lightspeed Retail (X-Series) API, refer to the Lightspeed API introduction documentation.

Required Permissions

  • The Personal Token used to connect must be generated by a user with permissions to read users in the Lightspeed (X-Series Retail) account. At minimum, the following capability is required:
    • read:users: Required to list and read user accounts (used by GET /api/2.0/users).
  • Generating the token from a primary user/Administrator account ensures all read scopes required by the connector are granted. The connector is read-only; no write or delete permissions are required. For more information about authentication, refer to the Lightspeed authentication documentation.

Note

The linked document is not maintained by SailPoint and is subject to change without notice.