# SailPoint Upstash Connector Documentation

> Upstash Connector Documentation

# Documentation

# Connecting SailPoint and Upstash

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 Upstash Developer API base endpoint as **Base URL**. For example, `https://api.upstash.com/v2`.
2. Enter the email address of the Upstash account that owns the Developer API key as **Username**.
3. Enter the **API Key**. The connector uses the email and API key together as HTTP Basic credentials for Developer API requests.
4. Select **Save**.

> [!NOTE]
>
> SailPoint recommends using HTTPS for a secured connection. The connector sends HTTP Basic authentication on every Developer API request using the format `Authorization: Basic <base64(email:api_key)>`.

> [!NOTE]
>
> A successful connection test confirms that SailPoint can reach the Upstash Developer API and authenticate with the supplied email and API key.

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

Upstash is a serverless data and messaging platform for developers. It provides Redis, Vector, QStash, Workflow, Search, and related services, along with team-based collaboration and a Developer API for programmatic administration of account resources. This document provides the instructions required to configure a new direct connection between SailPoint and Upstash. 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 Upstash connector supports the following:

### Account Management

- Aggregate Accounts (Team Members)

### Entitlement Management

- Aggregate Entitlements (Teams)

> [!NOTE]
>
> This connector is read-only. It supports account and entitlement aggregation for Quick Compliance. Provisioning, de-provisioning, and write operations are not supported in this release.

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

Before configuring the Upstash connector, ensure you have Developer API access from a native Upstash account with appropriate permissions.

1. Sign in to the [Upstash Console](<https://console.upstash.com>) with a native Upstash account.
2. Go to **Settings \> Developer API**.
3. Select **Create API Key**.
4. Configure the API key as follows:

   - **API Name:** Enter a unique name for the SailPoint integration key.
   - **Permissions:** Select **Read/Write** or **ReadOnly**.
   - **Expiration:** Select an expiration period (for example, 7 Days, 30 Days, or as offered in the console).
5. Create the key, then download or copy it immediately. Upstash does not store or redisplay the key after creation for security reasons.
6. Store the key securely.
7. Record the following values for SailPoint configuration:

   - **Base URL**
   - **Username** (Upstash account email)
   - **Password** (Developer API key)

> [!NOTE]
>
> - The Developer API is available only to native Upstash accounts. Accounts created through third-party platforms such as Vercel or Fly.io are not supported.
> - The connector authenticates all Developer API requests using HTTP Basic authentication. The Upstash account email is the username and the API key is the password (`EMAIL:API_KEY`).
> - The API key is scoped to the Upstash account that created it. Team and member visibility is limited to the teams that account can access through the Developer API.
> - If the key is configured with an expiration period, renew it before expiry to avoid failed connection tests or aggregation jobs.

## Required Permissions

### API Key Permissions

Any native Upstash account user can create Developer API keys from **Settings \> Developer API**. Use a dedicated key for SailPoint aggregation and keep it separate from other applications.

| Permission | Access Scope | Recommended Use |
| --- | --- | --- |
| **ReadOnly** | Read access to Developer API resources available to the authenticated account, including teams and team members | Preferred for Quick Compliance aggregation |
| **Read/Write** | Read and write access to Developer API resources available to the authenticated account | Not required for this read-only connector release |

Recommendation: Use a **ReadOnly** Developer API key for SailPoint aggregation. Read/Write is unnecessary for this connector and increases risk if the key is exposed.

### Team Role Permissions

Upstash uses fixed team roles. Role values are predefined and cannot be customized. When inviting or adding a member, one of the following roles must be selected.

> [!NOTE]
>
> These roles exist in the Upstash product but are not aggregated by this connector.

| Role | Permissions |
| --- | --- |
| **Owner** | Full Admin access, plus the unique ability to delete the team. Automatically assigned to the user who created the team and cannot be assigned to other members. |
| **Admin** | Full access, including adding and removing members, managing databases, and managing payment methods. |
| **Dev** | Can create, manage, and delete databases. Cannot manage users or payment methods. |
| **Finance** | Can manage payment methods only. Cannot manage databases or users. |
| **Read Only** | View-only access to team resources. Cannot manage databases, users, or payment methods. |

> [!NOTE]
>
> - Only **Owners** and **Admins** can add or remove team members.
> - To change a member's role, remove the member and add them again with the desired role.
> - Pending invitations do not grant team access until accepted.
> - For reliable aggregation of teams and members through the Developer API, use a key created by an account with sufficient team visibility (typically an **Owner** or **Admin** of the relevant teams).

## Key Implementation Notes

- Accounts are identified and correlated by **Email**.
- Team membership is aggregated through the multi-valued **Teams** entitlement.
- Developer API keys are account-scoped. Authentication uses the account email and API key together through HTTP Basic auth. The key can only access teams visible to that account through the Developer API.
- Prefer ReadOnly keys for this connector. Set an appropriate expiration period and renew keys before they expire.
- Partition aggregation discovers teams first, then aggregates members per team. This allows each team membership relationship to be processed correctly during account aggregation.
- Rate limits and key usage: Use separate Developer API keys per application where possible. If aggregation fails due to throttling or repeated API errors, reduce concurrency or adjust aggregation schedules and retry later.
- Developer API availability: Only native Upstash accounts are supported. Third-party platform accounts cannot use the Developer API required by this connector.
- Upstash team roles are not aggregated by this connector.
- Renew API keys before expiration to avoid aggregation failures.

## References

For more information, refer to the following resources:

- [Upstash Documentation](<https://upstash.com/docs/introduction>)
- [Upstash Developer API Introduction](<https://upstash.com/docs/devops/developer-api/introduction>)

> [!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 Upstash 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 |
| --- | --- |
| Email | Account |

### Default Account Attributes

The Upstash 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 |
| --- | --- |
| Email | Email address of the Upstash team member. Used as the account identity attribute and display attribute. |
| Teams | Unique identifier of the team (or teams) the member belongs to. Multi-valued. Aggregated as a Team entitlement. |

| Identity Attribute | Operation | Account Attribute |
| --- | --- | --- |
| email | EQ | Email |

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

| Attribute Name | Description |
| --- | --- |
| Identifier | Unique identifier (UUID) of the Upstash team. Used as the Team identity attribute. |
| Name | Display name of the Upstash team. Used as the Team display attribute. |