# SailPoint AppDirect Connector Documentation

> AppDirect Connector Documentation

# Documentation

# Connecting SailPoint and AppDirect

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. Select **OAuth 2.0 Client Credentials** as the **Authentication Type**.
2. Enter the AppDirect marketplace host as **Base URL**. For example, `https://testdemo.byappdirect.com`. Do not include `/admin` or `/api` in the Base URL.
3. Enter the OAuth 2.0 token endpoint as **Token URL**. For example, `https://testdemo.byappdirect.com/oauth2/token`.
4. Enter the **Client ID** (Consumer Key).
5. Enter the **Client Secret** (Consumer Secret).
6. Enter the **Company ID** (`companyId`) for the company you want to aggregate.
7. Enter `ROLE_PARTNER` as the OAuth request parameter **scope**.
8. Select **Save**.

> [!NOTE]
>
> The connector uses OAuth 2.0 Client Credentials to obtain an access token and sends it on API requests as `Authorization: Bearer $application.accesstoken$`.

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

AppDirect is a cloud-based commerce and identity platform used to run digital marketplaces. Organizations (companies) on a marketplace manage users, membership roles, groups, and application assignments. The AppDirect connector enables SailPoint to aggregate users for a single AppDirect company and their membership roles for that company. This document provides the instructions required to configure a new direct connection between SailPoint and AppDirect. 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 AppDirect connector supports the following:

### Account Management

- Aggregate Users

### Entitlement Management

- Aggregate Membership 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.

## Scope Model

This connector is **company-scoped**. You provide a **Company ID** (`companyId`) in connection settings. Aggregation reads only users and roles for that company:

```text
Marketplace
 └── Company (configured via companyId)
      └── Memberships
           ├── User (Account)
           └── Roles (Entitlements for that company only)
```

> [!NOTE]
>
> - Roles live on the **company membership**, not on the global user `roles` array (which is typically only `ROLE_USER`).
> - One SailPoint source = one AppDirect company. To govern multiple companies, create multiple sources (or extend the connector later).

## Prerequisites

Before configuring the AppDirect connector, ensure the following requirements are met:

1. Go to [AppDirect sign in](<https://www.appdirect.com/signin>) and select **Monetization Platform** (marketplace dashboard). Do **not** use Advisor Portal, Procurement Platform, or Developer Center for connector setup or testing. Then sign in with a **Marketplace Manager** account.
2. Go to **Manage \> Marketplace \> Settings \> Integration \> API Clients**.
3. Select **Create API Client**.
4. Configure the API client as follows:

   - **Name:** Enter a name for the SailPoint integration.
   - **Client Type:** **Non-interactive application** (server-to-server).
   - **Protocol:** **OAuth 2.0**.
   - **Grant Type:** **Client Credentials**.
   - **Allowed Scopes:** **ROLE\_PARTNER** (read/write) or **ROLE\_PARTNER\_READ** (read-only).
5. Select **Save**. AppDirect generates a **Consumer Key (Client ID)** and **Consumer Secret (Client Secret)** - copy and securely store both. The secret is shown only once.
6. Identify your marketplace host (for example, `testdemo.byappdirect.com` from `https://testdemo.byappdirect.com/admin`). Use the host without `/admin` for API and token URLs.
7. Identify the **Company UUID** (`companyId`) for the company you want to aggregate (from the AppDirect UI or `GET /api/account/v2/companies`).
8. Record the following values for SailPoint configuration:

   - **Base URL**
   - **Token URL**
   - **Client ID**
   - **Client Secret**
   - **Company ID** (`companyId`)

### Token Notes

> [!NOTE]
>
> - AppDirect uses **OAuth 2.0 Client Credentials**. Access tokens are short-lived (`expires_in`). The connector requests a new access token when needed. Client Credentials does **not** return a refresh token.
> - The connector sends OAuth request parameter: `scope=ROLE_PARTNER`.
> - Tokens are valid only for the marketplace that issued them.
> - Regenerating the Client Secret invalidates prior credentials for that API client.

## Required Permissions

### Who Can Generate a Client ID/Secret

Only users with the **Marketplace Manager** role can create and manage API clients (**Manage \> Marketplace \> Settings \> Integration \> API Clients**).

### How Permissions Affect Connector Access

Access is governed by the scopes granted to the API client:

| Scope | Access |
| --- | --- |
| `ROLE_PARTNER` | Read and write marketplace data (recommended if provisioning may be added later) |
| `ROLE_PARTNER_READ` | Read-only marketplace data (sufficient for aggregation-only) |

Client Credentials with `ROLE_PARTNER` or `ROLE_PARTNER_READ` provides system-level access and does not act on behalf of an end user. This is the recommended grant type for SailPoint aggregation.

## Product Links

- [AppDirect website](<https://www.appdirect.com/>)
- [Developer Portal](<https://developer.appdirect.com/>)
- [API reference](<https://developer.appdirect.com/rest>)

> [!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 AppDirect 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 AppDirect 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 | Unique user ID, used as the account native identity attribute |
| userName | Marketplace login name (often same as email), used as the account display attribute |
| email | Primary email; used for invites and correlation |
| firstName | User's given name |
| lastName | User's family name |
| allowLogin | Whether this user can sign in |
| activated | Whether the user has activated their account or invite |
| roles | Membership roles for this user in the configured company (multi-valued), aggregated as a Role entitlement |

## Account Correlation

Accounts are correlated to identities by matching the identity `email` attribute to the account `email` attribute.

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

The connector's `entitlementSchemas` is empty. Roles are modeled as multi-valued account entitlements on the `roles` attribute (not a separate Group schema). Membership roles are aggregated from the top-level `roles` array on the user-company membership response (not from `user.roles`).

| API role value | AppDirect UI name | Description |
| --- | --- | --- |
| ROLE\_USER | User | Base end-user access, present on every user; cannot be removed. |
| ROLE\_SYS\_ADMIN | Company Admin | Administers users, purchases, and company settings for that company |
| ROLE\_BILLING\_ADMIN | Billing Admin | Manages billing and payment-related access for the company |
| ROLE\_DEVELOPER | Developer | Manages product and developer functions for the company |
| ROLE\_CHANNEL\_ADMIN | Marketplace Manager | Manages marketplace-wide users, companies, and products |
| ROLE\_CHANNEL\_SUPPORT | Customer Support | Support access across marketplace companies and users |
| ROLE\_CHANNEL\_PRODUCT\_SUPPORT | Product Support | Supports product integration and catalog-related tasks |
| ROLE\_SALES\_SUPPORT | Sales Support | Creates companies and can purchase on behalf of users |
| ROLE\_RESELLER | Reseller | Reseller access for selling and managing reseller activity |
| ROLE\_RESELLER\_MANAGER | Reseller Manager | Manages reseller teams, companies, and sales opportunities |