# SailPoint SuperTokens Connector Documentation

> SuperTokens Connector Documentation

# Documentation

# Connecting SailPoint and SuperTokens

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 SuperTokens host URL as **Base URL**. For example, `https://try.supertokens.com`.
2. Enter **API Key**.
3. Enter **App ID** (use `public` for single-app deployments).
4. Enter **Tenant ID** (use `public` for single-tenant deployments).
5. 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 SuperTokens

SuperTokens is an open-source authentication platform that provides email/password, passwordless, third-party (social), and multi-factor login flows for web and mobile applications. The SailPoint Supertokens connector connects to the Supertokens Core Driver Interface (CDI) to provide read-only governance over the users registered in a Supertokens application and the user roles assigned to them, scoped to a configured app and tenant. This document provides instructions to configure a new direct connection to a SuperTokens 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 SuperTokens 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:

- An administrator with access to the SuperTokens Core deployment (self-hosted SuperTokens Core or a SuperTokens Managed Service instance) is required to obtain the Core API key used by the connector.
- The SuperTokens app and tenant against which users and roles will be aggregated must already exist. If a single-app/single-tenant deployment is used, both can be left at the default value `public`.
- The deployment’s SuperTokens Core must support CDI 5.1. The CDI version is not a configurable field - it is fixed in the connector definition.
- For more information about SuperTokens configuration, refer to the following resources:

  - [SuperTokens Core API Keys documentation](<https://supertokens.com/docs/platform-configuration/supertokens-core/api-keys>)
  - [SuperTokens Tenant Management documentation](<https://supertokens.com/docs/post-authentication/dashboard/tenant-management>)
  - [SuperTokens Get Users CDI Reference](<https://supertokens.com/docs/references/cdi/core/get-users>)

## Required Permissions

- The credential used by the connector is the SuperTokens Core API key, configured on the SuperTokens Core deployment via the api\_keys setting (for self-hosted Core) or in the SuperTokens dashboard (for the Managed Service).
- Only a deployment administrator can issue or rotate this key.
- The connector requires this API key value.
- As of now, SuperTokens does not expose any fine-grained access or service account support.
- For more information about user management and CDI references, refer to the following resources:

  - [SuperTokens User Management documentation](<https://supertokens.com/docs/post-authentication/dashboard/user-management>)
  - [SuperTokens Get Users CDI Reference](<https://supertokens.com/docs/references/cdi/core/get-users>)
  - [SuperTokens Documentation](<https://supertokens.com/docs>)

> [!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 SuperTokens 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 |
| --- | --- |
| id | Account |

### Default Account Attributes

The SuperTokens 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 |
| --- | --- |
| id | Unique identifier of the primary user |
| isPrimaryUser | Flag indicating whether this user is the primary user in a linked-account set |
| tenantIds | List of tenant identifiers associated with the user |
| timeJoined | Unix epoch timestamp (in milliseconds) when the user was created |
| emails | Email addresses associated with the user across all linked login methods |
| phoneNumbers | Phone numbers associated with the user across all linked login methods |
| thirdParty.id | Third-party provider identifier (google, apple) for the user |
| thirdParty.userId | User identifier returned by the third-party provider for the user |
| loginMethods.tenantIds | Tenant identifiers associated with each of the user's login methods |
| loginMethods.recipeUserId | Per-login-method recipe user identifier |
| loginMethods.verified | Per-login-method flag indicating whether the contact (email or phone) has been verified |
| loginMethods.timeJoined | Unix epoch timestamp (in milliseconds) when each login method was added to the user |
| loginMethods.recipeId | Identifier of the recipe (emailpassword, thirdparty, passwordless) backing each login method |
| loginMethods.email | Email address associated with each individual login method |
| loginMethods.phoneNumber | Phone number associated with each individual login method |
| loginMethods.thirdParty.id | Third-party provider identifier on each individual login method |
| loginMethods.thirdParty.userId | Third-party user identifier on each individual login method |
| roles | Names of the user roles assigned to the user |

## 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 |
| --- | --- |
| id | Name of the role in used as the role's unique identifier |