# SailPoint LDAP Connector Documentation

> LDAP Connector Documentation

# Documentation

# Account Move/Rename Operation

To support account move and rename operations, the connector requires Unique Account Attribute value for specific LDAP server.

Ensure to follow the below steps depending on the Unique Account Attribute value type :

1. On the [Additional Settings](<https://documentation.sailpoint.com/connectors/ldap/va/help/connecting.html#additional-settings>) page, provide the respective the **Unique Account Attribute** for your directory server that you are connecting via the connector. This attribute must be unique within the given directory. Refer to the table below for common Unique Account Attribute names for known directory servers.

   The value of this attribute may be stored in a binary format rather than a string. If so, ensure you configure this attribute referring the correct data type for your specific LDAP server to ensure proper handling.

   | LDAP Server | Unique Account Attribute | Attribute Value Type |
   | --- | --- | --- |
   | ADAM (AD LDS) | objectGUID | Binary |
   | IBM Tivoli Directory Server | ibm-entryuuid | String |
   | Novell eDirectory | GUID | Binary |
   | ODSEE (SunOne) | nsUniqueId | String |
   | OpenLDAP | entryUUID | String |
   | Oracle Internet Directory (OID) | orclGUID | Binary |
   | Oracle Unified Directory (OUD) | entryUUID | String |
   | 389 Directory Server | entryUUID | String |
2. If the Unique Account Attribute value in the LDAP server is stored in binary format, in addition to adding Unique Account Attribute in Additional Settings page, ensure to add `attributesInBinaryFormat` and `uuidInLittleEndianFormat` attributes to the source configuration to support account move and rename operations. For more information, refer to [Configuration for Binary Type Attributes](<https://documentation.sailpoint.com/connectors/ldap/va/help/additional_config_params.html#configuration-for-binary-type-attributes>).

### Provisioning for Move/Rename Operation

To handle move and rename operations, you need to send special provisioning attributes in an AttributeRequest. The following table lists the special attributes to handle the move and rename operations.

| Attribute | Description |
| --- | --- |
| AC\_NewName | A string attribute that specifies the new name for the user. For example, cn=abc,uid=xyz |
| AC\_NewParent | A string attribute that specifies the new organizational unit (OU) for the user. For example, ou=xyz,dc=pqr,dc=com |

# Additional Configuration Attributes

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

Use the following attributes to configure additional features available in the connector.

> [!NOTE]
>
> **unlockWithSamePassword**
>
> Configure this attribute with a value of `true` if the unlock operation requires changing the user password with the existing password used to unlock the user account.

> [!NOTE]
>
> **groupEntitlementAttr**
>
> The entitlement attribute name in the account schema should always be `groups`. If you need to change it to some other name, make sure that the `groupEntitlementAttr` value from the source is updated to reflect the modified account entitlement attribute name.
>
> For example, if the account entitlement attribute name is **posixgroups**, then add the following entry in the source XML using the REST APIs:
>
> ```json
> [
>   {
>     "op": "add",
>     "path": "/connectorAttributes/groupEntitlementAttr",
>     "value": posixgroups
>   }
> ]
> ```
>
> > **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.

> [!NOTE]
>
> **disableDefaultGroupClassFilter**
>
> Set the `disableDefaultGroupClassFilter` attribute to true to remove the default objectClass requirement (such as `objectClass=groupOfNames`) from LDAP search queries during group membership aggregation. This allows the connector to search for membership without filtering by a specific group class.
>
> For example,
>
> A default query looks like below:
>
> `(&(objectclass=groupOfNames)(member=cn=anabab,ou=Users,ou=Active,o=Corp))`
>
> Query with disableDefaultGroupClassFilter enabled:
>
> `(member=cn=anabab,ou=Users,ou=Active,o=Corp)`
>
> To apply this change, add the following to your source configuration using the SailPoint REST API:
>
> ```json
> {
>   "op": "add",
>   "path": "/connectorAttributes/disableDefaultGroupClassFilter",
>   "value": "true"
> }
> ```

> [!NOTE]
>
> **groupMembershipSearchScope**
>
> To support multiple entitlement types using a single account search DN, you can define different `groupMembershipSearchScope` values based on the group objectType.
>
> > **Note**
> >
> > This configuration must be performed using SailPoint REST APIs. It cannot be configured using the LDAP Source user-interface.
>
> Use the following PATCH request to update the `connectorAttributes` for your source:
>
> **Endpoint**: PATCH /v3/sources/:id
>
> **Body**:
>
> ```json
> [
>     {
>         "op": "replace",
>         "path": "/connectorAttributes/searchDNs",
>         "value": [
>             {
>                 "searchDN": "ou=OP2,dc=maxcrc,dc=com",
>                 "searchScope": "SUBTREE",
>                 "groupMembershipSearchScope": [
>                     {
>                         "groupMembershipSearchDN": [
>                             "ou=OP1,dc=maxcrc,dc=com"
>                         ],
>                         "groupMemberFilterString": null,
>                         "objectType": "posixgroup"
>                     },
>                     {
>                         "groupMembershipSearchDN": [
>                             "ou=OP1,dc=maxcrc,dc=com"
>                         ],
>                         "groupMemberFilterString": null,
>                         "objectType": "sudoRole"
>                     },
>                     {
>                         "groupMembershipSearchDN": [
>                             "ou=OP1,dc=maxcrc,dc=com"
>                         ],
>                         "groupMemberFilterString": null,
>                         "objectType": "group"
>                     }
>                 ],
>                 "iterateSearchFilter": null
>             }
>         ]
>     }
> ]
> ```

## Configuration for Binary Type Attributes

If the attributes value in the LDAP server is stored in binary format, ensure to add the following attributes to the source configuration:

> [!NOTE]
>
> **attributesInBinaryFormat**
>
> This specifies which LDAP attributes should be fetched in binary format.
>
> > **Important**
> >
> > This is an optional attribute. If the unique account attribute (like a UUID) is binary, you must include it in this list to ensure move and rename operations work correctly.
>
> To handle attributes for non-AD LDAP/ADAM/EDirectory servers (such as OpenLDAP or Tivoli), add the multi-valued `attributesInBinaryFormat` attribute to the source configuration.
>
> 1. Update the PATCH request payload by adding the following attributes:
>
>    ```json
>    [
>        {
>            "op": "add",
>            "path": "/connectorAttributes/attributesInBinaryFormat",
>            "value": [<binaryAttribute_1>, <binaryAttribute_2>, <uuid_Attribute>]
>        }
>    ]
>    ```
> 2. Perform the PATCH request to the source endpoint.
>
>    `PATCH /v3/sources/:id`

> [!NOTE]
>
> **uuidInLittleEndianFormat**
>
> This boolean attribute determines how binary attributes are converted to strings for processing. The format can be either little-endian (such as in Microsoft AD, ADAM) or big-endian (such as in Novell eDirectory).
>
> Add the `uuidInLittleEndianFormat` attribute to specify the correct conversion method.
>
> - `false` : Attributes are converted to strings in big-endian format. This is a default value.
> - `true`: Attributes are converted to strings in little-endian format.
> - Update the PATCH request payload by adding the following attributes:
>
>   ```json
>   [
>       {
>           "op": "add",
>           "path": "/connectorAttributes/uuidInLittleEndianFormat",
>           "value": true
>       }
>   ]
>   ```
> - Perform the PATCH request to the source endpoint.
>
>   `PATCH /v3/sources/:id`

# Connecting SailPoint and LDAP

To connect SailPoint with LDAP, 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

Choose the appropriate authentication type and provide the information required to connect and interact with the source.

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 selected Authorization Type, complete the following fields:

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

     > **Screenshot**
     >
     > [![Simple or None authentication fields](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/simple_auth.png>)](<https://documentation.sailpoint.com/connectors/ldap/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/ldap/va/help/img/sasl_auth.png>)](<https://documentation.sailpoint.com/connectors/ldap/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. The search DNs defines the list of container distinguished names along with other relevant attributes that define the scope for this application. Accounts and groups can have different sets of search DNs and you can define different scopes for each of them.

### Account Search Scope

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

Multiple Search DN entries can be configured to define the account search scope.

> [!NOTE]
>
> At least one Search DN needs to be configured for the account search scope.

To configure the account search scope, complete the following:

1. Enter the **Search DN** (distinguished name) to search for the accounts that you want to load. For example:

   `ou=HR,dc=org,dc=com`
2. (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))`
3. (Optional) Enter the **Group Member Search DN** to specify the group memberships of the users that you are loading.

   > **Note**
   >
   > If no value is provided, then the default scope of Group Membership is the **Search DN** value.
4. Select **Save**.

### Group Search Scope

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

> [!NOTE]
>
> By default, if the scope is not defined for groups, the connector uses the Account search scope.

To configure the group search scope, complete the following:

1. (Optional) Enter the **Search DN** (distinguished name) to search for the groups that you want to load. For example:

   `ou=Groups,dc=org,dc=com`
2. (Optional) Enter the **LDAP Search Filter** to specify an optional filter that limits the results returned by the **Search DN**. For example, to fetch groups that start with the letter `g`, enter the following:

   `(cn=g*)`
3. Select **Save**.

> [!NOTE]
>
> Only `group.iterateSearchFilter` will be respected during group aggregation.

## Additional Settings

Use these additional settings to further configure aggregation, enable and disable operations, lock and unlock operations, and the LDAP password attribute.

For sample data information for the fields and corresponding LDAP server, refer to [Sample Configuration Data for LDAP Servers](<#sample-configuration-data-for-ldap-servers>).

### Aggregation Configuration

> [!NOTE]
>
> **Screenshot**
>
> [![Aggregation Configuration](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/additional_settings.png>)](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/additional_settings.png>)

To configure aggregation, complete the following as required:

1. Select the **Delta Aggregation** checkbox to aggregate changes in the account which occurred since the last aggregation was completed.
2. Select the **Delta Iteration Mode** used to detect changes in the directory during delta aggregation. Make sure the directory server supports the selected Delta Iteration Mode.

   > **Note**
   >
   > - The **Modify Time Stamp** option does not fetch details of deleted objects.
   > - For **USN Change** and **Change Log** to function properly, the configuration settings need to be updated on the LDAP server.
3. (Only applicable if you select the **USN Change** option from the **Delta Iteration Mode** drop-down menu) Enter the **Deleted Objects Container DN** for the appropriate container for deleted objects. You need to configure the Deleted Container DN to fetch the deleted objects in delta aggregation. For example:

   `CN=Deleted Objects,dc=sailpoint,dc=com`
4. Enter the **Page Size** to set the maximum number of results fetched by a single page during the search operation. The default is `100`.
5. Configure **Unique Account Attribute** with an attribute that never changes for the account in its life cycle and can be used to uniquely identify the account.

   > **Note**
   >
   > To support account move and rename operations, ensure to provide a Unique Account Attribute for the configured LDAP server. For more information, refer to [Account Move/Rename Operation](<https://documentation.sailpoint.com/connectors/ldap/va/help/account_move_rename_operation.html>).
6. Configure **Enable Group Membership Cache** to enable group membership caching during account aggregation.

   Aggregating account data from Generic LDAP servers can take a long time, especially when many accounts have multiple group memberships. This can slow down performance during aggregation.

   To solve this issue, you can enable group membership caching. This feature creates an internal cache of group membership data during aggregation, which reduces processing time and improves performance.

   This feature is enabled by default for newly created sources. For existing sources, update your source configuration by adding the following entry:

   ```json
   [
     {
       "op": "add",
       "path": "/connectorAttributes/enableGroupMembershipCache",
       "value": true
     }
   ]
   ```

   where:

   - `true` - Enables group membership caching
   - `false` - Disables caching (default)

   > **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.
7. Select **Save**.

### Enable and Disable Operation Configuration

> [!NOTE]
>
> **Screenshot**
>
> [![Enable and Disable Operation Configuration](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/enable_disable_configuration.png>)](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/enable_disable_configuration.png>)

To configure the enable and disable operations, complete the following:

1. Configure **Revoke Attribute Name** with an attribute that indicates whether the account is enabled or disabled.

   > **Note**
   >
   > The Revoke Attribute Name and Restore Attribute Name should be the same on your LDAP server.
2. Configure the **Revoke Attribute Value** with the value needed to set the Revoke Attribute while the account is being disabled.
3. In the **Revoke Action** field, configure the required action to perform during the revoke operation. If this value needs to be updated, the action can be **ADD** or **REPLACE**. Leave this field blank to remove the Revoke Attribute from the account.
4. Configure **Restore Attribute Name** with an attribute that indicates whether the account is enabled or disabled.
5. Configure the **Restore Attribute Value** with the value needed to set the Restore Attribute while the account is being enabled.
6. In the **Restore Action** field, configure the required action to perform during the restore operation. If this value needs to be updated, the action can be **ADD** or **REPLACE**. Leave this field blank to remove the Restore Attribute from the account.
7. Select **Save** after you have completed your configuration.

### Lock and Unlock Operation Configuration

> [!NOTE]
>
> **Screenshot**
>
> [![Lock and Unlock Operation Configuration](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/lock_unlock_configuration.png>)](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/lock_unlock_configuration.png>)

To configure the lock and unlock operations, complete the following:

1. Enter a **Lock Attribute Name** to indicate whether the account is locked or unlocked.
2. Enter the **Unlock Attribute Name(s)** that need to be updated during the Unlock Operation. Enter multiple values by adding an attribute and then pressing the Enter key.
3. Configure **Unlock Attribute Value** with the value SailPoint sets for the attributes listed in the **Unlock Attribute Name(s)** list. Leave this field blank to remove the Unlock Attributes from the account during the Unlock Operation.
4. In the **Unlock Action** field, configure the required action to perform during the Unlock Operation. If this value needs to be updated, the action can be **ADD** or **REPLACE**. Leave this field blank to remove the Unlock Attributes from the account.
5. Select **Save**.

### Password Attribute Name Configuration

> [!NOTE]
>
> **Screenshot**
>
> [![Password Attribute Name Configuration](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/additional_configuration.png>)](<https://documentation.sailpoint.com/connectors/ldap/va/help/img/additional_configuration.png>)

To configure the password attribute, complete the following:

1. Enter the **Password Attribute Name** for the LDAP server.
2. Enter the **Password Expiry Attribute Name** to update when the administrator reset operation is performed. For example:

   `pwdReset`

   `passwordExpirationTime`
3. Enter the **Immediate Password Expiry Attribute Value** to be set for the password expiry attribute when the administrator resets the password for the user. For example, set the value for `pwdReset` attribute to `true`.
4. Select **Save**.

### Sample Configuration Data for LDAP Servers

Use the following table as a reference for sample configuration data for the fields on the **Additional Settings** page.

The first row lists each LDAP server and the associated values can be found by going down the column and locating the row with the attribute you want to configure.

| Attributes | ADAM | OUD | DS 389 | Tivoli | Novell | SunOne |
| --- | --- | --- | --- | --- | --- | --- |
| Password Attribute Name | userPassword | userPassword | userPassword | userPassword | userPassword | userPassword |
| Revoke Attribute Name | msDS-UserAccountDisabled | orcllsEnabled | nsAccountLock | N/A | loginDisabled | nsRoleDN |
| Restore Attribute Name | msDS-UserAccountDisabled | orcllsEnabled | nsAccountLock | N/A | loginDisabled | nsRoleDN |
| Lock Attribute Name | N/A | pwdaccountlockedtime | passwordLockout | pwdAccountLockedTime | lockedByIntruder | passwordLockout |
| Unlock Attribute Name(s) | N/A | pwdFailureTime, pwdaccountlockedtime | passwordLockout | pwdAccountLockedTime, pwdFailureTime | lockedByIntruder | pwdAccountLockedTime, pwdReset |
| Revoke Action | N/A | N/A | REPLACE | N/A | N/A | N/A |
| Restore Action | REPLACE | N/A | N/A | N/A | N/A | N/A |

## 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 Lightweight Directory Access Protocol

This document is designed to give specific information about requirements and field definitions needed to configure a working instance of a Lightweight Directory Access Protocol (LDAP) connector. The LDAP source is generic, so you can configure connections with any LDAP server.

Your configuration may vary based on the LDAP server you connect to.

> [!TIP]
>
> To support LDAP managed systems that are not on the supported list or are integrated LDAP server systems, the implementation must follow the Generic LDAP connector design. Ensure the configuration is updated according to the provided documentation and guidelines to ensure full functionality.

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

> [!NOTE]
>
> Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. For more information on SailPoint features, refer to [Source Features](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-Source-Features>).

The SailPoint LDAP source supports the following features:

- Load LDAP accounts
- \*Provision LDAP accounts
- \*Access Certifications (certification of entitlements connected to accounts)
- \*Password management
- Delta Aggregation for accounts
- Unlock account
- Enable and disable accounts
- Delete accounts
- Account Move and Rename

### Schema for Multiple Groups

To use multiple group schema, add the following entry to the source XML:

```text
<entry key="LDAPApplicationVersion" value="2.0"/>
```

For more information, refer to [Schema Reference](<https://documentation.sailpoint.com/connectors/ldap/va/help/schema.html>).

## Supported Managed Systems

Lightweight Directory Access Protocol (LDAP) is a generic solution to interact with many types of LDAP systems. It provides flexibility to configure the source with all the details required to connect most LDAP systems.

SailPoint is certified to work with the following LDAP servers:

- ADAM (AD LDS)
- ODSEE
- Novell (NetIQ) eDir
- IBM Tivoli DS
- OpenLDAP
- Oracle Internet Directory
- DS 389
- Oracle Unified Directory (OUD)

## Prerequisites

- Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
- Create a service account on LDAP with the required permissions.

## Required Permissions

- The LDAP source requires that the service account must be an administrator account and that the directory server has administrator credentials.
- The LDAP source must have read/write permissions over the directory information tree to manage LDAP data.

# Machine Account Attributes

Machine account attributes are used in provisioning configurations for machine accounts.

After you have [created the required machine account subtypes](<https://documentation.sailpoint.com/saas/help/machine/account_configuration.html#creating-machine-account-subtypes>), you can use the machine account attributes to provision machine accounts in your SailPoint tenant.

Refer to [Machine Identity Security Overview](<https://documentation.sailpoint.com/saas/help/machine/index.html>) for more information.

> [!NOTE]
>
> Attributes marked with an asterisk (\*) are mandatory.

## Machine Account Provisioning Attributes

| Create Account Attribute | Description |
| --- | --- |
| dn\* | Distinguished name of the entry to be created. For example: `uid=svc-jobrunner,ou=Services,dc=example,dc=com`. The connector treats `dn` as the immutable native identity. |
| password\* | Password of the entry to be created. |
| CN\* | Full name (common name) of the entry to be created. Must match the `cn=` component used in the `dn` when `cn` is the naming attribute. |
| givenName | First name of the entry to be created. Optional for machine accounts. |
| SN | Last name (surname) of the entry. Required by `inetOrgPerson`-based schemas; populate with a placeholder (for example, the service name) for machine accounts. |

# Retry Configurations

> [!IMPORTANT]
>
> Add a list of retryable error messages to the attributes map of the source configuration. The value must be specified as a list or array even when only a single error string is provided.

## Provisioning Retry Errors

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

SailPoint connectors that support provisioning operations have the ability to retry a failed operation based on configurable error messages.

The `retryableErrors` entry in the connector configuration is a list of strings that the connector searches for in the error message received from the managed source. If any of the configured error strings are found in the error message, the connector will attempt to retry the provisioning operation.

Add a list of retryable error messages to the attributes map of the source configuration. The value must be specified as a list or array even when only a single error string is provided. If the error message contains one of the specified strings, the connector will initiate a retry attempt. However, if the configured error string is not present in the error message, the connector will consider the operation as failed and will not attempt a retry.

Add the following entry in the source XML using the SailPoint REST APIs:

For example,

Use the SailPoint API by sending a PATCH request to the /v3/sources/{id} endpoint:

`PATCH https://{orgName}.api.identitynow.com/v3/sources/:id`

In the body of the PATCH, enter the retryable errors as follows:

```json
[
    {
        "op": "add",
        "path": "/connectorAttributes/retryableErrors",
        "value": [
            "<error_message_1>",
            "<error_message_2>"
        ]
    }
]
```

> [!NOTE]
>
> Error messages containing very specific information about date/time, sequence ID and so on must be avoided. Error codes or error message substrings would be good candidates for inclusion.

## Aggregation Retry Errors

Aggregation retries can be set up for each source by configuring the `aggregationRetryErrors` attribute under the `connectorAttributes` section.

Send a PATCH request to the `/v3/sources/{id}` endpoint:

`PATCH https://{orgName}.api.identitynow.com/v3/sources/:id`

In the body of the PATCH, enter the `aggregationRetryErrors` as follows:

```json
{
    "op": "add",
    "path": "/connectorAttributes/aggregationRetryErrors",
    "value": ["Connection reset"]
}
```

In addition to specifying the aggregation retry errors, you can also configure the following options:

> [!NOTE]
>
> **retryWaitTime**
>
> A string specifying the amount of time (in milliseconds) to wait before attempting a retry. The default value is 5000 milliseconds (5 seconds).
>
> In the body of the PATCH, enter the `retryWaitTime` as follows:
>
> ```json
> {
>     "op": "add",
>     "path": "/connectorAttributes/retryWaitTime",
>     "value": "5000"
> }
> ```

> [!NOTE]
>
> **maxRetryCount**
>
> A string defining the maximum number of retry attempts that will be performed. The default value is 3.
>
> In the body of the PATCH, enter the `maxRetryCount` as follows:
>
> ```json
> {
>     "op": "add",
>     "path": "/connectorAttributes/maxRetryCount",
>     "value": "3"
> }
> ```

# 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 LDAP connector uses the following default correlation and object configurations.

This connector supports two types of objects: account and group. The default schema is provided for both accounts and groups, and can be modified per the connection requirements of your LDAP server. The application only supports a single group object. The schema for a group object can be modified to support other native group types such as `posixgroup` and `nisNetgroup`, depending on your LDAP server.

> [!NOTE]
>
> The name of the `objectType` must be the same as the name of the `objectType` of the respective group schema for which the scope is defined.

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

The LDAP 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 | Type |
| --- | --- | --- |
| businessCategory | The business category. |  |
| carLicense | The vehicle license or registration plate. |  |
| cn | The common name(s) for which the entity is known by. |  |
| dn | The distinguished name for which the entity is known by. |  |
| departmentNumber | The identifies a department within an organization. |  |
| description | The descriptive information. |  |
| destinationIndicator | The destination indicator. |  |
| displayName | The preferred name to be used when displaying entries. |  |
| employeeNumber | The numerically identifies an employee within an organization. |  |
| employeeType | The type of employment for a person. |  |
| facsimileTelephoneNumber | The Facsimile (Fax) Telephone Number. | Multi-Valued |
| givenName | The first name(s) for which the entity is known by. |  |
| groups | List of groups a user is a member. Schema Object Type: group | Entitlement, Multi-Valued |
| homePhone | The home telephone number. |  |
| homePostalAddress | The home postal address. |  |
| initials | The initials of some or all of names, but not the surname(s). |  |
| internationaliSDNNumber | The international ISDN number. |  |
| l | The city. |  |
| mail | The RFC822 Mailbox. |  |
| manager | The DN of manager. |  |
| mobile | The mobile telephone number. |  |
| o | The organization this object belongs to. |  |
| ou | The organizational unit this object belongs to. |  |
| pager | The pager telephone number. |  |
| physicalDeliveryOfficeName | The name of physical delivery office. |  |
| postOfficeBox | The post office box. |  |
| postalAddress | The postal address. |  |
| postalCode | The postal code. |  |
| preferredDeliveryMethod | The preferred delivery method. |  |
| preferredLanguage | The preferred written or spoken language for a person. |  |
| pwdReset | The specifies whether the password has been reset by admin. |  |
| registeredAddress | The registered postal address. |  |
| roomNumber | The room number. |  |
| secretary | The DN of secretary. |  |
| seeAlso | The DN of related object. |  |
| sn | The last (family) name(s) for which the entity is known by. |  |
| st | The state or province which this object resides in. |  |
| street | The street address of this object. |  |
| telephoneNumber | The telephone number. |  |
| teletexTerminalIdentifier | The teletex terminal identifier. |  |
| telexNumber | The telex number. |  |
| title | The title associated with the entity. |  |
| uid | The user identifier. |  |
| objectClass | The object classes of the entity. | Multi-Valued |
| posixgroups | List of posix groups a user is a member. Schema Object Type: posixgroup | Entitlement, Multi-Valued |
| nisNetgroups | List of nisnet groups a user is a member. Schema Object Type: nisNetgroup | Entitlement, Multi-Valued |

> [!IMPORTANT]
>
> Group membership filters are not applied if the LDAP source schema entitlement attribute name is identical to the attribute name on the target system. To ensure filtering works correctly, use a unique attribute name in the schema. For example, if the target system uses `sudoRoleMemberOf`, define the schema attribute as `sudoRoleMemberOfGroup` to ensure filtering works correctly during account aggregation.

### Adding Schema to the Source

> [!NOTE]
>
> If you want to add `sudoRoles` and `groupOfNames` schema to the source, you need to add the respective account attributes in the **Account Schema**.

The following example shows how to add the `sudoRoles` and `groupOfNames` schema to the source XML:

```json
{
  "AttributeDefinition": [
    {
      "entitlement": "true",
      "managed": "true",
      "multi": "true",
      "name": "sudoRoles",
      "schemaObjectType": "sudoRole",
      "type": "string",
      "Description": "List of sudo roles a user is a member"
    },
    {
      "entitlement": "true",
      "managed": "true",
      "multi": "true",
      "name": "groupOfNames",
      "schemaObjectType": "groupOfNames",
      "type": "string",
      "Description": "List of groupOfNames a user is a member"
    }
  ]
}
```

For more information on the attribute lists of `sudoRole` and `groupOfNames`, refer to [Sudo Role Attributes](<#sudo-role-attributes>) and [groupOfNames Attributes](<#groupofnames-attributes>).

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

The following lists the group of unique names attributes:

| Attribute Name | Description |
| --- | --- |
| cn | The common name(s) for which the entity is known by. |
| dn | The directory path. |
| description | The descriptive information. |
| o | The organization this object belongs to. |
| ou | The organizational unit this object belongs to. |
| owner | The owner (of the object). |

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

#### Schema Example

The following example shows how to add the `group` schema to the source XML:

```json
{
  "Schema": {
    "displayAttribute": "cn",
    "featuresString": "PROVISIONING",
    "identityAttribute": "dn",
    "nativeObjectType": "groupOfUniqueNames",
    "objectType": "group",
    "AttributeDefinition": [
      {
        "name": "cn",
        "type": "string",
        "Description": "common name(s) for which the entity is known by"
      },
      {
        "name": "dn",
        "type": "string",
        "Description": "Directory Path"
      },
      {
        "name": "o",
        "type": "string",
        "Description": "organization this object belongs to"
      },
      {
        "name": "ou",
        "type": "string",
        "Description": "organizational unit this object belongs to"
      },
      {
        "name": "owner",
        "type": "string",
        "Description": "owner (of the object)"
      },
      {
        "name": "description",
        "type": "string",
        "Description": "descriptive information"
      }
    ],
    "Attributes": {
      "Map": {
        "entry": [
          {
            "key": "groupMemberAttribute",
            "value": "uniqueMember"
          },
          {
            "key": "memberAttribute",
            "value": "dn"
          }
        ]
      }
    }
  }
}
```

### NisNet Group Attributes

The following lists the `nisNetgroup` attributes:

| Attribute Name | Description |
| --- | --- |
| cn | The common name(s) for which the entity is known by. |
| dn | The directory path. |
| description | The descriptive information. |
| nisNetgroupTriple | The unique member of a nisNetgroup. |

#### Schema Example

The following example shows how to add the `nisNetgroup` schema to the source XML:

```json
  {
        "nativeObjectType": "nisNetgroup",
        "identityAttribute": "dn",
        "displayAttribute": "cn",
        "hierarchyAttribute": null,
        "includePermissions": false,
        "features": [
            "PROVISIONING"
        ],
        "configuration": {
            "memberPrefix": "{,",
            "memberAttribute": [
                "cn",
                "uid"
            ],
            "memberSuffix": ",}",
            "groupMemberAttribute": "nisNetgroupTriple"
        },
        "attributes": [
            {
                "name": "cn",
                "type": "STRING",
                "schema": null,
                "description": "common name(s) for which the entity is known by",
                "isMulti": false,
                "isEntitlement": false,
                "isGroup": false
            },
            {
                "name": "nisNetgroupTriple",
                "type": "STRING",
                "schema": null,
                "description": "unique member of a nisNetgroup",
                "isMulti": true,
                "isEntitlement": false,
                "isGroup": false
            },
            {
                "name": "dn",
                "type": "STRING",
                "schema": null,
                "description": "Directory Path",
                "isMulti": false,
                "isEntitlement": false,
                "isGroup": false
            },
            {
                "name": "description",
                "type": "STRING",
                "schema": null,
                "description": "descriptive information",
                "isMulti": false,
                "isEntitlement": false,
                "isGroup": false
            }
        ],
        "id": "ada0ca21da9d450aa80addd68bd2102d",
        "name": "nisNetgroup",
        "created": "2024-10-08T12:05:50.004Z",
        "modified": "2024-10-08T12:05:50.004Z"
    },
```

### Posix Group Attributes

The following lists the `posixgroup` attributes:

| Attribute Name | Description | Type |
| --- | --- | --- |
| cn | The common name(s) for which the entity is known by. |  |
| dn | The directory path. |  |
| description | The descriptive information. |  |
| gidNumber | The group ID. |  |
| memberUid | The unique member of a posixGroup. | Multi-Valued |

#### Schema Example

The following example shows how to add the `posixgroup` schema to the source XML:

```json
{
  "nativeObjectType": "posixgroup",
  "identityAttribute": "dn",
  "displayAttribute": "cn",
  "hierarchyAttribute": null,
  "includePermissions": false,
  "features": [
    "PROVISIONING"
  ],
  "configuration": {
    "memberAttribute": [
      "cn",
      "uid"
    ],
    "groupMemberAttribute": "memberUid"
  },
  "attributes": [
    {
      "name": "cn",
      "type": "STRING",
      "description": "common name(s) for which the entity is known by",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "memberUid",
      "type": "STRING",
      "description": "unique member of a posixGroup",
      "isMulti": true,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "dn",
      "type": "STRING",
      "description": "Directory Path",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "gidNumber",
      "type": "STRING",
      "description": "Group ID",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "description",
      "type": "STRING",
      "description": "descriptive information",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    }
  ]
}
```

### Sudo Role Attributes

The following lists the `sudoRole` attributes:

| Attribute Name | Description | Type |
| --- | --- | --- |
| cn | The common name(s) for which the entity is known by. |  |
| dn | The directory name. |  |
| description | The descriptive information. |  |
| sudoUser | The unique member of a sudoRole. | Multi-Valued |

#### Schema Example

The following example shows how to add the `sudoRole` schema to the source XML:

```json
{
  "nativeObjectType": "sudoRole",
  "identityAttribute": "dn",
  "displayAttribute": "cn",
  "hierarchyAttribute": null,
  "includePermissions": false,
  "features": [
    "PROVISIONING"
  ],
  "configuration": {
    "memberAttribute": [
      "cn"
    ],
    "groupMemberAttribute": "sudoUser"
  },
  "attributes": [
    {
      "name": "dn",
      "type": "STRING",
      "description": "Directory Path",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "cn",
      "type": "STRING",
      "description": "common name(s) for which the entity is known by",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "sudoUser",
      "type": "STRING",
      "description": "unique member of a posixGroup",
      "isMulti": true,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "description",
      "type": "STRING",
      "description": "descriptive information",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    }
  ]
}
```

### groupOfNames Attributes

The following lists the `groupOfNames` attributes:

| Attribute Name | Description |
| --- | --- |
| cn | The common name(s) for which the entity is known by. |
| dn | The directory path. |
| description | The descriptive information. |
| o | The organization this object belongs to. |
| ou | The organizational unit this object belongs to. |
| owner | The owner (of the object). |

#### Schema Example

The following example shows how to add the `groupOfNames` schema to the source XML:

```json
{
  "nativeObjectType": "groupOfNames",
  "identityAttribute": "dn",
  "displayAttribute": "cn",
  "hierarchyAttribute": null,
  "includePermissions": false,
  "features": [
    "PROVISIONING",
    "GROUPS_HAVE_MEMBERS"
  ],
  "configuration": {
    "memberAttribute": [
      "dn"
    ],
    "groupMemberAttribute": "member"
  },
  "attributes": [
    {
      "name": "cn",
      "type": "STRING",
      "description": "common name(s) for which the entity is known by",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "dn",
      "type": "STRING",
      "description": "Directory Path",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "o",
      "type": "STRING",
      "description": "organization this object belongs to",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "ou",
      "type": "STRING",
      "description": "organizational unit this object belongs to",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "owner",
      "type": "STRING",
      "description": "owner (of the object)",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "description",
      "type": "STRING",
      "description": "descriptive information",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    }
  ]
}
```

# Enable Connector Logging

This topic provides the steps needed to enable logging on SailPoint using REST APIs.

> [!NOTE]
>
> This topic only applies to VA-based integrations.

> [!NOTE]
>
> The examples provided might not match your configuration. Use the logging levels and logging classes reference at the bottom of the topic to configure your API responses to match your connector.

This process is broken up into four steps:

1. Identify the Virtual Appliance (VA) cluster on which you want to enable logging.
2. Get the logging configuration for the existing VA cluster.
3. Update the VA cluster to enable logging levels.
4. Observe logging changes to the logging levels.

### Identify the Virtual Appliance Cluster

Select the VA on which you need to enable logging using REST API. If you already know the VA application's `id`, proceed to [Get the Logging Configuration](<#get-the-logging-configuration>).

1. Make the following call to the REST API to return a list of available VA clusters:

   GET /v3/managed-clusters

   The REST API returns a response that looks similar to the following:

   ```json
   [
       {
           "id": "2c9180866166b5b0016167c32ef31a66",
           "name": "Development Cluster",
           "description": "Development Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": null
       },
       {
           "id": "2c9180846a93ce60016ab29f039944de",
           "name": "Cloud Cluster",
           "description": "Cloud Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": {
               "clientId": null,
               "durationMinutes": 60,
               "expiration": "2020-12-15T19:13:36.079Z",
               "rootLevel": "DEBUG",
               "logLevels": {
                   "sailpoint.connector.ADLDAPConnector": "DEBUG"
               }
           }
       }
   ]
   ```

   > **Note**
   >
   > The previous example code shows two VA clusters. One VA cluster has a log configuration and the other does not (refer to the `logConfiguration` value in each returned VA cluster). This is because one of the clusters already has logging enabled. This is just an example configuration, and your environment may not have logging enabled on a cluster.
2. Identify the VA cluster that you want to enable logging on by its name or description and record its `id` attribute.

### Get the Logging Configuration

Get your selected VA's cluster logging configuration and identify the values you need to update.

1. Make the following call to the REST API to return the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier.

   GET /v3/managed-clusters/{id}/log-config

   - If the VA doesn't have a logging configuration currently set, it returns `204 No Content` as a response.
   - If the VA has an existing logging configuration, it returns something similar to the following:

     ```json
     {
         "clientId": null,
         "durationMinutes": 60,
         "expiration": "2020-12-15T19:13:36.079Z",
         "rootLevel": "DEBUG",
         "logLevels": {
             "sailpoint.connector.ADLDAPConnector": "DEBUG"
         }
     }
     ```

     You'll need to configure the following information in the response:

     - `durationMinutes` is the number of minutes logging should remain enabled.
     - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>).
     - `logLevels` is a map object with logging classes as keys and logging levels as values.

       - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes.
       - For a list of available values, refer to [Logging Levels](<#logging-levels>).

### Update Logging Configuration

Update the VA cluster configuration returned by the REST API to update the logging settings as needed.

1. Make the following call to the REST API to update the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier.

   PUT /v3/managed-clusters/{id}/log-config
2. Submit your configuration changes to the REST API in a JSON body.

   - If the VA cluster did not already have a logging configuration and you received a `204 No Content` response, you can create a new one.
   - If the VA returned a configuration, you can edit it to include the changes.

   The JSON body should be as follows:

   ```json
   {
       "durationMinutes": 60,
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   ```

   Consider the following as you edit the JSON:

   - `durationMinutes` is the number of minutes logging should remain enabled.
   - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>).
   - `logLevels` is a map object with logging classes as keys and logging levels as values.

     - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes.
     - For a list of available values, refer to [Logging Levels](<#logging-levels>).

   If the update was successful, the REST API should return a response similar to the following:

   ```json
   {
       "clientId": null,
       "durationMinutes": 60,
       "expiration": "2020-12-15T19:13:36.079Z",
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   ```

### Observe Logging Changes

Approximately five minutes after you update the configuration, the VA cluster starts generating log files you can review. You can view the log files in **ccg.log**.

### References

The tables in this reference section list information that can be helpful when creating the JSON body you'll use to configure the VA cluster's configuration file.

#### Logging Levels

| Logging Level | Description |
| --- | --- |
| ERROR | Designates error events that might still allow the connector to continue. |
| WARN | Designates potentially harmful situations. |
| INFO | Designates information messages that highlight process at a coarse-grain level. |
| DEBUG | Very verbose. Fine grain logging levels used for development and debugging. |
| TRACE | Most verbose. Finer grain logging levels than debugging. |

#### Logging Classes

| Connector | Logging Class |
| --- | --- |
| Active Directory | sailpoint.connector.ADLDAPConnector sailpoint.connector.LDAPConnector |
| AIX | openconnector.connector.unix.AIXConnector openconnector.connector.unix.UnixConnector |
| Amazon Web Services | logger.aws.name=openconnector.connector.aws logger.aws.level=trace logger.aws.additivity = false logger.aws.appenderRef.rolling.ref = STDOUT |
| Atlassian Suite Cloud | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianConnector |
| Atlassian Data Center | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianDataCenterConnector |
| Microsoft Entra ID | sailpoint.connector.AzureADConnector |
| Box | openconnector.connector.BoxNetConnector sailpoint.connector.OpenConnectorAdapter |
| Cerner | openconnector.connector.CernerConnector sailpoint.connector.OpenConnectorAdapter |
| Delimited File | logger.DelimitedFileConnector.name = sailpoint.connector.DelimitedFileConnector logger.DelimitedFileConnector.level = debug logger.DelimitedFileConnector.additivity = false logger.DelimitedFileConnector.appenderRef.rolling.ref = STDOUT |
| Dropbox | openconnector.connector.DropBoxConnector sailpoint.connector.OpenConnectorAdapter |
| Epic | openconnector.connector.EPICConnector sailpoint.connector.OpenConnectorAdapter |
| GE Centricity | openconnector.connector.GECentricity sailpoint.connector.OpenConnectorAdapter |
| Google Apps / G Suite | openconnector.connector.GoogleAppsDirect sailpoint.connector.OpenConnectorAdapter |
| IBM i | openconnector.connector.IBMiConnector |
| Lotus Domino | sailpoint.connector.LotusDomino |
| JDBC | sailpoint.connector.JDBCConnector |
| Sun One LDAP | sailpoint.connector.LDAPConnector |
| Linux | openconnector.connector.unix.LinuxConnector sailpoint.connector.OpenConnectorAdapter sailpoint.connector.UnixConnector |
| Microsoft Office365 | sailpoint.connector.Office365Connector |
| Microsoft SQL Server | sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2 |
| Okta | logger.openconnector.name = openconnector.connector.okta.OktaConnector logger.openconnector.level = debug logger.openconnector.additivity = false logger.openconnector.appenderRef.rolling.ref = STDOUT |
| Oracle Database | sailpoint.connector.OracleDBConnector sailpoint.connector.JDBCConnector |
| Oracle E-Business | sailpoint.connector.OracleEBSConnector sailpoint.connector.JDBCConnector |
| Oracle Fusion HCM | openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector sailpoint.connector.OpenConnectorAdapter |
| Oracle HCM Cloud | sailpoint.connector.oraclehcmcloud.OracleHCMCloudConnector |
| Oracle HRMS | sailpoint.connector.OracleAppsHRMSConnector sailpoint.connector.JDBCConnector |
| Oracle Netsuite | openconnector.connector.netsuite.NetsuiteConnector |
| PeopleSoft ERP | openconnector.connector.PeopleSoftConnector sailpoint.connector.OpenConnectorAdapter |
| PeopleSoft HRMS | sailpoint.connector.PeopleSoftHRMSConnector |
| RemedyForce | sailpoint.connector.ForceConnector |
| RSA Authentication Manager | openconnector.connector.RSAConnector openconnector.connector.rsa.RSAHTTPClient sailpoint.connector.OpenConnectorAdapter |
| Salesforce | sailpoint.connector.ForceConnector |
| SAP Concur | openconnector.connector.sapconcur.SAPConcurConnector |
| SAP - Direct | sailpoint.connector.SAPConnector sailpoint.connector.SAPInternalConnector |
| SAP GRC | logger.SAPGRCConnector.name = sailpoint.connector.sapgrc logger.SAPGRCConnector.level = debug logger.SAPGRCConnector.additivity = false logger.SAPGRCConnector.appenderRef.rolling.ref = STDOUT |
| SAP HR/HCM | sailpoint.connector.SAPHRInternalConnector |
| SCIM 1.1 | openconnector.connector.SCIMConnector sailpoint.connector.OpenConnectorAdapter |
| SCIM 2.0 | openconnector.connector.scim2.SCIM2Connector sailpoint.connector.OpenConnectorAdapter |
| ServiceNow | openconnector.connector.servicenow.ServiceNowConnector openconnector.connector.servicenow.ServiceNowRestClient sailpoint.connector.OpenConnectorAdapter |
| ServiceNow Service Desk Integration | openconnector.connector.servicedesk.ServiceNowServiceDeskConnector sailpoint.connector.OpenConnectorAdapter |
| Siebel | openconnector.connector.SiebelConnector sailpoint.connector.OpenConnectorAdapter |
| Snowflake | openconnector.connector.snowflake.SnowflakeConnector sailpoint.connector.OpenConnectorAdapter |
| Solaris | openconnector.connector.unix.SolarisConnector openconnector.connector.unix.UnixConnector sailpoint.connector.OpenConnectorAdapter |
| SuccessFactors | sailpoint.connector.SuccessFactorsConnector |
| Sybase | sailpoint.connector.SybaseDirectConnector sailpoint.connector.JDBCConnector |
| Webex | openconnector.connector.Webex sailpoint.connector.OpenConnectorAdapter |
| Workday | openconnector.connector.WorkDay sailpoint.connector.OpenConnectorAdapter |
| Workday Accounts | openconnector.connector.workdayaccounts openconnector.connector.workdayaccounts.WorkdayAccountsConnector sailpoint.connector.OpenConnectorAdapter |
| Web Services | sailpoint.connector.WebServices |
| XML | openconnector.connector.XMLConnector sailpoint.connector.OpenConnectorAdapter |
| Yammer | openconnector.connector.YammerConnector sailpoint.connector.OpenConnectorAdapter |
| Zoom | openconnector.connector.zoom.ZoomConnector sailpoint.connector.OpenConnectorAdapter |

# Troubleshooting

If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support.

For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information:

- [SailPoint Identity Services Documentation](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

## Accounts Are Being Aggregated During the Entitlements Aggregation Process, or Entitlements Are Not Being Aggregated Correctly

**Resolution** - Verify the `searchDNs` configuration. In both cases, define `group.searchDNs` based on your specific group schema object types. For example, if your application uses three group schema types, `sudoRole`, `posixGroup`, and `group`, configure accordingly.

Configure three separate `group.searchDNs` entries, one for each group object type:

```xml
<entry key="sudpRole.searchDNs">
  <value>
    <List>
      <Map>
        <entry key="iterateSearchFilter" value="(objectClass=sudpRole)"/>
        <entry key="objectType" value="sudpRole"/>
        <entry key="searchDN" value="ou=sudpRole,dc=org,dc=com"/>
      </Map>
    </List>
  </value>
</entry>
<entry key="posixgroup.searchDNs">
  <value>
    <List>
      <Map>
        <entry key="iterateSearchFilter" value="(objectClass=posixgroup)"/>
        <entry key="objectType" value="posixgroups"/>
        <entry key="searchDN" value="ou=posixgroups,dc=org,dc=com"/>
      </Map>
    </List>
  </value>
</entry>
<entry key="group.searchDNs">
  <value>
    <List>
      <Map>
        <entry key="iterateSearchFilter" value="(objectClass=group)"/>
        <entry key="objectType" value="group"/>
        <entry key="searchDN" value="ou=group,dc=org,dc=com"/>
      </Map>
    </List>
  </value>
</entry>
```

## LDAP Source Delta Aggregation Deleting Accounts During Account Aggregation

**Resolution** - For the LDAP Connector, the default `objectClass` is defined as `inetOrgPerson` and this is not expected to be changed. Check if `inetOrgPerson` is present as `objectclass` property on the User object on the LDAP target system. If not, add it manually.

## LDAP Account Unlock Operation Fails with an Error Stating That `unlockAttr` Value Is Null

Error message example:

```text
2022-12-09T13:14:09,786 ERROR https-jsse-nio-8443-exec-1 sailpoint.connector.LDAPConnector:10387 - 1034091406 Failed to unlock Account[uid=NQTest01,ou=people,ou=workforce,dc=telefonica,dc=de]: Required String attribute : unlockAttr value was null. It must have a valid value. sailpoint.tools.GeneralException: Required String attribute : unlockAttr value was null. It must have a valid value.
```

**Resolution** - Add the following entry keys to the source configuration:

```xml
<entry key="lockAttr" value="nameofAttribute"/>
<entry key="lockVal" value="TRUE"/>
<entry key="unlockAttr" value="nameofAttribute"/>
<entry key="unlockVal" value="TRUE"/>
<entry key="unlockAction" value="replace"/>
```

## Create Account Operation Fails While Using Recommended Mappings in the Account Policy

The create account operation fails even though the recommended attribute mappings are used in the Account Policy.

**Resolution** - Ensure that the managed system is enabled to set the account attributes used by the Account Policy, then try the Create account operation again.

## Group Membership Filtering Fails If the LDAP Schema Entitlement Attribute Name Matches the Target System's Attribute Name

During account aggregation, group membership filters fail if the account attribute name in the LDAP source schema matches the attribute name on the target system exactly (when marked as an entitlement). For example, if `sudoRoleMemberOf` is used in the schema and marked as an entitlement, the filter will not be applied.

**Resolution** - To ensure the group membership filter works correctly, define the attribute in the LDAP source schema with a unique name. For example, use `sudoRoleMemberOfGroup` while keeping it marked as an entitlement. This allows the filter to process the attribute during account aggregation.

## Entitlements Are Not Getting Aggregated from Multi-Group Schema Configuration

In a multi-group schema configuration, entitlements are only aggregating from a single location, or you are unable to define specific search DNs for different object types (such as `group` and `nrfRole`).

**Resolution** - To aggregate objects from different DNs, you must manually define the `searchDNs` for each specific object type using the SailPoint API.

> [!NOTE]
>
> For more information, refer to the [SailPoint API specifications](<https://developer.sailpoint.com/docs/api/v3>).

1. Identify the Source ID for your LDAP source.
2. Perform a PATCH request to the following endpoint:

   `PATCH /v3/sources/:id`
3. Use the following request body to replace the `searchDNs` for each object type (for example, `group.searchDNs` and `nrfRole.searchDNs`):

   > **Note**
   >
   > Ensure the `objectType` value in the JSON matches the schema type you are targeting to ensure the connector correctly identifies the objects during aggregation.

   ```json
   [
     {
       "op": "replace",
       "path": "/connectorAttributes/group.searchDNs",
       "value": [
         {
           "searchDN": "ou=OP1,dc=maxcrc,dc=com",
           "searchScope": "SUBTREE",
           "iterateSearchFilter": null,
           "objectType": "group"
         }
       ]
     }
   ]
   ```

   ```json
   [
     {
       "op": "replace",
       "path": "/connectorAttributes/nrfRole.searchDNs",
       "value": [
         {
           "searchDN": "ou=OP2,dc=maxcrc,dc=com",
           "searchScope": "SUBTREE",
           "iterateSearchFilter": null,
           "objectType": "group"
         }
       ]
     }
   ]
   ```

# Timeout Errors and Settings

Timeout errors might occur when SailPoint is waiting for a response from the Virtual Appliance (VA). These errors are applicable to all connectors and tend to occur during the setup of sources or when sources are down.

This document is designed to give specific information that can be used to resolve these errors.

Each timeout attribute has a default time value that is listed in seconds or minutes. Increasing the time value may resolve the error as it will allow for longer communication time between the two systems, thus avoiding the timeout error.

> [!IMPORTANT]
>
> Add the necessary attributes or values before performing the "replace" operation, as missing attributes will cause the operation to fail.

To increase the communication time, increase the value of the appropriate timeout attribute. Then submit the change to the VA using the SailPoint 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.

### aggregateTimeout

**Description:** This parameter is set for the aggregation timeout, measured in seconds.

**Resolution:** Increase the `aggregateTimeout` value gradually to optimize aggregation. Start with 180, then increase to 600, 900, and finally 1800. The maximum value is 3600 seconds.

For example:

If your current time value is 180 seconds, update the `aggregateTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/aggregateTimeout",
        "value": 600
    }
]
```

### healthCheckTimeout

**Description:** This parameter is set for the test connection and health check timeout.

**Resolution:** The default value is 30 seconds. If the timeout error continues, increase the value in 15 second increments and try again.

For example:

If your current time value is 30 seconds, update the `healthCheckTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/healthCheckTimeout",
        "value": 45
    }
]
```

### provisioningTimeout

**Description:** This parameter is set for provisioning timeout.

**Resolution:** Increase the `provisioningTimeout` value gradually to optimize provisioning. Start with 180, then increase to 360, and finally 600. The maximum value is 600 seconds.

For example:

If your current time value is 180 seconds, update the `provisioningTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/provisioningTimeout",
        "value": 360
    }
]
```

### timeout

**Description:** This parameter is set for pass-through authentication timeout.

**Resolution:** The default value is 15 seconds. If the timeout error continues, increase this value in 15 second increments and try again.

For example:

If your current time value is 15 seconds, update the `timeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/timeout",
        "value": 30
    }
]
```

### apiTimeout

**Description:** This parameter is set for API time tracking; customers can check it using an external tool.

**Resolution:** The default value is 60 seconds. If the error continues, increase the value by 15 second increments and try again.

For example:

If your current time value is 60 seconds, update the `apiTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/apiTimeout",
        "value": "75"
    }
]
```

### timeoutInSeconds

**Description:** This parameter helps prevent the VA from waiting indefinitely for an API response, ensuring efficient handling of API requests.

For example:

If your current time value is 30 seconds, update the `timeoutInSeconds` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/timeoutInSeconds",
        "value": "15"
    }
]
```