# SailPoint OpenLDAP Connector Documentation > OpenLDAP Connector Documentation # Documentation # Account Move/Rename Operation To enable account move/rename operations, you must provide the uniqueAccountAttribute for the configured LDAP server. For OpenLDAP, the default value for this Unique Account Attribute (UUID) is `entryUUID`. If your connector uses a custom UUID attribute, specify that attribute instead. You need to configure the attribute using the following API PATCH request: ```json [ { "op": "add", "path": "/connectorAttributes/uniqueAccountAttribute", "value": "entryUUID" } ] ``` ### 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 | # Adding nisnetgroups or posixgroups Attributes To load NIS Netgroups or POSIX Groups from OpenLDAP, add the required attributes to the related schema. For general instructions, refer to [Editing an Account Schema](). The nisnetgroups and posixgroups specifically require following settings: 1. Set **Type** to String. 2. Select the **Entitlement** checkbox. 3. Select **Multi-Valued** checkbox. # Connecting SailPoint and OpenLDAP To connect SailPoint with OpenLDAP, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Configure**. 5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 6. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 7. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 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](). - **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]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 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](). 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](). 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](). 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](). 7. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 8. Select **Save**. ## Connection Settings This section contains the information that the source uses to authenticate with the OpenLDAP managed system. 1. Select an option from the **Authorization Types** dropdown list: - **Simple**: To use a clear-text password for the Service Account. - **SASL EXTERNAL (Certificates)**: To use certificate-based secured authorization. - **None**: If you do not want to use authorization when connecting to the server. 2. Enter the **Hostname or IP Address** for the LDAP server. 3. Enter the **Port** number that the server communicates through (the default is 389). Ensure to enter correct port number for certificate-based authorization. 4. Depending on your selection in Step 1, complete the following fields: - If you select **Simple** or **None**: > **Screenshot** > > [![Simple or None authentication fields]()]() 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]()]() > **Important** > > You must provide an Encrypted Private Key for certificate-based secured authorization. 1. Enter the content of the client-certificate file in **Certificate**. 2. Enter the client's encrypted private-key contents in **Private Key**. 3. Enter the passphrase password in **Private Key Password** to parse and decrypt the private key. 4. (Required) Select **Enable Transport Layer Security (TLS)** to connect securely to the server. 5. Select **Save**. > [!NOTE] > > For existing sources, it is mandatory to add the `encrypted` attribute through a PATCH API as an additional configuration setting to support certificate-based authorization. > > Endpoint: `PATCH /v3/sources/{sourceId}` > > Request Body: > > ```json > [ > { > "op": "add", > "path": "/connectorAttributes/encrypted", > "value": "clientCertificate,privateKeyPassword,private_key" > } > ] > ``` ## Account and Group Settings Provide the information required to search the accounts and groups managed by your system. ### Account Search Scope > [!NOTE] > > **Screenshot** > > [![Account Search Scope]()]() To configure the account search scope, complete the following: 1. Select one of the following: - **Subtree** - Use to search the specified **Search DN** and all the containers within it. - **Base** - Use to only search the **Search DN**. - **One Level** - Use to search the **Search DN** and the containers one level below it. 2. Enter the **Search DN** (distinguished name) to search for the accounts that you want to load. 3. (Optional) Enter the **LDAP Search Filter** to specify an optional filter that limits the results returned by the **Search DN**. For example, to filter for entries that do not represent a person, enter the following: `(!(objectclass=person))` 4. (Optional) Enter the **Group Member Search DN** to specify the group memberships of the users that you are loading. 5. (Optional) Enter the **Group Membership Attribute** that contains the group membership information on the managed system. 6. (Optional) Enter an **Additional Filter** that SailPoint applies to the results returned by LDAP. Derived attributes can be included in the filter. For example, to remove user from the search results with a condition, enter the following: `deleted=="true"` 7. Select **Save**. ### Group Search Scope > [!NOTE] > > **Screenshot** > > [![Group Search Scope]()]() To configure the group search scope, complete the following: > [!NOTE] > > By default, If the scope is not defined for Groups, the connector users the Account search scope. 1. Select one of the following: - **Subtree** - Use to search the specified **Search DN** and all the containers within it. - **Base** - Use to only search the **Search DN**. - **One Level** - Use to search the **Search DN** and the containers one level below it. 2. (Optional) Enter the **Search DN** (distinguished name) to search for the accounts that you want to load. 3. (Optional) Enter the **LDAP Search Filter** to specify an optional filter that limits the results returned by the **Search DN**. For example, to filter for entries that do not represent a person, enter the following: `(!(objectclass=person))` 4. (Optional) Enter an **Additional Filter** that SailPoint applies to the results returned by LDAP. Derived attributes can be included in the filter. For example, to remove user from the search results with a condition, enter the following: `deleted=="true"` 5. Select **Save**. ## Additional Configuration This section contains the information related to NIS Netgroups, POSIX Groups, and Provisioning Settings for accounts. > [!NOTE] > > The NIS Netgroups and POSIX Groups Settings options are applicable only if the `nisnetgroups` or `posixgroups` attribute is added to the account schema with entitlement and multivalued options as true. For more information on adding the attribute to account schema, refer to [Adding nisnetgroups or posixgroups Attributes](). > [!NOTE] > > The OpenLDAP connector does not log the `ObjectNotFoundException` as an error in pass-through authentication. ### NIS Netgroups Settings > [!NOTE] > > **Screenshot** > > [![NIS Netgroups Settings]()]() 1. To retrieve NIS Netgroups memberships for the Accounts, enable the **Enable NIS Netgroups** option. 2. In the **Membership Attribute** field, enter the membership attribute retrieved from NIS Netgroups. Currently, **uid** and **cn** are the only options. 3. In the **NIS Netgroup Triple Brace Override** field, enter the type of braces used to provide a value to NIS Netgroup for nisNetGroupTriple. Default: Rounded braces. **(**. ### POSIX Groups Settings > [!NOTE] > > **Screenshot** > > [![POSIX Groups Settings]()]() 1. To retrieve POSIX group memberships for the Accounts, enable the **Enable POSIX Groups** option. 2. In the **Membership Attribute** field, enter the membership attribute retrieved from POSIX. Currently, `uid` and `cn` are the only options. ### Provisioning Settings > [!NOTE] > > **Screenshot** > > [![Provisioning Settings]()]() 1. In the **Unique Search DN**, define the search scope of aggregation for mentioned unique objectType. 2. Select **Save**. ### Additional Configuration Attributes #### Hostname Verification To disable hostname verification during LDAP Communication over TLS for the OpenLDAP source, add the `disableLDAPHostnameVerification` attribute using the REST API. > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. `POST /api/source/update/` - `` is the URL for your SailPoint instance. - `` is the Source ID (number) obtained through the UI. In the body of the POST, use form-data as follows: - **Key**: `connector_disableLDAPHostnameVerification` - **Value**: `true` #### JNDI Environment Properties You can set up the following environment properties using the REST API: `POST /api/source/update/` - `` is the URL for your SailPoint instance. - `` is the Source ID (number) obtained through the UI. In the body of the POST, use form-data as follows: - **Key**: `connector_com.sun.jndi.ldap.connect.pool` with the value **true** - **Key**: `connector_com.sun.jndi.ldap.read.timeout` with the value **120000** > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Integrating SailPoint with OpenLDAP Connecting SailPoint to your OpenLDAP allows you to create a direct connect source for OpenLDAP and load that data into your system. To manage that data, either create an identity profile 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]() page. ## Supported Features > [!NOTE] > > Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. OpenLDAP source supports the following features: - Load OpenLDAP Accounts - \*Provision OpenLDAP Accounts - \*Access Certifications (certification of entitlements connected to accounts) - Authentication - \*Password management - Delete Accounts - Account Move and Rename For more information on features, refer to [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](). ## Supported Managed Systems The OpenLDAP source supports the following managed systems: - OpenLDAP 2.6, 2.5, 2.4.39, and 2.4.26 ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). - Create a service account on OpenLDAP with the required permissions. ## Required Permissions - The OpenLDAP source requires that the service account must be the administrator account and that the directory server has the administrator credentials. - The OpenLDAP source must have read and write permissions 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](), you can use the machine account attributes to provision machine accounts in your SailPoint tenant. Refer to [Machine Identity Security Overview]() 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. | # Provisioning The OpenLDAP connector supports provisioning, allowing you to create and manage accounts and entitlements in OpenLDAP 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 | Create Unique Account ID | 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 | Create Password | This generator creates an initial password for the new account that matches the password policy assigned with the associated OpenLDAP source. | | CN | Display Name | Full name of the user to be created. For example, Martin K Smith. | | givenName | First Name | First name of the user to be created. | | SN | Last Name | Last name of the user to be created. | | mail | Create Unique LDAP Attribute | The email ID of the user to be created. | | uid | Create Unique LDAP Attribute | The unique ID of the user to be created. | > [!NOTE] > > - You can edit some aspects of this page from the user interface. For more information, refer to [Updating the Account Creation Configuration](). You can also [schedule]() regular aggregations for this source. > - The OpenLDAP connector will provision the accounts with parentheses in the Common Name (CN) within a Distinguished Name (DN). # 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]() and [REST API - Update Source (Partial)]() 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": [ "", "" ] } ] ``` > [!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]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The OpenLDAP 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]() 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 | | dn | nisNetgroup | | dn | posixgroup | ### Default Account Attributes The OpenLDAP 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 | Behicle 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. | | employeeType | Type of employment for a person. | | facsimileTelephoneNumber | Facsimile (Fax) Telephone Number. | | givenName | First name(s) for which the entity is known by. | | groups | List of groups a user is a member of. | | 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. | | mail | RFC822 Mailbox. | | manager | DN 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. | | pwdReset | Specifies whether the password has been reset by admin. | | registeredAddress | Registered postal address. | | roomNumber | Room number. | | secretary | DN of secretary. | | seeAlso | DN of related object. | | sn | Last (family) name(s) 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. | ## 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]() 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 OpenLDAP connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. > [!NOTE] > > To aggregate a different group objectType, modify the group schema and its attributes according to the managed system group object type. | 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 Communication If you want a secured TLS connection for LDAP, TLS communication must be enabled between the OpenLDAP connector and the LDAP server. For a Java client to connect using TLS and self-signed certificates, you have to install the certificate into the JVM key-store. > [!NOTE] > > SailPoint now supports and recommends secured certificate-based authentication using TLS for the OpenLDAP connector. Ensure the connection to the LDAP server uses TLS with a self-signed or CA-signed certificate. # 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]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## nisNetgroup is not displayed during account aggregation For OpenLDAP Server version 2.4.26 on windows, it may be an issue to perform an equality search on the **nisNetgroupTriple** attribute of **nisNetgroup** objectclass. As a result, the nisNetgroup membership is not displayed during account aggregation. **Resolution**: Open the **nis.schema** file of the OpenLDAP server installation and verify if the nisNetgroupTriple schema attribute definition is same as the following attribute type: ```text (1.3.6.1.1.1.1.14 NAME 'nisNetgroupTriple' DESC 'Netgroup triple' EQUALITY caseExactIA5Match SUBSTR caseExactIA5SubstringsMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.26) ``` If the attribute type is not same as the above, then take a back up of the existing **nis.schema** file and replace the existing **nisNetgroupTriple** definition with the above. Save the file and restart the OpenLDAP server. After performing aggregation, nisNetgroup membership must get fetched. # 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]() and [REST API - Update Source (Partial)]() 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" } ] ```