# SailPoint Microsoft Lightweight Directory Services Connector Documentation

> Microsoft Lightweight Directory Services Connector Documentation

# Documentation

# Additional Configuration

This page describes additional connector settings that you configure with the SailPoint REST API.

## Setting Environment Properties for the JNDI

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

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

## Configuring the Account Move/Rename Operation

To enable the account move/rename operation, you must provide the `uniqueAccountAttribute` for the configured LDAP server.

For ADAM (AD LDS), the default UUID attribute is `objectGUID`. If you use a custom UUID attribute, specify that instead. You need to configure this attribute using the following API PATCH request:

```json
[
  {
    "op": "add",
    "path": "/connectorAttributes/uniqueAccountAttribute",
    "value": "objectGUID"
  }
]
```

### Handling Binary Attribute for AD LDS

> [!NOTE]
>
> While `attributesInBinaryFormat` attribute is optional, for AD LDS, the UUID attribute (objectGUID) is a binary attribute. Therefore, you must configure the UUID attribute in both `attributesInBinaryFormat` and `uniqueAccountAttribute`.

#### attributesInBinaryFormat

To handle binary attributes for the AD LDS server, use the `attributesInBinaryFormat` multi-valued configuration attribute. This attribute specifies which LDAP attributes to fetch in binary format.

```json
[
  {
    "op": "add",
    "path": "/connectorAttributes/attributesInBinaryFormat",
    "value": ["objectGUID", "<binary attribute 2>"]
  }
]
```

#### uuidInLittleEndianFormat

Binary attributes can be converted to a string format for processing and storage in two ways: little-endian (such as Microsoft AD, ADAM) and big-endian (such as Novell eDirectory).

To ensure binary attributes are processed and saved in the correct format, the `uuidInLittleEndianFormat` boolean attribute is required. For ADAM, set the value to true.

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

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

# Connecting SailPoint and Microsoft Lightweight Directory Services

To connect SailPoint with Microsoft Lightweight Directory Services, 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

Provide the information required for SailPoint to connect and interact with the source.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/lds_conn.png>)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/lds_conn.png>)

1. Provide the **Service Account** for the instance.
2. Enter the **Password** to use when connecting to the server.
3. Enter the **Hostname or IP Address** of the host machine where the LDS server is running.
4. Enter the **Port** number the server is listening to.
5. Select the **Authorization Type** to use when connecting.

   - **Simple** - Allows you to use a clear text password for the Service Account in the Connection Credentials panel.
   - **None** - No authorization required.
6. If the connection is over TLS, click **Use TLS** to turn it on.

   For more information, refer to [TLS Configuration on Virtual Appliances](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/tls/tls_configuration_on_virtual_appliances.html>).
7. Select **Save**.

## Account and Group Settings

This section contains the information related to the [Accounts](<#account-settings>) and [Groups](<#group-settings>) scope that need to be managed by the configured source.

> [!NOTE]
>
> - The LDAP source does not record the clear text password in diagnostic logs when provisioning to a simple AD. For example, the LDS source will not log a clear text password while provisioning to the AWS AD platform.
> - The schema attributes that are not present in the out-of-the-box schema must be defined as string if not specified otherwise.
> - After Microsoft advisory ADV190023 (LDAP channel Binding and LDAP Signing) configurations are enabled, the LDS features work correctly over the TLS layer. It is mandatory that all source operations are performed over TLS/SASL.

### Account Settings

On the Account and Group Settings page, specify the search scope that will be managed by the configured source.

> [!NOTE]
>
> **Screenshot**
>
> [![Account Settings](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/lds_ag1.png>)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/lds_ag1.png>)

1. Configure the **Search Scope** within the LDAP directory as follows:

   - **Subtree**: to search the specified Search DN and all containers within it.
   - **Base**: to search only the Search DN.
   - **One Level**: to search the Search DN and the containers one level below it.
2. In the **Search DN** field, enter the distinguished name of the container. For example:

   `ou=people,dc=example,dc=com`
3. The **Group Member Search DN** field represents a multivalued attribute to define the scope for group memberships.
4. The **LDAP Search Filter** is an optional filter in LDAP that limits the results returned by the Search DN.

   For example, the following filter returns all entries that do not represent a person:

   `(! (objectclass=person))`
5. The **Additional Filter** field is an optional filter applied to the results returned by the source. Derived attributes can be included in the filter.

   For example, the following filter string removes users if there is an attribute named deleted and the value is true:

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

### Group Settings

On the Account and Group Settings page, specify the search scope that will be managed by the configured source.

> [!NOTE]
>
> **Screenshot**
>
> [![Group Settings](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/lds_ag2.png>)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/lds_ag2.png>)

1. Configure the scope of the search (**Search Scope**) within the directory as follows:

   - **Subtree**: to search the specified Search DN and all containers within it.
   - **Base**: to search only the Search DN.
   - **One Level**: to search the Search DN and the containers one level below it.
2. In the **Search DN** field, enter the distinguished name of the container. For example:

   `ou=people,dc=example,dc=com`
3. The **LDAP Search Filter**, is an optional filter that limits the results returned by the Search DN. For example, the following filter returns all entries that do not represent a person:

   `(! (objectclass=person))`
4. The **Additional Filter** field is an optional filter applied to the results returned by the source. Derived attributes can be included in the filter.

   For example, the following filter string removes users if there is an attribute named deleted and the value is true:

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

## Additional Configuration

In this section, you can enable/disable Delta Aggregation and configure the scope for deleted objects.

> [!NOTE]
>
> **Screenshot**
>
> [![Additional Configuration](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/lds_add.png>)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/lds_add.png>)

### Deleted Object Container

Specify a value in the Deleted Object Container field to grant permission to the specified object as follows:

`CN=Deleted Objects, DOMAIN`

Where DOMAIN is a place holder for the naming context where the account objects reside. Replace DOMAIN with the corresponding naming context. For example:

`CN=Deleted Objects,dc=sailpoint,dc=com`

## 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 Microsoft Lightweight Directory Services

*(formerly ADAM)*

This guide is designed to give specific information about the requirements and field definitions needed to get a working instance of a Microsoft Lightweight Directory Services (LDS) source in SailPoint.

If you have user accounts in LDS that you want to load into SailPoint, you can create a direct connect source for LDS and load that data into your system. To manage that data, either [create an identity profile](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>) based on the source or verify that the accounts you load are correlated to an existing identity.

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

The Microsoft Lightweight Directory connector supports the following features:

- Manage ( Aggregate and Provision ) `userProxyFull` type of users in AD LDS (ADAM)
- Load Active Lightweight Directory Services Accounts
- \*Provision Active Lightweight Directory Services Accounts
- \*Access Certifications (certification of entitlements connected to accounts)
- Delete Accounts
- Account Move and Rename
- \*Password Management
- Unlock Account: Add the `UNLOCK` attribute to the source XML file. Add the appropriate values for the lock/unlock attributes:

  ```text
  <entry key="lockAttr" value="Depend on LDAP type OR any custom attributes set in customer env for lock"/>
  <entry key="unlockAttr" value="Depend on LDAP type OR any custom attributes set in customer env for unlock">
  ```

Provisioning of account with objectClass `userProxyFull` requires updates of the account schema and the provisioning policies.

Following are the links to the pages that provide the details which should be added:

- [Profile Page](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/provisioning.html#profile-page>)
- [Account Attribute (Object Type - `userProxyFull`)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/schema.html#account-attributes-object-type-userproxyfull>)

For more information on features, refer to [Source Features](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-Source-Features>).

### Password Management

If Password Management is enabled for your organization, you can change the password for a user of the source. After enabling password management on the source, be aware of the following:

- The password policy defined in SailPoint applies to accounts on this source.
- If you change the password for an application connected to this source, the change will automatically be made to the source itself.

For more information on configuring password management, refer to [Password Management Overview](<https://documentation.sailpoint.com/saas/help/pwd/index.html>).

## 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>).
- The administrator account acting as the service account for the Active Lightweight Directory source must have the read /write privileges over the directory information tree in order to manage the LDAP data.

## Required Permissions

- The Active Lightweight Directory Services administrator account acting as the service account must have read /write privileges over the directory information tree in order to manage the 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. |
| 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. |

# Provisioning

The Microsoft Lightweight Directory Services connector supports provisioning, allowing you to create and manage accounts and entitlements in Microsoft Lightweight Directory Services directly from SailPoint.

**Prerequisite:** Your system is configured for provisioning.

When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*.

When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment.

For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account.

> [!IMPORTANT]
>
> This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail.

## Default Create Account Attributes

| Account Attribute | Generator | Description |
| --- | --- | --- |
| dn | Generator | This generator uses the value in the **Pattern Used** field to generate a unique DN for the new account. **Caution:** You must change the OU in the **Pattern Used** field in the `distinguishedName` attribute. |
| password | Generator | The password of the created user. |
| givenName | Identity Attribute | The first name of the user. |
| SN | Identity Attribute | The last name of the user. |

## Profile Page

The objectClass must be set to `userProxyFull` and the `objectSid` must be provided. The rest of the sample is optional.

Add below sample policy to create `userProxyFull` type of account:

```json
{
    "name": "Account",
    "description": null,
    "usageType": "CREATE",
    "fields": [
        {
            "name": "objectClass",
            "transform": {
                "type": "static",
                "attributes": {
                    "value": "userProxyFull"
                }
            },
            "attributes": {},
            "isRequired": false,
            "type": "string",
            "isMultiValued": false
        },
        {
            "name": "givenName",
            "transform": {
                "type": "identityAttribute",
                "attributes": {
                    "name": "firstname"
                }
            },
            "attributes": {},
            "isRequired": false,
            "type": "string",
            "isMultiValued": false
        },
        {
            "name": "mail",
            "transform": {
                "type": "identityAttribute",
                "attributes": {
                    "name": "email"
                }
            },
            "attributes": {
                "cloudRequired": "true"
            },
            "isRequired": false,
            "type": "string",
            "isMultiValued": false
        },
        {
            "name": "sn",
            "transform": {
                "type": "identityAttribute",
                "attributes": {
                    "name": "lastname"
                }
            },
            "attributes": {
                "cloudRequired": "true"
            },
            "isRequired": false,
            "type": "string",
            "isMultiValued": false
        },
        {
            "name": "displayName",
            "transform": {
                "type": "identityAttribute",
                "attributes": {
                    "name": "displayName"
                }
            },
            "attributes": {
                "cloudRequired": "true"
            },
            "isRequired": false,
            "type": "string",
            "isMultiValued": false
        },
        {
            "name": "dn",
            "transform": {
                "type": "rule",
                "attributes": {
                    "name": "Create Unique Account ID"
                }
            },
            "attributes": {
                "template": "CN=$(firstname).$(lastname)$(uniqueCounter),CN=upfusers,CN=upf,DC=sailpointdemo,DC=com",
                "cloudMaxUniqueChecks": "50",
                "cloudRequired": "true"
            },
            "isRequired": false,
            "type": "string",
            "isMultiValued": false
        },
        {
            "name": "objectSid",
            "transform": {
                "attributes": {
                    "attributeName": "objectSid",
                    "sourceName": "Active Directory"
                },
                "type": "accountAttribute"
            },
            "attributes": {},
            "isRequired": false,
            "type": "string",
            "isMultiValued": false
        }
    ]
}
```

# 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 Microsoft Lightweight Directory Services 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 |
| --- | --- |
| dn | Account |
| dn | Group |

### Default Account Attributes

The Microsoft Lightweight Directory Services 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 |
| --- | --- |
| businessCategory | Business category. |
| carLicense | Vehicle license or registration plate. |
| cn | Common name(s) for which the entity is known by. |
| dn | Distinguished name for which the entity is known by. |
| departmentNumber | Identifies a department within an organization. |
| description | Descriptive information. |
| destinationIndicator | Destination indicator. |
| displayName | Preferred name to be used when displaying entries. |
| employeeNumber | Numerically identifies an employee within an organization. |
| employeeID | Numerically identifies an employee within an organization. |
| employeeType | Type of employment for a person. |
| facsimileTelephoneNumber | Facsimile (Fax) Telephone Number. |
| givenName | First name(s) for which the entity is known by. |
| memberOf | List of groups a user is a member |
| homePhone | Home telephone number. |
| homePostalAddress | Home postal address. |
| initials | Initials of some or all of names, but not the surname(s). |
| internationaliSDNNumber | International ISDN number. |
| l | City. |
| mail | RFC822 Mailbox. |
| manager | Distinguished name of manager. |
| mobile | Mobile telephone number. |
| o | Organization this object belongs to. |
| ou | Organizational unit this object belongs to. |
| pager | Pager telephone number. |
| physicalDeliveryOfficeName | Physical Delivery Office Name. |
| postOfficeBox | Post Office Box. |
| postalAddress | Postal address. |
| postalCode | Postal code. |
| preferredDeliveryMethod | Preferred delivery method. |
| preferredLanguage | Preferred written or spoken language for a person. |
| registeredAddress | Registered postal address. |
| roomNumber | Room number. |
| secretary | Distinguished name of secretary. |
| seeAlso | Distinguished name of related object. |
| sn | The last (family) name for which the entity is known by. |
| st | State or province which this object resides in. |
| street | Street address of this object. |
| telephoneNumber | Telephone Number. |
| teletexTerminalIdentifier | Teletex Terminal Identifier. |
| telexNumber | Telex Number. |
| title | Title associated with the entity. |
| uid | User identifier. |
| objectClass | Object classes of the entity. |

### Account Attributes (Object Type - `userProxyFull`)

| Attribute Name | Description |
| --- | --- |
| dn | Distinguished name for which the entity is known by (`identityAttribute`) |
| sAMAccountName | Common name(s) for which the entity is known by (`displayAttribute`) |
| displayName | Preferred name to be used when displaying entries |
| givenName | First name(s) for which the entity is known by |
| sn | Last (family) name(s) for which the entity is known by |
| memberOf | List of groups a user is a member (Entitlement Attribute, Multivalued, Managed) |
| mail | RFC822 Mailbox |
| objectSid | user identifier |

#### ObjectClass

| Attribute Name | Description |
| --- | --- |
| objectClass | Object classes of the entity (Multivalued attribute) |

> [!NOTE]
>
> The objectClass must be set to `userProxyFull` as `nativeObjectType`. You can add a complete new schema for `userProxyFull` or modify the existing schema with required attributes.

To change the `nativeObjectType` in the schema for the account, use the following schema update API call.

`PATCH https://sailpoint.api.identitynow.com/beta/sources/:sourceId/schemas/:schemaId`

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

```json
[
  {
    "op": "replace",
    "path": "/nativeObjectType",
    "value": "userProxyFull"
  }
]
```

> [!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 Schema (Partial)](<https://developer.sailpoint.com/docs/api/v3/update-source-schema/>) in the SailPoint Developer Community.

Here's an example of the `userProxyFull` schema in SailPoint:

```json
{
  "nativeObjectType": "userProxyFull",
  "identityAttribute": "dn",
  "displayAttribute": "cn",
  "hierarchyAttribute": null,
  "includePermissions": false,
  "features": [],
  "configuration": {},
  "attributes": [
    {
      "name": "businessCategory",
      "type": "STRING",
      "schema": null,
      "description": "business category",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "carLicense",
      "type": "STRING",
      "schema": null,
      "description": "vehicle license or registration plate",
      "isMulti": true,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "cn",
      "type": "STRING",
      "schema": null,
      "description": "common name(s) for which the entity is known by",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "dn",
      "type": "STRING",
      "schema": null,
      "description": "distinguished name for which the entity is known by",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "departmentNumber",
      "type": "STRING",
      "schema": null,
      "description": "identifies a department within an organization",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "description",
      "type": "STRING",
      "schema": null,
      "description": "descriptive information",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "destinationIndicator",
      "type": "STRING",
      "schema": null,
      "description": "destination indicator",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "displayName",
      "type": "STRING",
      "schema": null,
      "description": "preferred name to be used when displaying entries",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "employeeNumber",
      "type": "STRING",
      "schema": null,
      "description": "numerically identifies an employee within an\torganization",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "employeeType",
      "type": "STRING",
      "schema": null,
      "description": "type\tof employment for a person",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "facsimileTelephoneNumber",
      "type": "STRING",
      "schema": null,
      "description": "Facsimile (Fax) Telephone Number",
      "isMulti": true,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "givenName",
      "type": "STRING",
      "schema": null,
      "description": "first name(s) for which the entity is known by",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "memberOf",
      "type": "STRING",
      "schema": {
        "type": "CONNECTOR_SCHEMA",
        "id": "d7364aetf456dsggyhj72e83",
        "name": "group"
      },
      "description": "List of groups a user is a member",
      "isMulti": true,
      "isEntitlement": true,
      "isGroup": true
    },
    {
      "name": "homePhone",
      "type": "STRING",
      "schema": null,
      "description": "home telephone number",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "homePostalAddress",
      "type": "STRING",
      "schema": null,
      "description": "home postal address",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "initials",
      "type": "STRING",
      "schema": null,
      "description": "initials of some or all of names, but not the surname(s).",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "internationaliSDNNumber",
      "type": "STRING",
      "schema": null,
      "description": "international ISDN number",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "l",
      "type": "STRING",
      "schema": null,
      "description": "city",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "mail",
      "type": "STRING",
      "schema": null,
      "description": "RFC822 Mailbox",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "manager",
      "type": "STRING",
      "schema": null,
      "description": "DN of manager",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "mobile",
      "type": "STRING",
      "schema": null,
      "description": "mobile telephone number",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "o",
      "type": "STRING",
      "schema": null,
      "description": "organization this object belongs to",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "ou",
      "type": "STRING",
      "schema": null,
      "description": "organizational unit this object belongs to",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "pager",
      "type": "STRING",
      "schema": null,
      "description": "pager telephone number",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "physicalDeliveryOfficeName",
      "type": "STRING",
      "schema": null,
      "description": "Physical Delivery Office Name",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "postOfficeBox",
      "type": "STRING",
      "schema": null,
      "description": "Post Office Box",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "postalAddress",
      "type": "STRING",
      "schema": null,
      "description": "postal address",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "postalCode",
      "type": "STRING",
      "schema": null,
      "description": "postal code",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "preferredDeliveryMethod",
      "type": "STRING",
      "schema": null,
      "description": "preferred delivery method",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "preferredLanguage",
      "type": "STRING",
      "schema": null,
      "description": "preferred written or spoken language for a person",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "registeredAddress",
      "type": "STRING",
      "schema": null,
      "description": "registered postal address",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "roomNumber",
      "type": "STRING",
      "schema": null,
      "description": "room number",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "secretary",
      "type": "STRING",
      "schema": null,
      "description": "DN of secretary",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "seeAlso",
      "type": "STRING",
      "schema": null,
      "description": "DN of related object",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "sn",
      "type": "STRING",
      "schema": null,
      "description": "last (family) name(s) for which the entity is known by",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "st",
      "type": "STRING",
      "schema": null,
      "description": "state or province which this object resides in",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "street",
      "type": "STRING",
      "schema": null,
      "description": "street address of this object",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "telephoneNumber",
      "type": "STRING",
      "schema": null,
      "description": "Telephone Number",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "teletexTerminalIdentifier",
      "type": "STRING",
      "schema": null,
      "description": "Teletex Terminal Identifier",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "telexNumber",
      "type": "STRING",
      "schema": null,
      "description": "Telex Number",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "title",
      "type": "STRING",
      "schema": null,
      "description": "title associated with the entity",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "uid",
      "type": "STRING",
      "schema": null,
      "description": "user identifier",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "objectClass",
      "type": "STRING",
      "schema": null,
      "description": "object classes of the entity",
      "isMulti": true,
      "isEntitlement": false,
      "isGroup": false
    },
    {
      "name": "employeeID",
      "type": "STRING",
      "schema": null,
      "description": "Numerically identifies an employee within an organization",
      "isMulti": false,
      "isEntitlement": false,
      "isGroup": false
    }
  ],
  "id": "ff6af7ef78ttyhgd345dggfac800a782",
  "name": "account",
  "created": "2021-06-02T20:10:71.087Z",
  "modified": "2021-06-02T19:32:93.812Z"
}
```

## 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 Microsoft Lightweight Directory Services connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

| Attribute Name | Description |
| --- | --- |
| cn | Common name(s) for which the entity is known by. |
| dn | Directory Path. |
| o | Organization this object belongs to. |
| ou | Organizational unit this object belongs to. |
| owner | Owner (of the object). |
| description | Descriptive information. |

# TLS Configuration on Virtual Appliances

Enabling a source to communicate with a virtual appliance using a TLS connection encrypts all data sent between the source and the VA.

## Sources That Support TLS

The following sources can be configured to communicate over a TLS connection:

- [Active Directory](<https://documentation.sailpoint.com/connectors/microsoft/active_directory/va/help/index.html>)
- [ACF2](<https://documentation.sailpoint.com/connectors/mainframe/acf2/va/help/index.html>)
- [Top Secret](<https://documentation.sailpoint.com/connectors/mainframe/top_secret/va/help/index.html>)
- [IBM i](<https://documentation.sailpoint.com/connectors/ibm/i/va/help/index.html>)
- [OpenLDAP](<https://documentation.sailpoint.com/connectors/openldap/va/help/index.html>)
- [Oracle Internet Directory](<https://documentation.sailpoint.com/connectors/oracle/internet_directory/va/help/index.html>)
- [RSA](<https://documentation.sailpoint.com/connectors/rsa_authentication_manager/va/help/index.html>)
- [RACF](<https://documentation.sailpoint.com/connectors/mainframe/racf/va/help/index.html>)

## Manually Uploading a Certificate to a Virtual Appliance

### Import a Certificate and Keychain to the Virtual Appliance

> [!IMPORTANT]
>
> When adding a certificate to the virtual appliance (VA), ensure that the certificate you copy is in Privacy-Enhanced Mail (PEM) format.

- Before manually adding a new certificate for the source to your virtual appliance's truststore, ensure the following:
- The virtual appliance (VA) is not connected to the source.
- Connection testing between the source and VA is suspended.
- Scheduled aggregations are temporarily paused, if necessary.
- The source server has been configured for TLS.
- The `va-config-<va_id>.yaml` file has been configured for your virtual appliance.
- You must complete the following steps for every virtual appliance on the virtual appliance cluster connected to the source:

  1. Copy the PEM-encoded certificates to the `/home/sailpoint/certificates` directory. This directory might not be empty because it's where the VA adds any certificates it gets from the source.
  2. Restart the CCG using the following command:

     `sudo systemctl restart ccg`
  3. Watch the `/home/sailpoint/log/ccg-start.log` file. If successful, the import should log messages from the form:

     ```text
     {"@timestamp":"2017-04-21 06:57:12 +0000","level":"INFO","type":"ccg","message":"Checking CCG Sources certificates"}
     {"@timestamp":"2017-04-21 06:57:12 +0000","level":"INFO","type":"ccg","message":"Cert files found: [\"/home/sailpoint/certificates/411818.pem\"]"}
     06:57:12 +0000","level":"INFO","type":"ccg","message":"Importing cert /home/sailpoint/certificates/411818.pem"}
     ```

     > **Note**
     >
     > If you see an error instead of the log messages above, this is an indication that your certificate is in an invalid format. Verify you're using a PEM format for your certificate and then try again.
- Sometimes the export of a certificate may not work properly with the VA. Using the openSSL command to get the certificate is a good way to get the latest certificate.

  1. Use the openSSL command to get the latest certificate:

     1. Run the following command in openSSL:

        `openssl s_client -connect server.example.com:636 > output < /dev/null`
     2. From the command output file, copy the certificate content between `--BEGIN CERTIFICATE--` and `--END CERTIFICATE--`.
     3. Create a new file called `cert.pem` in the `/home/sailpoint/certificates` folder.
     4. Save the copied certificate contents in the new `cert.pem` file.
  2. Restart the CCG using the following command:

     `sudo systemctl restart ccg`

## Using an External Certificate Authority (CA)

### Add the Certificate to the Virtual Appliance

If you're using an external certificate authority, you only have to connect to the VA from the source to import the certificate.

**Prerequisites:**

- The ability to use TLS 1.0 - 1.2
- You have created at least one virtual appliance cluster
- CA root and intermediate certificates are in the Java CAcerts keystore
- The certificate is on the source

**Complete the following steps:**

1. In the source, ensure that the following are true:

   - The **Hostname** for the source matches the hostname in the virtual appliance's configuration.
   - The source is connected to the virtual appliance you configured to use TLS.

   > **Note**
   >
   > If you are using Active Directory with IQService enabled, the Hostname cannot be an IP Address.
2. Change the **Port** to **636**.

   > **Screenshot**
   >
   > [![Change the port to 636](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/tls1.png>)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/tls1.png>)
3. If available, select the **Advanced Options** checkbox.
4. In the **Use TLS** field, select the **Enable** checkbox.

   > **Screenshot**
   >
   > [![Enable Use TLS](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/tls2.png>)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/tls2.png>)
5. Test the connection.

   > **Note**
   >
   > The source's certificate is auto-imported to the VA.

### Replace an Expired Certificate Issued by an External Certificate Authority

When your certificate has expired, replace it on the source and then reboot your VA.

**Prerequisites**

- Complete the process described in [Add the Certificate to the Virtual Appliance](<#add-the-certificate-to-the-virtual-appliance>).

**Complete the following steps:**

1. Add the new certificate on the source with a new name.
2. Restart the CCG using the following command:

   `sudo systemctl restart ccg`

> [!NOTE]
>
> The source's certificate is auto-imported to the VA.

## Using an Internal Certificate Authority

### Add the Certificate to the Virtual Appliance

If you're using your own certificate authority, you will need to add the root and intermediate certificates to the VA.

> [!NOTE]
>
> This process might also be required if your source is not automatically uploading the certificate from the VA.

**Prerequisites:**

- You have created at least one virtual appliance cluster
- The certificate is on the source

**Complete the following steps:**

1. Import the certificate and the entire key chain (Root and Intermediate Certificates) to the VA as described in [Import a Certificate and Keychain to the Virtual Appliance](<#import-a-certificate-and-keychain-to-the-virtual-appliance>).
2. Restart the CCG using the following command:

   `sudo systemctl restart ccg`
3. In the source, ensure that the following are true:

   - The **Hostname** for the source matches the hostname in the virtual appliance's configuration.
   - The source is connected to the virtual appliance you configured to use TLS.

   > **Note**
   >
   > If you are using Active Directory with IQService enabled, the Hostname cannot be an IP Address.
4. Change the **Port** to **636**.

   > **Screenshot**
   >
   > [![Change the port to 636](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/tls1.png>)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/tls1.png>)
5. If available, select the **Advanced Options** checkbox.
6. In the **Use TLS** field, select the **Enable** checkbox.

   > **Screenshot**
   >
   > [![Enable Use TLS](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/tls2.png>)](<https://documentation.sailpoint.com/connectors/microsoft/lightweight_directory_services/va/help/img/tls2.png>)
7. Test the connection.

> [!NOTE]
>
> The source's certificate is auto-imported to the VA.

### Replace an Expired Certificate Issued by an Internal Certificate Authority

If you're using an internal CA, you need to add the new certificate on both the source and the VA with a new name.

**Prerequisites:**

- Complete the process described in [Add the Certificate to the Virtual Appliance](<#add-the-certificate-to-the-virtual-appliance_1>)

**Complete the following steps:**

1. Add the new certificate on the source with a new name.
2. Import certificate and entire key chain (Root and Intermediate Certificates) to VA as described in [Import a Certificate and Keychain to the Virtual Appliance](<#import-a-certificate-and-keychain-to-the-virtual-appliance>).
3. Restart the CCG using the following command:

   `sudo systemctl restart ccg`
4. Test the connection.

# 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/>)

## Test Connection Error

```text
sailpoint.connector.InvalidConfigurationException: [ InvalidConfigurationException ]
[ Possible suggestions ] a) Provide right credentials. b) Ensure user has the correct format.
[ Error details ] Failed to authenticate. [LDAP: error code 49 - 8009030C: LdapErr: DSID-0C090404, comment: AcceptSecurityContext error, data 52e, v1772]
```

**Resolution**: Enter the correct password for the service account.

## Account Aggregation Error

```text
java.lang.RuntimeException: sailpoint.connector.InvalidConfigurationException:
[ InvalidConfigurationException ] [ Possible suggestions ] Provide valid Search DN. [ Error details ]
Failed to read from: CN=Partition1,DC=VMAD5,DC=LOCAL,CN=IIQ - ldap://172.16.22.6:389
[LDAP: error code 1 - 000020D6: SvcErr: DSID-03100754, problem 5012 (DIR_ERROR), data 0 ]
```

**Resolution**: Ensure that the search DN is mentioned correctly.

# 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"
    }
]
```