# SailPoint Windows Local Connector Documentation > Windows Local Connector Documentation # Documentation # Connecting SailPoint and Windows Local To connect SailPoint with Windows Local, 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 Provide the information required to connect and interact with the source. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() To configure connection settings, complete the following: 1. Enter the username of the **Service Account** with the proper administrator permissions on the managed system using the one of the following formats: `computerName\userName` or `userName` For example, domain users can enter the following: `example.com\JohnSmith` 2. Enter the service account's **Password**. 3. Enter the **Hostname or IP Address** of the managed Windows computer. > **Note** > > Ensure that the IQService host can perform a DNS resolution on the provided IP address. The Windows local connector requires `gethostname` function to resolve the IP address to a hostname or fully qualified domain name (FQDN). > > The connector accepts any valid hostname or FQDN that is associated with the given IP address. 4. Select **Save**. ## IQService Settings IQService, also referred to as the Integration Service, is a native Windows service that enables SailPoint to operate in a Windows environment and access information only available through Windows APIs. For more information, refer to [IQService Settings](). ## Advanced Settings Use the optional advanced settings to configure aggregation results, read non-local group memberships, and adjust page size. > [!NOTE] > > **Screenshot** > > [![Advanced Settings]()]() Configure the following optional settings as needed: - Select the **Disable Qualifying Local Objects** checkbox to not prefix aggregated options with the server name. By default, all aggregated objects are prefixed with the server name. - Deselect the **Disable NonLocal Lookup** checkbox to read non-local objects. - The non-local accounts (i.e. domain accounts) which are members of Windows local groups are aggregated as part of account aggregation into SailPoint by the Windows Local connector. - The non-local groups (i.e. domain groups) are only aggregated as part of entitlement aggregation into SailPoint by the Windows Local connector by virtue of these non-local groups being members of Windows Local groups as an attributes. > **Note** > > - You must deselect **Disable Qualifying Local Objects** and **Disable NonLocal Lookup** before running the account aggregation to provision non-local(domain) users. Deselecting **Disable NonLocal Lookup** allows you to aggregate non-local users as well as Local users. > - The Windows Local connector (via. IQService) can aggregate non-local(domain) or cross-domain objects of the same domain only when IQService resides on the same Windows Local host or is part of the same domain to which Windows Local belongs. - In the **Page Size** field, enter the number of objects to fetch in a single page. The default is 1000. ## 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 Windows Local Use the Windows Local connector to manage Windows Local user accounts. This document is designed to give specific information about the requirements and field definitions needed to get a working instance of a Windows Local connector. After it is successfully configured, your organization can aggregate and provision accounts for Windows Local users. > [!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. The Windows Local connector supports the following features. ### Account Management - Aggregate and refresh Windows Local users as accounts - Add or remove entitlements - Add or remove Windows Local groups to non-local (domain) users. See [Advanced Settings]() for configuration. - \*Password Management - \*Provision Accounts - Create, update, delete - Enable, disable, unlock, and change password ### Entitlement Management - \*Access Certifications (certification of entitlements connected to accounts) ### Permission Management - Execute native before/after scripts for provisioning requests 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 Versions The Windows Local connector supports the following versions of Microsoft Windows. - Microsoft Windows Server 2022 - Microsoft Windows Server 2019 - Microsoft Windows Server 2016 ## Prerequisites - IQService must be installed on the Windows system. Follow the instructions in the [IQService Administrator's Guide]() to install IQService. For more information, refer to [Installing and Configuring IQService](). > **Important** > > IQService installation now enforces TLS configuration by default to improve security and safeguard your environment. To proceed with the installation, ensure you have completed the necessary prerequisites for TLS configuration. For more information, refer to [Configuring TLS and Client Authentication for IQService](). - Start the remote registry service on the managed system. - Allow an exception for **File and Printer Sharing** in the Windows firewall. - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). - Ensure that the account being used to configure the connection has Administrator privileges on the Windows host machine. - Deselect **Disable NonLocal Lookup** and **Disable Qualifying Local Objects** before running the account aggregation to provision the non-local (domain) users. For more information, refer to [Advanced Settings](). > **Note** > > To view non-local (domain) users `userName` in the format of "domainName\\saMAccountName", deselect **Disable Qualifying Local Objects** before running the account aggregation. For example, `domainName\TestUser1`. ## Administrator Permissions The service user account should be a member of the **Administrators** group on the managed Windows host computer. # Before and After Scripts for IQService The IQService supports function customization by allowing integrating Before/After scripts implemented in languages like PowerShell and Batch. Scripts can be used to automate any required actions that cannot be automated using current source functions. Scripts called before processing the request are referred to as Native Before Scripts and scripts called after processing the request are referred to as Native After Scripts. SailPoint provides most of the provisioning functionality for many systems through its connectors. Some systems provide a better integration interface from the Windows platform compared to other platforms. So connectors for these systems require IQService deployed on a Windows system. The IQService implementation performs the provisioning functions (such as Add User, Connect User to a Group) that are supported by the respective managed system. The IQService functions are called by the SailPoint source implementation. In addition to the basic action, some organizations may require supplementary actions performed by each function from the Windows system. The IQService supports customization of the functions by allowing you to integrate Before and After scripts in any language. The following are some features of IQService Before and After scripts: - Centralized configurations (in SailPoint) for setting up Before and After scripts - Supports Object Oriented scripting - Script refers SailPoint library to get the request and result classes - Can be executed with specific context - Script can modify requests and results A script is a group of statements that perform one or more actions and manipulate request and result attributes. Scripts can be used to automate any required actions. The scripts need to be defined in a rule and then configured for a source in SailPoint. Based on the rule type (Before or After), the connector sends the scripts to be executed before or after processing the request to IQService. IQService supports executing Before and After Rules for Create, Modify, and Delete request operations. > [!WARNING] > > To enhance security, it is mandatory to configure the TLS for IQService. If you continue using non-TLS configuration, any before and after script execution will be disabled to safeguard your environment. Remove non-TLS configuration for IQService to execute any rules and scripts. ## Writing a Script IQService divides scripts in the following categories: - Scripts with Object Oriented support - Scripts without Object Oriented support ### Scripts with Object Oriented Support Scripting languages with Object Oriented capabilities (for example, PowerShell) are popular because of their simplistic nature and ease of use. These scripts can form objects of any type by referring to any library or assembly implemented in any language and call its methods. Native scripts implemented in these languages have easier and more powerful access to request and result objects. IQService comes with a class library named `Utils.dll` which bundles all required classes to access the request and result objects. The inputs provided to the script are in the form of process environment variables. The following table describes the environment variables created by IQService: | Name | Type | Before Script | After Script | | --- | --- | --- | --- | | Application | System.Collections.Hashtable | Read Only | Read Only | | Request | SailPoint.Utils.objects.AccountRequest | Read/Write | Read Only | | Result | SailPoint.Utils.objects.ServiceResult | Not Available | Read/Write | The data in the environment variables is in XML. The script creates respective objects using `Utils.dll`. Once the object is modified, the script converts it to XML by calling the **toxml()** method of the object and then writes a file at the path passed as the only argument to the script to the XML. The script returns a non-zero value if an error occurs. It writes the error message in the file at the path passed as the argument to the script. This failure is communicated to SailPoint as part of a result. > [!NOTE] > > **Sample PowerShell Before Script** > > The following is a sample PowerShell Before script which modifies the value of an attribute and adds one new attribute to the request: > > ```text > # Refer to SailPoint class library Requires PowerShell v2 installed on the system. > Add-type -path utils.dll > # Read the environment variables > $sReader = New-Object System.IO.StringReader([System.String]$env:Request); > > # Form the xml reader object > $xmlReader = [System.xml.XmlTextReader]([SailPoint.Utils.xml.XmlUtil]::getReader($sReader)); > > # Create SailPoint Request object > $requestObject = New-Object SailPoint.Utils.objects.AccountRequest($xmlReader); > > # Loop through the attributes from the request for each ($attribute in $requestObject.AttributeRequests){ > if($attribute.Name -eq "description"){ > $attribute.value = "my description"; #change value of the attribute > } > } > > # Add a new attribute to request > $attributeObject = New-Object SailPoint.Utils.objects.AttributeRequest; > $attributeObject.Name = "otherMobile"; > $otherMobileValues = New-Object System.Collections.ArrayList; > $otherMobileValues.Add("222-292-2929"); > $otherMobileValues.Add("333-292-2929"); > $attributeObject.Value= $otherMobileValues; > $attributeObject.Operation = "Set"; > $requestObject.AttributeRequests.Add($attributeObject); > > # Write the request xml to file at the path passed as argument > $requestObject.toxml()|out-file $args[0]; > ``` > [!NOTE] > > **Sample PowerShell After Script** > > - The following is a sample PowerShell After script which ensures that the request was processed successfully and creates a home directory at the path specified in the request: > > ```text > # Refer to SailPoint class library. Requires PowerShell v2 installed on the system. > Add-type -path E:\SVN\trunk\src\WinRPCGateway\IQService\bin\Debug\utils.dll > > # Read the environment variables > $sReader = New-Object System.IO.StringReader([System.String]$env:Request); > $sResult = New-Object System.IO.StringReader([System.String]$env:Result); > > # Form the xml reader objects > $xmlReader = [ System.xml.XmlTextReader]([sailpoint.utils.xml.XmlUtil]::getReader($sReader)); > $xmlReader_Result = [ System.xml.XmlTextReader]([sailpoint.utils.xml.XmlUtil]::getReader($sResult)); > > # Create SailPoint objects > $requestObject = New-Object Sailpoint.Utils.objects.AccountRequest($xmlReader); > $resultObject = New-Object Sailpoint.Utils.objects.ServiceResult($xmlReader_Result); > > #Check if the request was processed successfully > if($resultObject.Errors.count -eq 0){ > > #Get Home directory path > foreach ($attribute in $requestObject.AttributeRequests){ > > #Create Home directory > if($attribute.Name -eq "TS_TerminalServicesHomeDirectory"){ > new-item $attribute.Value -itemtype directory; > } > } > } > ``` > - The following script displays how to access any application configuration attribute in the script. The following example reads application attributes with the name, Office365Username and its associated password. It uses them to connect to Exchange Online and sets Mailbox properties: > > ```text > # Refer to SailPoint class library. > Add-type -path C:\Program files\IQService\bin\Debug\utils.dll > > # Read the environment variables > $sReader = New-Object System.IO.StringReader([System.String]$env:Request); > $sResult = New-Object System.IO.StringReader([System.String]$env:Result); > > # Form the xml reader objects > $xmlReader = [ System.xml.XmlTextReader]([sailpoint.utils.xml.XmlUtil]::getReader($sReader)); > $xmlReader_Result = [ System.xml.XmlTextReader]([sailpoint.utils.xml.XmlUtil]::getReader($sResult)); > > # Create SailPoint objects > $requestObject = New-Object Sailpoint.Utils.objects.AccountRequest($xmlReader); > $resultObject = New-Object Sailpoint.Utils.objects.ServiceResult($xmlReader_Result); > > # Retrieve nativeIdentity from request object > $nativeIdentity = $requestObject.NativeIdentity > > # Get xmlFactory object to retrieve application configuration > $xmlFactory = [sailpoint.Utils.xml.XmlFactory]::Instance; > > # Read the environment variables > $sReader1 = $env:Application > > # Retrieve application configuration object > $appObject = $xmlFactory.parseXml($sReader1) > > #Retrieve application configuration entries named Office365username and password value from AzureAD application config > $office365AdminUsername = $appObject.Office365username > > #Retrieve password attribute value > $o365Password = $appObject.password > > #create Credential object > $secpasswd = ConvertTo-SecureString $o365Password -AsPlainText -Force > $cred = New-Object System.Management.Automation.PSCredential ($office365AdminUsername, $secpasswd) > > #Connect to Office365 > Import-Module msonline > Connect-MsolService -Credential $cred > > #Connect Exchange-Online > $msoExchangeURL = "https://ps.outlook.com/powershell/" > $session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri $msoExchangeURL -Credential $cred -Authentication Basic -AllowRedirection > Import-PSSession $session > > # Set mailbox properties > Set-MailBox -identity $nativeIdentity -UseDatabaseQuotaDefaults $false -IssueWarningQuota "200MB" -ProhibitSendQuota "250MB" -ProhibitSendReceiveQuota "280MB" > ``` ### Scripts Without Object Oriented Support Non-Object Oriented scripts do not refer to the class library or support a way of parsing XML. To have easy access to each attribute along with their operation and values, IQService creates process environment variables for each of the application and request attributes. It formats the names as `SP__` for requests and `SP_APP_` for applications. For native identity, the environment variable is `SP_NativeIdentity`. These types of scripts have limited access to results and get only **SUCCESS** or **FAIL** in the **Result** environment variable. So the After scripts implemented using these scripting languages cannot modify any attribute or result. Before scripts can add, modify, or remove any attribute from the request. The script needs to write the newly added or modified attribute to the file at the path passed as an argument to the script in the form `SP__=`. To remove the attribute from the request, write `/~` to the file. The value for the multivalued attribute is delimited by `/#/`. The following is a sample batch After script which ensures that the request was processed successfully and creates a home directory at the path specified in the request: ```text IF %Result% ==SUCCESS md %SP_Set_TS_TerminalServicesHomeDirectory% ``` ## Creating a Rule To add the script to a rule and use it, you need to create a rule. [Contact SailPoint Services]() for assistance on creating rule as per requirement. ### Configuring the Rules in Source Add the `nativeRules` attribute under the Attributes map with a list of rules that must be configured for a source in SailPoint 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. # Configuring TLS and Client Authentication for IQService IQService, also referred to as the Integration Service, is a Windows service that enables SailPoint to participate in a Windows environment and access information only available through Windows APIs. It is a lightweight service that must be installed on any supported Windows server that has connectivity to the target systems you want to manage in SailPoint. IQService can be installed on any Windows operating system that meets the requirements specified in [Prerequisites]() of IQService. > [!CAUTION] > > If you have IdentityIQ and SailPoint Human Fabric in your environment, install a separate instance of IQService for each system. - **TLS Communication** - TLS Communication between IQService and the VA is supported and must be configured to secure this solution. - **Client Authentication** - IQService can authenticate a client while connecting to it. IQService-based sources support Client Authentication, a feature which authenticates every incoming request from SailPoint before executing them. To ensure the authentication works correctly, IQService expects the client to send the credentials of a registered user with every request. Before processing a request, IQService first confirms that the user is registered with it and then authenticates the credentials with Windows. > [!NOTE] > > Client Authentication is mandatory for operations that use the IQService when the TLS communication is enabled for IQService. > > SailPoint recommends using a privileged access user as the registered user for client authentication. You can also use the IQService Service Log On user for this purpose. ## Prerequisites > [!NOTE] > > **For TLS Communication between the VA and IQService** > > - The IQService host's X.509 certificate with Extended Key Usage (EKU) used as Server Authentication must be available in the Personal Certificate Store of the host. The subject of the certificate should match the FQDN of the IQService host. An example subject is `iqservice.test.com`. > - The matching private key must be present in the host's RSA key directory. > - If the IQService host's X.509 certificate is not available, create a CSR (Certificate Signing Request) from the IQService host. > - Submit the CSR to a trusted (internal or third party) certificate authority (CA) for signing. Ensure that the CA is on trusted root CA in the host. > - The configuration of Client Authentication is *mandatory* when TLS communication is enabled for IQService. > [!NOTE] > > **For Client Authentication** > > - To configure client authentication when the IQService host is added to any domain, you need to have a domain user whose credentials can be used to authenticate a connection between SailPoint and IQService. > - If the IQService host is not added to any domain, the Windows local user from the IQService host can be used authenticate a connection between SailPoint and IQService instead of the domain user. > > > **Note** > > > > No specific additional user permissions are required. > [!IMPORTANT] > > If you are updating your IQService instance to use a TLS port, ensure that you disable the existing non-TLS port. This is crucial to maintain secure communication and prevent potential security vulnerabilities arising from the simultaneous use of both TLS and non-TLS ports. For more information, refer to [Disabling Non-TLS Communication for an Existing IQService Instance](<#disabling-non-tls-communication-for-an-existing-iqservice-instance>). ## TLS Configuration Between VA and IQService 1. Download IQService from SailPoint via a source that requires it. 1. Select **Download IQService**. 2. Unzip the downloaded **IQService.zip** archive into the desired location. For example, `C:\SailPoint\IQService\` 2. Install IQService to communicate with SailPoint on the TLS port only. ```text IQService.exe -i -o ``` This command installs IQService with the name **IQService-Instance1** and the provided TLS port number. 3. On the managed source configuration, in the **Integration Service** panel, enable the **Enable Transport Layer Security (TLS)** checkbox. ## TLS Configuration Check List ### IQService Host - The X.509 certificate is located in the Local Computer's Personal certificate store. - A private key that matches the certificate is present in the Local Computer's store and is correctly associated with the certificate. For example, as displayed in the following screenshot, you can confirm if the certificate has a private key. A certificate with a private key (on the right, highlighted in green) has a different icon than a certificate without one (highlighted in red). [![TLS certificate with and without private key]()]() - The Enhanced Key Usage extension includes the Server Authentication (1.3.6.1.5.5.7.3.1) object identifier. - The IQService host's fully qualified domain name (FQDN) must be in the common name (CN) in the **Subject** field in the X.509 certificate, and it must be a DNS entry in the **Subject Alternative Name** extension in the X.509 certificate. An example of IQService's FQDN is `iqservice.test.com`. Refer to the following examples. > [!NOTE] > > **Common Name (CN) in the Subject field in X.509 certificate** > > [![Common Name in X.509 certificate Subject field]()]() > [!NOTE] > > **DNS entry in the Subject Alternative Name extension in the X.509 certificate** > > [![DNS entry in X.509 certificate Subject Alternative Name extension]()]() - The X.509 certificate must be trusted by the IQService host. Trust is established by configuring the IQService host to trust the root CA to which the issuing CA chains. Refer to the following examples: > [!NOTE] > > **X.509 certificate (Non trusted)** > > [![Non-trusted X.509 certificate]()]() > [!NOTE] > > **X.509 certificate (Trusted)** > > [![Trusted X.509 certificate]()]() ### Virtual Appliance Configuration The virtual appliance (VA) must trust the IQService X.509 certificate. Trust is established by configuring the VA to trust the root CA to which the issuing CA chains. To establish trust between the VA and the root CA: 1. Add the root CA cert in the `/home/sailpoint/certificates` directory of the VA. 2. Restart the CCG service. [![TLS virtual appliance configuration]()]() > [!NOTE] > > Ensure to export the full certificate chain and convert it into a single PEM / Base64 formatted file. > [!NOTE] > > **Steps to Export and Convert the Certificate Chain** > > 1. Using the Microsoft Management Console (MMC), export the certificate chain as a `.p7b` file in DER/Binary format. > 2. Use the following OpenSSL command to convert the `.p7b` file to a `.pem` file: > > ```text > openssl pkcs7 -print_certs -in certchain.p7b -inform DER -out certificate.pem -outform PEM > ``` > 3. Place the output `.pem` file onto the VA. The CCG will then load the certificates from this file. > > ##### Handling Multiple Certificate Chains > > If you have multiple certificate chains (For example, one for VA to IQService communication and another for VA to AD communication), each chain must be placed in a separate PEM file. ## Configuration of IQService Client Authentication 1. On the IQService host, run the following command: ```text IQService.exe -a ``` For example: `IQService.exe -a "Corp\John.Doe"` - The domain user must be in the `msDS-PrincipalName` format: ```text \ ``` - If you are using a local user, it must be in the following format: ```text localuser ``` - You must use the user name as an **IQService User** name in the same format. 2. Configure the **IQService User** and **IQService Password** on the IQService-based source. Ensure that the IQService user value set here is the same that you registered on earlier on IQService. ## Securing Communication Between IQService and AD Domain Controller or Target System > [!NOTE] > > For IQService to connect using TLS and self-signed certificates, you must install the certificate in **Trusted Root Certification Authorities** on the IQService host. The configured IQService User must have all access/permissions to read all the installed Certificates. 1. Export the server certificate and copy the exported .cer file to the IQService host. 2. Double-click the .cer file and select **Install Certificate**. 3. Select **Next**. 4. Choose **Place all certificates in the following store** and select **Browse...** 5. Select **Show physical stores**. 6. Expand **Trusted Root Certification Authorities** and select **Local Computer**. 7. Select **OK**. 8. Select **Next**, then **Finish**. ## Disabling Non-TLS Communication for an Existing IQService Instance If you are enabling TLS communication for an existing IQService instance that previously used non-TLS communication, you must ensure that non-TLS communication is disabled for that same instance. You can achieve this using one of the following methods: **Method 1** 1. Set the existing non-TLS port to zero (0) or any negative number (such as -1, -2, -3 ) using the command line: ```text IQService.exe -p ``` For example, ```text IQService.exe -p 0 ``` ```text IQService.exe -p -1 ``` > **Note** > > Ensure to disable the non-TLS port for both the primary service and the secondary service (if configured). 2. After setting the port, restart the IQService. **Method 2** Optionally, you can delete the non-TLS port entry from the IQService instance registry configuration. > [!WARNING] > > Directly editing the registry can cause serious, potentially unrecoverable errors if done incorrectly. Only modify fields that are specifically intended for modification. Following are the steps to delete non-TLS port entry from IQService instance: 1. Locate the registry configuration for your IQService instance. You can find the registry path for the primary service at: ```text HKEY_LOCAL_MACHINE\SOFTWARE\SailPoint\IQService Instances\ ``` You can find the registry path for the secondary service at: ```text HKEY_LOCAL_MACHINE\SOFTWARE\SailPoint\IQService Instances\\Secondary ``` Replace `` with the name of your IQService instance. 2. Look for the port attribute. 3. Delete the port attribute entry. After completing one of these methods, the IQService will only communicate using TLS, ensuring secure communication between the IQService and other components. To verify that the non-TLS port has been successfully disabled for your IQService instance, run the following command: ```text IQService.exe -v ``` After running this command, the output should display only the Configured TLS Port information along with the corresponding TLS port number, such as `Configured TLS Port : ` ## Troubleshooting ### TLS Communication > [!NOTE] > > **Failed to connect to IQService. Please check TLS configuration for IQService.** > > **Resolution**: > > - Ensure that the certificate is placed at correct path in VA: `/home/sailpoint/certificates` > - This error message might come if IQService is an older version or a non-TLS port is provided. Ensure your IQService is upgraded to latest IQService and TLS port is provided. > [!NOTE] > > **java.security.cert.CertificateException: No subject alternative names present** > > **Resolution**: > > - Ensure that the certificate is properly placed in VA: `/home/sailpoint/certificates`. > - Check communication between IQService host and VA. > - Ensure that the DNS settings are correct. Alternatively add the appropriate mapping entry for IQService host in `hosts.yaml` file in the `/home/sailpoint` directory. > > > **Note** > > > > For information on creating a hosts.yaml file, refer to [Configuring a Hosts.yaml File](). > [!NOTE] > > **Connection Reset** > > **Resolution**: Verify the following: > > - This could be because IQService TLS is disabled and you have provided TLS port. Ensure that the **Enable Transport Layer Security (TLS)** checkbox is selected. > - This could be because the hostname of the IQService server does not match the FQDN of the TLS certificate. Verify that the hostname matches the FQDN or the SubjectAlternateName DN is the same as the FQDN of the TLS certificate. If they are not the same, use the following commands to specify the certificate FQDN for IQService and then restart IQService: > > ```text > iqservice.exe -m hostname.example.com > iqservice.exe -t > ``` > [!NOTE] > > **Connection refused** > > **Resolution** - Ensure your IQService service is running. > [!NOTE] > > **Failed to connect to IQService. Please check TLS configuration for IQService.** > > **Resolution** - This could be because the IQService version is older. Ensure your IQService service is upgraded to latest version. Deselect the **Enable Transport Layer Security (TLS)** checkbox for non-TLS communication. > [!NOTE] > > **Line: 1 Column:1: Content is not allowed in prolog.** > > **Resolution** - If you want to use the IQService TLS functionality, use the latest CCG version and IQService version. If you are not using the latest CCG version and IQService version, ensure that the **Enable Transport Layer Security (TLS)** checkbox is unchecked on source configuration. > [!NOTE] > > **Unrecognized SSL message, plaintext connection?** > > **Resolution** - If you want to use the IQService TLS functionality, ensure that latest CCG version and IQService is deployed. If you are not using the latest CCG version and IQService version, ensure that the **Enable Transport Layer Security (TLS)** checkbox is unchecked on source configuration. ### Client Authentication The following errors may be returned from IQService. > [!NOTE] > > **No such user registered with IQService.** > > **Resolution**: > > - Ensure that you have registered and configured the IQService user and password on IQService host using the following command: > > ```text > IQService -a username > ``` > - Ensure that you have provided the correct IQService user or password. Use the latest CCG version and IQService version. > [!NOTE] > > **Client authentication failed with error - The user's password must be changed before signing in** > > **Resolution** - The IQService user's password could be expired. To resolve the issue, change the password for the IQService user. > [!NOTE] > > **Client authentication failed with error - The user's account has expired** > > **Resolution** - Password could be expired for IQService user. To resolve the issue, change the password for IQService user. > [!NOTE] > > **Client authentication failed with error - The referenced account is currently locked out and may not be logged on to.** > > **Resolution** - Ensure that the IQService user is not locked. > [!NOTE] > > **Client authentication failed with error - This user can't sign in because this account is currently disabled** > > **Resolution**: Ensure that the IQService user is not disabled. > [!NOTE] > > **Client authentication failed with error - Your account has time restrictions that keep you from signing in right now** > > **Resolution** - The reason could be IQService user has enabled logon hours and you are trying to perform an operation outside of their defined logon hours. Ensure that logon hours are correctly configured. > [!NOTE] > > **The input is not a valid Base-64 string as it contains a non-base 64 character, more than two padding characters, or an illegal character among the padding characters.** > > **Resolution** - This is the error that displays if you are trying to perform client authentication with an old CCG version but the latest IQService version. You need to remove the user details from IQService using the command: `IQService -x username`. Also remove IQService user and password from source config. # IQService Settings IQService, also referred to as the Integration Service, is a native Windows service that enables SailPoint to operate in a Windows environment and access information only available through Windows APIs. **Operations supported through IQService**: [Before and After Scripts for IQService]() ## IQService Installation [![IQService Installation]()]() ### Download IQService To download the IQService installation, complete the following: 1. Select the **Download IQService** button. > **Note** IQService has the built-in capability to auto update (this is the default). To enable the auto update capability, UpdateService must be configured alongside the IQService installation. Refer to [Configuring IQService Auto Update](). Download, install, and configure IQService by following the steps listed in the [Identity Security Cloud IQService Administrator's Guide]() for [Installing and Registering IQService](). > **Note** You are only entitled to download components for which you have an active license with SailPoint and the availability of a component for download does not grant you a license to use a component or entitle you to use a component for which you do not have an active license. Contact your Account Representative or CSM for more information. ## IQService Settings [![IQService Settings]()]() 1. In the **IQService Host** field, enter the IP address of the system where IQService is installed. 2. Enter the **IQService Port** used by IQService. The default port is 5050. If you enable TLS, configure the corresponding IQService TLS port. 3. (Optional) Enter the **IQService User** for client authentication. 4. (Optional) Enter the **Password** of the user for client authentication. 5. (Optional) Select **Enable Transport Layer Security (TLS)** to use TLS communication for IQService. For more information on TLS communication, refer to [Configuring TLS and Client Authentication for IQService](). 6. Select **Save**. # Installing and Configuring IQService IQService, also referred to as the Integration Service, is a native Windows service that enables SailPoint to participate in a Windows environment and access information only available through Windows APIs. It is a lightweight service that must be installed on any supported Windows Server that has connectivity to the target systems you want to manage in SailPoint. ## Prerequisites > [!NOTE] > > **Software Requirements** > > | Operating Systems | .NET Framework | > | --- | --- | > | Microsoft Windows Server 2019; Microsoft Windows Server 2016 | .NET Framework version 4.8 Minimum; .NET Framework version required 4.5.2 Supports; .NET Framework version 4.7.1 | > > > **Note** > > > > IQService for SailPoint is compatible with lower versions of .NET Framework (4.5.2 onwards). SailPoint recommends using the latest version of .NET Framework 4.8 to align your environment with future releases of this service. > [!NOTE] > > **Hardware Requirements** > > This is the minimum hardware requirement for a basic working instance of IQService with an average processing load when used with one application. The requirement proportionately increases with an increase in the request processing load and number of applications it serves. > > | Component | Recommended Hardware Requirement | Minimum Hardware Requirement | > | --- | --- | --- | > | CPU | 8-Core | 4-Core | > | RAM | 16 GB | 8 GB | > | Free Disk Space | 50 GB | 250 MB | > [!NOTE] > > **Service Account** > > The service account defined in the SailPoint source that connects to IQService is used for provisioning operations, aggregation (terminal services attributes and Skype attributes), and server-less binding for respective target system. > > However, the account defined for the IQService Log On as an account in Windows is used for the before/after scripts where PowerShell is being used. If the source's service account is not used, then the PowerShell session is opened under the service account credentials of IQService. ## Installing IQService 1. Download the Integration Service from SailPoint via a source that requires it. > **Screenshot** > > [![Download IQService from the source]()]() 2. Run the following commands to install the IQService Windows service. - Install IQService for non-TLS communication with SailPoint: ```text IQService.exe -i ``` This command installs an IQService instance named `IQService-Instance1` and uses port 5050 if available. - Install IQService for TLS communication with SailPoint: ```text IQService.exe -i -o ``` This command installs an IQService instance named `IQService-Instance1` on the specified TLS port. > **Note** > > For more details on the requirements and procedure to set up TLS Communication and Client Authentication, refer to [Configuring TLS and Client Authentication for IQService](). - Install IQService for both TLS and non-TLS communication with SailPoint: ```text IQService -i -p -o ``` This command installs an IQService instance named `IQService-Instance1` on the specified TLS and Non-TLS ports. 3. Unzip the downloaded **IQService.zip** archive into the created or desired location. For example, `C:\SailPoint\IQService\` > **Note** > > Verify the DLLs are trusted by checking the properties of the DLL files. 4. Start the service either from the Services Applet or from the command line by running the following command: ```text IQService.exe -s ``` > [!NOTE] > > **IQService Commands** > > In addition to the commands -i to install and -s to start, other command line options with IQService include: > > | Command Line Options | Description | > | --- | --- | > | \-d | Run in console mode | > | \-i | Install a service. Refer to [Registering IQService](<#registering-iqservice>) for more information. | > | \-k | Stop the service | > | \-p | Update the port (requires a service restart) | > | \-r | Remove the service | > | \-u | Uninstall the service. Removes the service components and clears the registry entries. | > | \-s | Start the service | > | \-t | Restart (stop/start) the service | > | \-v | Print version information | > | \-l \\\ | Trace Level 0-3; 0=off 1=error 2=info 3=debug | > | \-f \\\ | Trace the file name. Defaults to the system32 directory.
Enter the full path with a filename to log to a different path. For example: `iqservice -l 3 -f "C:\Sailpoint\IQService\iqtrace.log"` | > | \-a | Registers a domain user for Client Authentication. Pass the domain user name in `msDS-PrincipalName` (domain\\user) format. Multiple users can be registered in a single command by separating them with a semicolon ( ; ).
This command appends users to existing registered users. For example: `-a "Acme\John.Smith; Acme\Joe.Phillips"`
Ensure that the exact same user name is configured on the source for this feature to work.
To list existing registered users, run the command with the `list` parameter.
For example: `-a list` | > | \-x | Unregisters a user from the Client Authentication Users List. Pass the domain user name in `msDS-PrincipalName` (domain\\user) format. Multiple users can be registered in single command by separating them with a semicolon ( ; ).
For example: `-x "Acme\John.Smith; Acme\Joe.Phillips"`
To list existing registered users, run the command with the `list` parameter.
For example: `-x list` | > | \-o \\\ | TLS port for communication between IQService and SailPoint. This port accepts communication over TLS only. | > | \-j \\\ | Enforce the specific TLS version for communication between IQService and SailPoint.
Supported values are:
\- `TLS1.2` (Default)
\- `TLS1.1`
\- `TLS1.0` | > | \-m \\\ | "Issued To" (CN of Subject) of the X.509 certificate. It is applicable to communication between IQService and SailPoint. This overrides the default lookup text for IQService to search for the X.509 certificate on the machine. By default, IQService looks for the X.509 certificate issued to FQDN of current machine.
For example: `-m example.com` | > | \-? \| h: | This is for help output | > [!NOTE] > > **Configuring Default TLS Version** > > The SailPoint IQService supports the `default` configuration for `tlsVersion`. To enable this configuration, execute the `IQService.exe -j` default command. > > With this configuration, the operating system selects the best available protocol. This configuration requires that `SystemDefaultTlsVersions` is enabled on the IQService machine. If it is not enabled, then IQService falls back to the highest commonly supported version from the predefined list of TLS versions. ## Registering IQService The `IQService.exe -i` command installs and registers the service with the new registry path `HKEY_LOCAL_MACHINE\SOFTWARE\SailPoint\IQService Instances\IQService-Instance1` with the following keys: | Keys | Description | | --- | --- | | port | Port to listen | | tracefile | Path to the tracefile | | tracelevel | 0 (off)
3 (verbose) | | maxTraceFiles | Maximum number of Trace log files that must get created before overwriting the older files | | traceFileSize | Maximum file size of a trace file in bytes. A new file is created when the current file exceeds this limit | | clientAuthUsers | If you configure IQService with client authentication, the IQService user is displayed with this key. | | tlsPort | If you configure the TLS port, the IQService is set up for the communication over TLS. | The IQService accesses only the IQService-related keys in the registry editor, and installs or uninstalls successfully. ## IQService Fallback Implementation In information technology, the term fallback refers to a backup solution to prevent the total failure of a system. The fallback solution commonly has a reduced or limited functionality but is still capable of operating the most important functions for a certain period, to allow time for operation of the system to be brought fully online again. After the primary system is restored, the fallback solution is deactivated and normal operation is resumed. IQService now allows you to install a secondary instance (fallback instance) of the primary service running on an IQService host machine. This secondary IQService instance takes over only when a primary IQService instance is down and not serving the requests coming from SailPoint. In SailPoint, any request from user gets routed through VA (Cloud Connector Gateway). VA takes care of sending request to the appropriate request handler. Here if primary IQService instance is down, then the request processing is redirected to secondary IQService instance by the VA. > [!NOTE] > > Once the primary IQService is restored or working as expected, the VA automatically starts redirecting requests to the primary IQService. [![IQService fallback]()]() The secondary service is not considered as a load balancer service or a high availability service. The secondary service works as a fallback service in case of failure of the primary IQService. > [!NOTE] > > The secondary IQService is used to serve requests when the primary IQService is down during upgrades. The secondary IQService handles manages requests if the primary IQService instance crashes and can handle the next requests until the primary service is running. However, the primary IQService must not be stopped purposefully and you should not keep the secondary service running to handle requests from SailPoint. If the primary IQService is stopped by running the `IQService -k` command, the secondary IQService is also stopped. ### Installing the Secondary IQService Instance The secondary IQService is automatically installed on the same host but with a different port (the installer uses another available port) as the primary IQService. 1. `IQService.exe -i` - This command installs two instances of IQService. During installation it creates a **IQService-Instance1-Secondary** directory inside the installation directory of IQService. It copies all files present in the installation directory to that directory. It is the installation directory for the **IQService-Instance1-Secondary** service. 2. `IQService.exe -i -b` - This command allows you to install only one instance of IQService. This command is recommended only you have a load balancer configured to take care of failures in the running service. 3. `IQService.exe -s` - If the secondary service is installed, this command starts both instances of IQService. 4. `IQService.exe -k` - If the secondary service is installed, this command stops both instances of IQService. 5. `IQService.exe -t` - If the secondary service is installed, this command restarts both instances of IQService. > [!NOTE] > > When the Primary service is started, stopped, or restarted either from a command or through a services console, the operation is performed on both the instances. After installation, you can configure different ports or TLS ports. > [!NOTE] > > **Configuring the Secondary IQService Instance** > > | Command | Description | > | --- | --- | > | `IQService.exe -v` | Print version information | > | `IQService.exe -p ` | Update the port number of secondary service | > | `IQService.exe -o ` | Update the TLS port number of secondary service | > | `IQService.exe -t` | Restart the secondary service. | > > For TLS, the secondary service uses all the configuration defined in primary service (except the TLS Port). > > The secondary service uses the log level defined in the primary service. The file name is the same as that of the primary service. The only change is the file is in the installation directory of the secondary service. > > > **Note** > > > > - It is recommended that you shouldn't stop the secondary service. > > - If the logon user is changed for the primary service, then you need to update the logon user for the secondary service to the same new user. > [!NOTE] > > **Secondary IQService Information** > > In SailPoint, the Test Connection call confirms that all the required components are up and running. With this new feature, the source sends secondary IQService port information to SailPoint. This information is stored in the source XML file, and it is utilized whenever there is a need to connect to a secondary IQService. There is no indication in the user interface that a secondary IQService exists. > > > **Note** > > > > - Secondary IQService details are not available on UI. > > - Secondary IQService details are updated in source xml file only after first Test connection call. ## Upgrading IQService To upgrade, you must uninstall the previous version and then install the new version. SailPoint also recommends backing up the current installation before uninstalling to aid with troubleshooting the new version, should issues arise. - To determine the existing (old) version, run the following command: ```text IQService.exe -v ``` - To uninstall the existing (old) version, run the following command: ```text IQService.exe -u ``` - Run the following command to install a new version: ```text IQService.exe -i ``` ### Upgrading IQService to the Latest Version 1. Take the backup of the existing IQService installation. 2. Stop the service either from the Services Applet or from the command line by running the following command: ```text IQService.exe -k ``` 3. Uninstall IQService using the `IQService -u` command. 4. Extract the latest IQService in the installation directory. 5. Install the new IQService using the `IQService -i` command. 6. Start the IQService. > [!NOTE] > > If you have executed the **IQService Public Key Exchange** task for the existing IQService then SailPoint recommends that you follow the instructions mentioned to install and register a new IQService. # Machine Account Attributes Machine account creation uses the same source attributes as standard account creation. For the complete list of supported attributes and their descriptions, refer to [Account Attributes](). For more information, refer to [Machine Identity Security Overview](). > [!NOTE] > > Attributes marked with an asterisk (\*) are mandatory. ## Machine Account Provisioning Attributes | Create Account Attribute | Description | | --- | --- | | sAMAccountName\* | Distinguished name of the account to be created. | | password\* | Password of the account to be created. | # Provisioning The Windows Local connector supports provisioning, allowing you to create and manage accounts and entitlements in Windows Local 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 | | --- | --- | --- | | sAMAccountName | Create Unique Account ID | The name for the user account to create. If the **Disable Qualifying Local Objects** checkbox in the source configuration is not selected, the format for the `sAMAccountName` is *hostName\\UserName*. If it is selected, the format for `sAMAccountName` is *userName*. | | Password | Create Password | Password for the new user account | | Description | Static | Description of the new user account. By default, the value is ``. | | FullName | Static | Full name of the user account. By default, the value is ``. | | Disabled | Static | Option to create a disabled user account. By default, the value is `false`. | | PasswordExpired | Static | Attribute to indicate whether the user must change their password on the next logon. By default, the value is `true`. | | PasswordUnchangeable | Static | Attribute that indicates whether the user is allowed to change their password. If the value is `false`, the user can change the password. If it is `true`, only the system administrator can change it. By default, the value is `false`. | | PasswordNeverExpires | Static | Attribute to indicate that the user account password never expires until the next password is set. | # 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 Windows Local 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 | | --- | --- | | sAMAccountName | Account | | sAMAccountName | Group | ### Default Account Attributes The Windows Local 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 | | --- | --- | | AutoUnlockInterval | Time interval for auto-unlocking of a locked user account. | | Disabled | Indicates if the user is disabled. | | Description | User's description. | | DirectoryPath | Fully qualified directory path. For example: `WinNt://...` | | FullName | User's full name. | | groups | List of groups to which the user belongs. | | HomeDirectory | Location of the user's home directory. | | Lockedout | Indicates if a user is locked out. | | MaxStorage | The maximum amount of disk space the user can use. | | MinPasswordLength | Minimum length of the user's password. | | Name | Name of the account unqualified `sAMAccountName` | | objectSid | Windows SID. | | PasswordAge | Time duration of the password in use. This property indicates the number of seconds that have elapsed since the password was last changed. | | PasswordExpired | Indicates if the password is expired. | | PasswordNotRequired | Indicates if the user requires a password. | | PasswordUnchangeable | Indicates if the user's password can be changed. | | Profile | User's profile. | | PrimaryGroupID | ID of the user's primary group. | | sAMAccountName | Fully qualified version of the `sAMAccountName`. This is an Account ID which must not be changed. | | UserFlags | User Flag defined in `ADS_USER_FLAG_ENUM` | | BadPasswordAttempts | Number of consecutive Bad Password Attempts made. | | LoginScript | File path of Login script file. | | HomeDirDrive | Home Directory Drive of the user. | | PasswordNeverExpires | Indicate if the user's password never expires. | | MaxPasswordAge | Indicates the maximum time interval, in seconds, after which the password must be changed. | | MinPasswordAge | Indicates the minimum time interval, in seconds, before the password can be changed. | | LastLogin | Date and time when user last logged in. | ## 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 Windows Local 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 | | --- | --- | | Description | Group's description | | DirectoryPath | Fully qualified directory path. For example: `WinNt://...` | | GroupMembers | List of groups assigned to the group | | GroupType | The group's type | | Members | List of users assigned to the group | | objectSid | Windows SID | | sAMAccountName | Fully qualified version of the `sAMAccountName`. This is an Account ID which must not be changed. | # 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]() ## IQService: Unspecified Error The following error message displays for any Windows Local application request: ```text Error returned from IQService:Unspecified Error ``` **Resolution** - Perform the following: 1. Ensure that the managed system is up and accessible from IQService host. 2. Ensure that the Username and Password provided in application configuration are correct. 3. If the managed system is in a workgroup, the **Guest Only** option for **Sharing and security model for local accounts** in the local policy forces all incoming network file sharing connections to authenticate as **Guest**. To resolve this problem, complete the following: 1. On the Windows Start menu, go to **Start \> Control Panel \> Administrative Tools \> Local Security Settings**. 2. In the left pane, expand **Local Policies \> Security** options. 3. In the right pane, double-click **Network access: Sharing and security model for local accounts**. 4. Select **Classic - local users authenticate as themselves** and select **OK**. 4. If the managed system is Windows Server 2003 Service Pack 2, then some Windows updates are missing from the system. Turn on Windows updates and install the latest updates. 5. Ensure that exception for **File and Printer Sharing** in windows firewall is enabled. 6. If the problem persists, restart IQService. ## IQService returns "The network path was not found" When the Remote registry service is not started on the Windows computer, the following error message displays: ```text Error returned from IQService: The network path was not found ``` **Resolution** - Ensure that Windows Service named, **Remote Registry Service** is started on the Windows managed system. ## Access Denied Error Provisioning operation fails with the following error when User Account Control (UAC) is enabled: ```text Access Denied ``` **Resolution** - Use one of the following options: - **Turn off the user Account Control** for Microsoft Windows Vista or later, by completing the following: 1. For Microsoft Windows Vista, go to **Control Panel \> User Accounts \> Turn User Account Control** and change it to **Off**. 2. For Microsoft Windows 7 onwards, go to **Control Panel \> User Accounts \> User Accounts \> Change User Account Control Settings**, and set it to **Never Notify**. - For more granular control, without disabling the User Account Control, add the following entry in the **Registry Editor** with a key value of `1`: ```text HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System\LocalAccountTokenFilterPolicy ``` ## Users/Groups are not aggregated after User/Entitlement aggregation process. Aggregation is getting successfully completed with 0 objects. **Resolution** - Perform the following on your Windows Local managed system. 1. Go to the group policy **Computer Configuration** \> **Windows Settings** \> **Security Settings** \> **Local Policies** \> **Security Options** \> **Network access:** Restrict clients allowed to make remote calls to SAM. 2. Select **Edit Security** to configure the **Security descriptor:**. 3. Add **Administrators** in **Group or user names:** if it is not already listed (this is the default). 4. Select **Administrators** in **Group or user names:**. 5. Select **Allow** for Remote Access in Permissions for **Administrators**. 6. Select **OK**. 7. The **Security descriptor:** must be populated with `O:BAG:BAD:(A;;RC;;;BA)` for the policy to be enforced. # 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" } ] ```