# Integrating SailPoint with YugabyteDB

YugabyteDB is a distributed SQL database delivered as a fully managed cloud service. It provides PostgreSQL-compatible, resilient, and scalable database clusters with built-in administration, including user management, role-based access control, and audit capabilities. This document provides instructions to configure a new direct connection to a YugabyteDB source. For a reference to the terminology specific to SailPoint products, refer to [Source and Connector Definitions](<https://documentation.sailpoint.com/saas/help/sources/index.html#source-and-connector-definitions>).

> [!NOTE]
>
> To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes](<https://community.sailpoint.com/release-notes/saas>) page.

## Supported Features

The YugabyteDB connector supports the following:

### Account Management

- Aggregate Users

### Entitlement Management

- Aggregate Roles

> [!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:

- **Administrative access to YugabyteDB Managed**: You must have an account with the Admin role in your YugabyteDB Managed organization in order to generate API credentials and to view all users and roles required for aggregation.
- **Customer (account) UUID**: Obtain the unique customer/account UUID for your YugabyteDB Managed tenant. This value is used to scope all API calls made by the connector.
- **API token (API key)**: Generate an API key for the administrator account. This token will be used by the connector as a bearer credential to authenticate against the YugabyteDB Managed REST API. Treat the token as a secret, store it securely and rotate it according to your organization’s policy.
- For more information about API key generation, refer to the [YugabyteDB Managed API keys documentation](<https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-apikeys/>).

## Required Permissions

- API keys in YugabyteDB Managed are issued from the **Admin** area of the YugabyteDB Managed console. Only users with the **Admin** role in the YugabyteDB Managed account can create and manage API keys.
- A dedicated service identity (admin user) is recommended for the SailPoint integration so that the API key is not tied to a personal account and can be rotated independently.
- The API key inherits the role of the user who issues it. To list all users and all roles in the account, the issuing user must hold the **Admin** role.
- The connector performs read operations to enumerate users (accounts) and roles (entitlements) within a single YugabyteDB Managed customer/account, identified by the `customerUUID` provided at configuration time.
- An **Admin**-scoped API key is required to fetch the complete list of users and roles. Non-admin or read-only accounts in YugabyteDB Managed do not have permission to enumerate all users and roles for the account, which will result in incomplete aggregation results.
- The connector does not require any write or destructive operations against YugabyteDB Managed for account or entitlement aggregation.
- For more information about user management and API automation, refer to the following resources:

  - [YugabyteDB Managed API keys](<https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-apikeys/>)
  - [Manage account access](<https://docs.yugabyte.com/stable/yugabyte-cloud/managed-security/manage-access/>)
  - [Automation in YugabyteDB Aeon](<https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/>)

> [!NOTE]
>
> The linked document is not maintained by SailPoint and is subject to change without notice.