# SailPoint YugabyteDB Connector Documentation

> YugabyteDB Connector Documentation

# Documentation

# Connecting SailPoint and YugabyteDB

To connect SailPoint to the source, perform the following tasks:

## Adding and Configuring the Source in SailPoint

To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs.

1. Go to **Admin \> Connections \> Sources**.
2. Select **Create New**.
3. Search for a source type and select **Actions**.
4. In the **Actions** dropdown, select the setup method:

   - **Express Setup** - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started.

     > **Note**
     >
     > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>). For more information, contact your SailPoint Customer Service Manager.
   - **Standard Setup** - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup.

### Express Setup

1. Review the directions and select **Start Express Setup**.
2. Review the pre-populated source name, source owner, and description. To update, select **Edit**.

   > **Note**
   >
   > Source name must be unique.
3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider.

   > **Note**
   >
   > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** page.
5. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation.

   - If you want to aggregate now, select **Aggregate**.

     - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**.
     - To see the list of aggregated source accounts, go to **Account Management \> Accounts**.
   - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet.

### Standard Setup

Configure more detailed settings relative to Express Setup.

1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters.
2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters.
3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
4. (Optional) Select a governance group to grant its members [source](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
5. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Here, continue to configure your connected source.

## Base Configuration

Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary.

1. Enter a descriptive **Source Name** for the connection.
2. Enter the **Source Description** that provides details necessary to distinguish it from similar connection sources.
3. In **Source Owner**, begin typing the name of the source owner.
4. (Optional) Select the appropriate **Governance Group for Source Management** from the dropdown list. For more information about governance groups, refer to [Associating Governance Groups with a Source](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-with-a-source>).
5. Select **Create Manual Work Items** to enable the source to support additional source management features such as creating accounts and access profile management.

   > **Important**
   >
   > Once you enable this feature, it can't be disabled.

   For more information on manual work items, refer to [Work Items](<https://developer.sailpoint.com/docs/api/work-items>). For more information on SailPoint features, refer to [SailPoint Identity Services](<https://documentation.sailpoint.com/saas/help/index.html>).
6. Select **Save**.

## Connection Settings

Configure a secured, direct connection to the source.

1. Enter the YugabyteDB host URL as **Base URL**. For example, `https://stoplight.io/mocks/yugabyte/yugabyte-platform/12345678`.
2. Enter **Customer UUID**.
3. Enter **API Token**.
4. Select **Save**.

## Review and Test

Perform a test to confirm the connection to SailPoint.

1. Go to **Review and Test**.
2. Confirm that the entries in each field are correct.

   If you note any mistakes, return to the section and make corrections.
3. Select **Test Connection**.

## SailPoint Application Onboarding

SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface.

For more information, refer to [Application Onboarding](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

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

# Schema Reference

The application schema is used to configure the objects returned from a connector.

> [!NOTE]
>
> - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.
> - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified.

The YugabyteDB connector uses the following default correlation and object configurations.

## Default Account Schema

Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.

The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.

### Default Account ID

SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*.

> [!CAUTION]
>
> Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
>
> To resolve issues caused by changing account IDs, reconfigure them to their default values.

The following table lists the default account IDs for this connector:

| Account ID | Schema Object Type |
| --- | --- |
| uuid | Account |

### Default Account Attributes

The YugabyteDB connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

| Attribute Name | Description |
| --- | --- |
| uuid | Globally unique identifier of the user |
| email | Email address of the user used for login |
| authTokenIssueDate | Timestamp when the user's authentication token was last issued |
| customerUUID | Unique identifier of the customer/tenant |
| creationDate | Timestamp indicating when the user account was created |
| groupMemberships | List of UUIDs representing the LDAP/OIDC groups associated with the user |
| ldapSpecifiedRole | Boolean flag indicating whether the user's role is assigned via LDAP group mapping instead of manual assignment |
| primary | Boolean flag indicating whether this user is the primary (super-admin/owner) user |
| role | Access role assigned to the user |
| timezone | User's preferred timezone used for displaying timestamps and scheduling operations |
| userType | Type of user authentication source |

## Default Entitlement Attributes

Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) for more information.

> [!CAUTION]
>
> Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.

### Default Group Attributes

The YugabyteDB connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

| Attribute Name | Description |
| --- | --- |
| roleUUID | Globally unique identifier of the role |
| name | Name of the role |
| createdOn | Timestamp indicating when the role was created |
| customerUUID | Unique identifier of the customer/tenant |
| description | Human-readable description explaining the scope of the role |
| permissionList | Permissions that define actions and their associated resource types |
| action | Specific operation allowed by the permission |
| resourceType | The type of resource (UNIVERSE, USER, ROLE, or BACKUP) |
| roleType | Classification of the role indicating whether it is a built-in System role or a Custom role |
| updatedOn | Timestamp indicating when the role's configuration or permissions were last modified |