# SailPoint Gremlin Connector Documentation

> Gremlin Connector Documentation

# Documentation

# Connecting SailPoint and Gremlin

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 Gremlin API base endpoint as **Base URL**. For example, `https://api.gremlin.com/v1`.
2. Enter the **API Token**. The connector passes this key as an `Authorization: Key` header on API calls.
3. Enter the **Company ID** for your Gremlin company. The connector aggregates users, teams, and company roles associated with this company ID.
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 Gremlin

Gremlin is an enterprise reliability and Chaos Engineering platform that helps engineering organizations proactively find and fix availability risks before they impact end users. The Gremlin connector aggregates users, company roles, and teams for account and entitlement visibility. This document provides instructions to configure a new direct connection to a Gremlin 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 Gremlin connector supports the following:

### Account Management

- Aggregate Account (Users)

### Entitlement Management

- Aggregate Group (Company Roles)
- Aggregate Group (Teams)

> [!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. Sign in to Gremlin with a user account. A **Company Owner** or **Company Sec Admin** account is recommended so the connector has full visibility into users, teams, and company roles.
2. Go to **Settings \> User Settings \> API Keys**.
3. Select **New API Key**.
4. Enter a unique **Name** and an optional **Description** for the key.
5. Select **Save** to generate the API key. Copy the key value immediately, because it is only displayed once.
6. Locate your **Company ID** from the left sidebar of the Gremlin dashboard at [http://app.gremlin.com](<http://app.gremlin.com>).
7. Copy and securely store the **Base URL**, **API Token**, and **Company ID**, which are required during connector configuration.

> [!NOTE]
>
> - API keys are linked to a specific user account. If the user is deactivated or removed from the company, the key is automatically revoked.
> - A maximum of 5 active API keys can exist per user at any given time.
> - Company administrators with the `COMPANY_SECURITY_WRITE` privilege can configure API keys to automatically expire after a set duration. If this is enabled, an expired key must be regenerated.
> - A revoked key must be reinstated or replaced with a newly generated key before it can be used to authenticate again.

For more information about obtaining an access token, refer to the [Gremlin API keys documentation](<https://www.gremlin.com/docs/api-reference-api-keys>).

## Required Permissions

### Who Can Generate an API Token

Any Gremlin user can generate a personal API key from their own account settings. API keys are per-user and are not gated behind a specific company role.

### How Permissions Affect Connector Access

API tokens inherit the permissions of the user who generated them. If the user can view people, teams, and roles in Gremlin, the token can fetch them through the API. If the user lacks permission to see certain records in the UI, the token cannot fetch those records through the API.

Typical role considerations include:

- **Company Owner** - Full administrative access, including company security, users, teams, and roles. This role can generate tokens and fetch all user, team, and role data.
- **Company Sec Admin / Company Manager / Company Coordinator / Company User** - These roles can have varying access. By default, each default company role is granted `COMPANY_USERS_READ` and `TEAMS_READ`, so tokens generated by users in these roles can fetch users and teams through the API.
- **Company Owner** and **Company Sec Admin** - By default, these roles hold `ROLES_WRITE`. If your company has customized its role-based access control (RBAC) configuration, users without this privilege may have limited ability to view or modify company role definitions.

For more information about Gremlin, refer to the [Gremlin website](<https://www.gremlin.com/>), [Gremlin documentation](<https://www.gremlin.com/docs>), and [Gremlin API reference](<https://www.gremlin.com/docs/api-reference-overview>).

> [!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 Gremlin 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 |
| --- | --- |
| identifier | Account |

### Default Account Attributes

The Gremlin 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 |
| --- | --- |
| identifier | Unique identifier (Email) of the user within Gremlin |
| state | Current status of the user's account, such as active, invited, or revoked |
| first\_name | First name of the Gremlin user |
| last\_name | Last name of the Gremlin user |
| created\_at | Timestamp when the user account was created in Gremlin |
| updated\_at | Timestamp when the user account was last updated |
| default\_company\_role | The company role assigned to the user by default, granting privileges for actions performed outside of a team, such as managing company settings or users |
| company\_roles | Company role or roles assigned to the user, granting privileges for company-wide actions such as managing users, teams, integrations, and security settings |
| hashed\_identifier | A hashed representation of the user's identifier, used to reference the user internally without exposing the raw identifier |
| last\_login | Timestamp of the user's most recent login to Gremlin |
| last\_auth\_type | The authentication method used during the user's last login, such as password, SSO/SAML, or OAuth |
| team\_identifier | Identifier or identifiers of the teams the user belongs to, granting team-level privileges such as running experiments or managing clients |

## 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 Role Attributes

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

| Attribute Name | Description |
| --- | --- |
| key | Unique identifier (key) of the company role |
| name | Display name of the company role, such as Company Owner, Company Manager, or Company User |
| description | Human-readable explanation of the privileges granted by the company role |
| type | Category of the role, indicating it is a company-level role rather than a team-level role |
| privileges | List of privileges granted by the role, such as COMPANY\_USERS\_READ or ROLES\_WRITE, which determine the actions a user assigned to this role can perform outside of a team |

### Default Team Attributes

The Gremlin 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 |
| --- | --- |
| team\_identifier | Unique Identifier (UUID) of the team within Gremlin |
| name | Display name of the team |
| state | Current status of the team, such as active or deleted |
| created\_at | Timestamp when the team was created |
| default\_team\_role | The team role automatically granted to members of the team, determining their default privileges, such as running experiments or managing clients |
| production | Indicates whether the team is designated as a production team, which may apply additional safeguards, such as restricted testing time windows, to experiments run within it |
| pref\_autoAddUsers | Team preference indicating whether new company users are automatically added to this team |
| pref\_domain | Team preference specifying the email domain used to automatically add matching users to the team |