# Connecting SailPoint and OpenLDAP

To connect SailPoint with OpenLDAP, perform the following tasks:

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

> [!IMPORTANT]
>
> By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration.

**To configure a new source:**

1. Sign in to SailPoint.
2. Go to **Admin \> Connections \> Sources**.
3. Select **Create New**.
4. Search for the connector by entering the name in the search box, and then select **Configure**.
5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters.
6. 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.
7. 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>).
8. Under **Connection Type**, select **Direct Connection** or **Flat File**.

   - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
   - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable.
9. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source.
10. (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>).
11. 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>).
12. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there.

## 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 unique name and description for the source.
2. In the **Source Owner** dropdown list, select the identity that owns this source.

   - To find a source owner, begin entering their name.
3. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](<https://documentation.sailpoint.com/saas/help/va/index.html>).
4. (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, 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>).
5. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information.
6. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. 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>).
7. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default.

   - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system.
   - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source.
8. Select **Save**.

## Connection Settings

This section contains the information that the source uses to authenticate with the OpenLDAP managed system.

1. Select an option from the **Authorization Types** dropdown list:

   - **Simple**: To use a clear-text password for the Service Account.
   - **SASL EXTERNAL (Certificates)**: To use certificate-based secured authorization.
   - **None**: If you do not want to use authorization when connecting to the server.
2. Enter the **Hostname or IP Address** for the LDAP server.
3. Enter the **Port** number that the server communicates through (the default is 389). Ensure to enter correct port number for certificate-based authorization.
4. Depending on your selection in Step 1, complete the following fields:

   - If you select **Simple** or **None**:

     > **Screenshot**
     >
     > [![Simple or None authentication fields](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/simple_auth.png>)](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/simple_auth.png>)

     1. Enter the **Service Account** DN that points to a user in the LDAP tree who can manage the LDAP server (for example: `cn=Admin,dc=example,dc=com`).
     2. Enter the **Password** for the Service Account.
     3. (Optional) Select **Enable Transport Layer Security (TLS)** to connect securely to the server.
   - If you select **SASL EXTERNAL (Certificates)**, additional fields appear:

     > **Screenshot**
     >
     > [![SASL EXTERNAL certificate authentication fields](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/sasl_auth.png>)](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/sasl_auth.png>)

     > **Important**
     >
     > You must provide an Encrypted Private Key for certificate-based secured authorization.

     1. Enter the content of the client-certificate file in **Certificate**.
     2. Enter the client's encrypted private-key contents in **Private Key**.
     3. Enter the passphrase password in **Private Key Password** to parse and decrypt the private key.
     4. (Required) Select **Enable Transport Layer Security (TLS)** to connect securely to the server.
5. Select **Save**.

> [!NOTE]
>
> For existing sources, it is mandatory to add the `encrypted` attribute through a PATCH API as an additional configuration setting to support certificate-based authorization.
>
> Endpoint: `PATCH /v3/sources/{sourceId}`
>
> Request Body:
>
> ```json
> [
>   {
>     "op": "add",
>     "path": "/connectorAttributes/encrypted",
>     "value": "clientCertificate,privateKeyPassword,private_key"
>   }
> ]
> ```

## Account and Group Settings

Provide the information required to search the accounts and groups managed by your system.

### Account Search Scope

> [!NOTE]
>
> **Screenshot**
>
> [![Account Search Scope](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/account_search_scope.png>)](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/account_search_scope.png>)

To configure the account search scope, complete the following:

1. Select one of the following:

   - **Subtree** - Use to search the specified **Search DN** and all the containers within it.
   - **Base** - Use to only search the **Search DN**.
   - **One Level** - Use to search the **Search DN** and the containers one level below it.
2. Enter the **Search DN** (distinguished name) to search for the accounts that you want to load.
3. (Optional) Enter the **LDAP Search Filter** to specify an optional filter that limits the results returned by the **Search DN**. For example, to filter for entries that do not represent a person, enter the following:

   `(!(objectclass=person))`
4. (Optional) Enter the **Group Member Search DN** to specify the group memberships of the users that you are loading.
5. (Optional) Enter the **Group Membership Attribute** that contains the group membership information on the managed system.
6. (Optional) Enter an **Additional Filter** that SailPoint applies to the results returned by LDAP. Derived attributes can be included in the filter. For example, to remove user from the search results with a condition, enter the following:

   `deleted=="true"`
7. Select **Save**.

### Group Search Scope

> [!NOTE]
>
> **Screenshot**
>
> [![Group Search Scope](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/group_search_scope.png>)](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/group_search_scope.png>)

To configure the group search scope, complete the following:

> [!NOTE]
>
> By default, If the scope is not defined for Groups, the connector users the Account search scope.

1. Select one of the following:

   - **Subtree** - Use to search the specified **Search DN** and all the containers within it.
   - **Base** - Use to only search the **Search DN**.
   - **One Level** - Use to search the **Search DN** and the containers one level below it.
2. (Optional) Enter the **Search DN** (distinguished name) to search for the accounts that you want to load.
3. (Optional) Enter the **LDAP Search Filter** to specify an optional filter that limits the results returned by the **Search DN**. For example, to filter for entries that do not represent a person, enter the following:

   `(!(objectclass=person))`
4. (Optional) Enter an **Additional Filter** that SailPoint applies to the results returned by LDAP. Derived attributes can be included in the filter. For example, to remove user from the search results with a condition, enter the following:

   `deleted=="true"`
5. Select **Save**.

## Additional Configuration

This section contains the information related to NIS Netgroups, POSIX Groups, and Provisioning Settings for accounts.

> [!NOTE]
>
> The NIS Netgroups and POSIX Groups Settings options are applicable only if the `nisnetgroups` or `posixgroups` attribute is added to the account schema with entitlement and multivalued options as true. For more information on adding the attribute to account schema, refer to [Adding nisnetgroups or posixgroups Attributes](<https://documentation.sailpoint.com/connectors/openldap/va/help/adding_nisnetgroups_or_posixgroups_attributes.html>).

> [!NOTE]
>
> The OpenLDAP connector does not log the `ObjectNotFoundException` as an error in pass-through authentication.

### NIS Netgroups Settings

> [!NOTE]
>
> **Screenshot**
>
> [![NIS Netgroups Settings](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/nis_netgroups_settings.png>)](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/nis_netgroups_settings.png>)

1. To retrieve NIS Netgroups memberships for the Accounts, enable the **Enable NIS Netgroups** option.
2. In the **Membership Attribute** field, enter the membership attribute retrieved from NIS Netgroups. Currently, **uid** and **cn** are the only options.
3. In the **NIS Netgroup Triple Brace Override** field, enter the type of braces used to provide a value to NIS Netgroup for nisNetGroupTriple. Default: Rounded braces. **(**.

### POSIX Groups Settings

> [!NOTE]
>
> **Screenshot**
>
> [![POSIX Groups Settings](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/posix_groups_settings.png>)](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/posix_groups_settings.png>)

1. To retrieve POSIX group memberships for the Accounts, enable the **Enable POSIX Groups** option.
2. In the **Membership Attribute** field, enter the membership attribute retrieved from POSIX. Currently, `uid` and `cn` are the only options.

### Provisioning Settings

> [!NOTE]
>
> **Screenshot**
>
> [![Provisioning Settings](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/provisioning_settings.png>)](<https://documentation.sailpoint.com/connectors/openldap/va/help/img/provisioning_settings.png>)

1. In the **Unique Search DN**, define the search scope of aggregation for mentioned unique objectType.
2. Select **Save**.

### Additional Configuration Attributes

#### Hostname Verification

To disable hostname verification during LDAP Communication over TLS for the OpenLDAP source, add the `disableLDAPHostnameVerification` attribute using the REST API.

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

`POST <url>/api/source/update/<sourceID>`

- `<url>` is the URL for your SailPoint instance.
- `<sourceID>` is the Source ID (number) obtained through the UI.

In the body of the POST, use form-data as follows:

- **Key**: `connector_disableLDAPHostnameVerification`
- **Value**: `true`

#### JNDI Environment Properties

You can set up the following environment properties using the REST API:

`POST <url>/api/source/update/<sourceID>`

- `<url>` is the URL for your SailPoint instance.
- `<sourceID>` is the Source ID (number) obtained through the UI.

In the body of the POST, use form-data as follows:

- **Key**: `connector_com.sun.jndi.ldap.connect.pool` with the value **true**
- **Key**: `connector_com.sun.jndi.ldap.read.timeout` with the value **120000**

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

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