# SailPoint Microsoft SQL Server Connector Documentation > Microsoft SQL Server Connector Documentation # Documentation # Additional Information This section describes the additional information related to the Microsoft SQL Server Connector. ## Microsoft SQL Server Windows Service Account Managed service accounts and Group-managed service accounts must be created in the Active Directory by the domain administrator. > [!NOTE] > > If you want to aggregate service accounts, the Microsoft SQL Server Service account must be connected to Login User accounts. For more information, refer to [Configure Windows service accounts and permissions - SQL Server](). ## Windows Authentication and Kerberos The following topics contain information for configuring a connection to the SQL server source using Windows authentication and the Kerberos authentication protocol that supports it. ### Windows Authentication Windows authentication can go by many names. Some of the most common names include: - Windows authentication - Windows domain authentication - Domain authentication - Integrated authentication - Kerberos authentication In this topic, the terms "Windows authentication" and "Kerberos" are used. > [!IMPORTANT] > > To configure Windows authentication, you must properly configure [Kerberos](<#kerberos>). When you connect using a Windows user account, the SQL Server source validates the account name and password using the Windows principal token in the operating system. In other words, the user identity is validated by Windows, not the source. The source doesn't ask for a password and it doesn't validate the identity. Windows authentication is the default authentication mode. It is much more secure than SQL Server authentication. A connection made using Windows authentication is sometimes called a trusted connection, because SQL Server trusts the credentials provided by Windows. Windows authentication supports the following: - The Kerberos authentication scheme - Password policy enforcement with regard to complexity validation for strong passwords - Account lockout - Password expiration To properly support Windows authentication, the Virtual Appliance must be able to resolve the SQL server host, the key distribution center (KDC), and the default Kerberos realm. By using Windows authentication, Windows groups can be created at the domain level and a login can be created on the SQL Server source for the entire group. Managing access at the domain level can simplify account administration. For more information, refer to [Connecting through Windows Authentication]() in the Microsoft documentation. > [!NOTE] > > The linked document is not maintained by SailPoint and is subject to change without notice. #### Windows Authentication Compatibility Check To properly support Windows authentication, the Virtual Appliance must be able to resolve the SQL server host, the key distribution center (KDC), and the default Kerberos realm. To check if the VA can resolve the necessary components, run the following command, replacing `` with each component's fully qualified domain name: ```text nslookup ``` For example: - Verify resolvability with the SQL server: ```text nslookup MYSQLSERVER.EXAMPLE.COM ``` - Verify resolvability with the KDC: ```text nslookup MYKDC.EXAMPLE.COM ``` - Verify resolvability with the Kerberos realm: ```text nslookup EXAMPLE.COM ``` > [!NOTE] > > You may to change your DNS configuration on Virtual Appliance. For more information on changing the DNS, refer to [Network Troubleshooting](). ### Kerberos The SailPoint SQL Server connector supports Windows authentication using the Kerberos authentication scheme as an underlying protocol for authentication information exchange. To provide a Login Module Configuration File and a Kerberos Configuration File, refer to [Base Configuration](). #### Prerequisites - The SQLJDBCDriver.config and krb5.config files should be uploaded to the source - Update the `useMssqlKerberosAuth` parameter in the source XML using the REST API. **useMssqlKerberosAuth** - Boolean - Default - `false` This parameter should be set to `true` when you need to connect to a Microsoft SQL server database with Kerberos authentication. ```json [ { "op": "add", "path": "/connectorAttributes/useMssqlKerberosAuth", "value": true } ] ``` > **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. #### Login Module Configuration File **Filename** - SQLJDBCDriver.config > [!IMPORTANT] > > This file is mandatory to be provided for Windows Authentication. You can upload the file via [Base Configuration]() tab. For more ways upload the file, refer to [Upload Configuration Files](<#upload-configuration-files>). A login module configuration file consists of one or more entries, each specifying which underlying authentication technology should be used for a particular application or applications. The login module configuration file for this connector allows the SQL JDBC driver to acquire Kerberos credentials. Each login module configuration file entry consists of a name followed by one or more login module-specific entries. Each entry is terminated by a semicolon. Groups of entries are enclosed by braces. For more information, refer to *Creating a login module configuration file* in [Using Kerberos integrated authentication to connect to SQL Server]() in the Microsoft documentation. > [!NOTE] > > The linked document is not maintained by SailPoint and is subject to change without notice. #### Kerberos Configuration File **Filename** - krb5.config The krb5.config file contains the Kerberos configuration information, including the locations of key distribution centers (KDCs), administration daemons for the Kerberos realms of interest, defaults for the current realm and for the Kerberos applications, and mappings of host names onto the Kerberos realms. This file must reside on all Kerberos clients. The format of the krb5.config consists of section headings in square brackets. Each section can contain zero or more configuration variables (called relations), of the form: ```text relation = relation-value ``` or ```text relation-subsection = { relation= relation-value relation= relation-value ``` For more information, refer to [Creating a Kerberos configuration file]() in the Microsoft documentation. > [!NOTE] > > The linked document is not maintained by SailPoint and is subject to change without notice. ## Upload Configuration Files You can upload the required configuration files, SQLJDBCDriver.config and krb5.config, from the [Base Configuration]() tab. This is the recommended method for providing these files. Alternatively, you can upload the file with the following process: 1. Using FTP, SFTP, or any other transport means upload the file to one of the following locations in the Virtual Appliance: - `/opt/sailpoint/ccg/` - `/home/sailpoint/ccg/custom/` 2. Map the connector to the selected file location by adding the following entry into the source XML using the REST API, replacing `` with your selected file location: **Attribute** - `configFilePath` **Value** - `` For example: **Attribute** - `configFilePath` **Value** - `/opt/sailpoint/ccg/` > **Note** > > When Cloud Gateway is configured with MS SQL server connector, ensure the file specified in the `configFilePath` is also present on the Cloud Gateway machine at the same location. 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. > **Important** > > Do not skip the `/` at the end of the path value. > > Once you upload the file to the selected location, the CCG service needs to be restarted on the Virtual Appliance. This is to make sure that the previous cached configuration file - if one exists - is removed and a fresh configuration file is used. # Aggregation For more information about aggregation, refer to [Loading Account Data](). ## Accounts For the Microsoft SQL Server source, aggregation would bring server login as links and connected database accounts as entitlements. Orphan database accounts would not be fetched. ## Entitlement Aggregation Entitlement Aggregation would fetch server roles and database roles except public roles. > [!IMPORTANT] > > Deleting all database entitlements linked to accounts would delete linked database accounts. # Connecting SailPoint and Microsoft SQL Server To connect SailPoint with Microsoft SQL Server, 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. Drag and drop the required files into the **Upload Files** box, or upload them from your computer. > **Warning** > > Ensure that the file you upload is not vulnerable or malicious. Upload the [Microsoft SQL Server jar]() file used for the source connection. The current file and upload history are listed below the box. 9. (Optional) Upload the **SQLJDBCDriver.config** and **krb5.config** files used to connect to the source via Windows authentication. The current file and upload history are listed below the box. > **Warning** > > Ensure that the file you upload is not vulnerable or malicious. > **Important** > > This step is necessary if you select **Windows Authentication** as your **Authentication Type**. For more information, refer to [Connection Settings](<#connection-settings>). > > Once you upload the file to the selected location, you might need to restart the Cloud Connection Gateway (CCG) service on the Virtual Appliance. This is to ensure the previously cached configuration file - if one exists - is removed and a fresh configuration file is used. For more information, refer to the [Virtual Appliance Troubleshooting Guide](). > **Note** > > - For more information on Windows authentication and its requirements, refer to [Windows Authentication and Kerberos](). > - For alternative methods to uploading the configuration files, refer to [Upload Configuration Files](). 10. Select **Save**. ## Connection Settings Configure authentication settings used to connect to the SQL server source. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() To configure a secured, direct connection: 1. Select an **Authentication Type**. 2. Based on your selected **Authentication Type**, enter a **Database URL**. - For **SQL Authentication**: `<[serverName][\instanceName][:portNumber]]` Consider the following for this URL: - `jdbc:sqlserver` - (Required) This is known as the sub-protocol and is constant. - `serverName` - The address of the server or listener for clustered environments to which SailPoint should connect. This could be a DNS, IP address, localhost, or `127.0.0.1` for the local computer. - `instanceName` - The instance used to connect to `serverName` - `portNumber` - The port used to connect to `serverName` - For **Windows Authentication**: To properly support Windows authentication, the Virtual Appliance must be able to resolve the SQL server host, the key distribution center (KDC), and the default Kerberos realm. For more information about configuring Windows authentication, refer to [Windows Authentication and Kerberos](). > **Important** > > To use Windows authentication, you must upload **SQLJDBCDriver.config** and **krb5.config** files. For more information, refer to [Base Configuration](<#base-configuration>) or [Upload Configuration Files](). > > Connections using Windows authentication are supported for JDBC drivers only. `jdbc:sqlserver://><[serverName[\instanceName][:portNumber]];integratedSecurity=true;authenticationScheme=JavaKerberos;trustServerCertificate=true;` Consider the following for this URL: - `jdbc:sqlserver` - (Required) This is known as the sub-protocol and is constant. - `serverName` - The fully qualified domain name of the SQL server host machine. This is typically in the following format: `.` For example, if the SQL server host is `MYSQLSERVER` and the domain is `EXAMPLE.COM`, your entry would be as follows: `MYSQLSERVER.EXAMPLE.COM` - `instanceName` - The instance used to connect to `serverName` - `portNumber` - The port used to connect to `serverName` 3. Enter the service account username into the **Login Account Name** field. The service account is the account that makes the connection to the Microsoft SQL server database. If you are using Windows authentication, the service account should be in the following format, with `` as the username and `` as the domain name: `@` For example, if `user` is the service account username, and `EXAMPLE.COM` is its domain, then the entry is as follows: `user@EXAMPLE.COM` 4. Enter the **Password** used to authenticate the service account. If you are using Windows authentication, the password you enter is the password that authenticates the Active Directory user. 5. Enter the fully qualified name of the **Driver Class** supported by JDBC. For example, you can use the following: `com.microsoft.sqlserver.jdbc.SQLServerDriver` ### Database Connection Settings > [!NOTE] > > **Screenshot** > > [![Database Connection Settings]()]() > [!NOTE] > > If you leave both the **Included Databases** and **Excluded Databases** fields blank, SailPoint aggregates all server accounts and users from all available databases, except orphan database users (databases users who are not linked with any server account) and databases users with only public roles. 1. In the **Included Databases** field, enter a comma-separated list of database names to be included in the aggregation operation. The Microsoft SWL server source supports database names with special characters during account aggregation. 2. In the **Excluded Databases** field, enter a comma-separated list of database names to be excluded in the aggregation operation. The Microsoft SWL server source supports database names with special characters during account aggregation. > **Important** > > If the **Include Databases** field is configured, SailPoint ignores the **Excluded Databases** parameter. 3. In the **Additional Connection Parameters** field, you can set up the additional parameters as per your requirements, in the form of a key-value pair. Press **Enter** to add each multiple key-value pair to a list that displays below the field. 4. Select **Save**. ## Additional Settings Configure additional connector options. ### Page Size Configure the maximum number of records to aggregate in a single page when iterating over large datasets. > [!NOTE] > > **Screenshot** > > [![Additional Settings]()]() 1. Enter the **Page Size** that is the number of rows in a result set. By default, the page size value is 1000. 2. Select **Save**. ## 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 Microsoft SQL Server Microsoft SQL Server is a relational database management system developed by Microsoft. As a database, it is a software product whose primary function is to store and retrieve data as requested by other software applications, be it those on the same computer or those running on another computer across a network (including the Internet). This document describes features, requirements, and procedures needed to create a direct connect source configuration for a Microsoft SQL source. It also describes how to configure the features that are supported. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Microsoft SQL Server source supports the following features: - Account Management - Aggregate Microsoft SQL Server Windows Service account as the following: - Managed service accounts - Group-managed service accounts - Virtual accounts For more information, refer to [Microsoft SQL Server Windows Service account](). - \*Password Management - \*Provisioning - \*Access Certifications (certification of entitlements connected to accounts) - Delete Account - Aggregate Windows Active Directory groups created on the Microsoft SQL server For more information on features, refer to [Source Features](). > [!NOTE] > > Features marked with an asterisk (\*) must be purchased and activated. This is an advanced connector for entitlements, provisioning, and password management. Please open a support ticket for assistance. The Microsoft SQL Server source supports the Always-On feature of the Microsoft SQL Server target systems. ### Direct Permissions The Microsoft SQL Server source supports the direct permissions: - Permissions directly assigned to accounts and groups as direct permissions during accounts and entitlement aggregation respectively - Revocation of the aggregated permissions for accounts through certification Perform the following steps to enable direct permissions and their aggregation, for the account or the group schema of your Microsoft SQL Server source. 1. Use [listSources]() API to get source ID for your source. 2. Use [listSchemas]() API to get schema ID for the account or group schema for which you want to enable direct permissions. 3. Use [updateSchema]() API and enter the following content in body. ```text [ { "op": "add", "path": "/includePermissions", "value": true } ] ``` Following targets are supported: - DATABASE - SERVER - PROCEDURE - ASYMMETRIC\_KEY - SYMMETRIC\_KEYS - USER - CERTIFICATE\_MAPPED\_USER - DATABASE\_ROLE For example, - `GRANT CONNECT on 'databaselogin@databasename:DATABASE'` - `GRANT CONNECT SQL on 'serverloginname:SERVER'` ### Privilege Classification SailPoint Privilege Classification helps organizations systematically categorize and manage the privilege levels of entitlements within their sources. By classifying entitlements as high, medium, or low, administrators can better understand the potential risk and impact associated with specific access rights. This allows automatic assignment of privilege levels based on system recommendations, custom-defined criteria, or a same level across all entitlements. | Privilege Level | Description | | --- | --- | | High | Administrative level access to accounts | | Medium | Administrative level access for a specific role or function | | Low | Only basic access of data | > [!NOTE] > > To manage Privilege Classification, users must have administrative roles such as Org Admin, Source Admin or Source Sub-Admin. For more information, refer to [Managing Privilege Classification](). ### 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](). ## Amazon Web Services Relational Database Service (AWS RDS) AWS RDS is a managed service provided by Amazon and there are certain restrictions on what an administrative account can perform on the MSSQL instance on AWS RDS. As a result of these restriction, SailPoint Microsoft SQL Server Connector supports Microsoft SQL Server on AWS RDS with the following mentioned limitations: - The endpoint URL of the AWS RDS instance must be obtained from the AWS Management Console, and it must be accessible from the Microsoft SQL Server source. The AWS Security groups must be updated. > **Note** > > The source configuration attributes are the same. - Operations which are prohibited for **master** user of the AWS RDS Microsoft SQL instance would also not be allowed for the service account user for SailPoint Microsoft SQL Server Connector. - The model system database cannot be managed using SailPoint's Microsoft SQL Server Connector and has to be added to the excluded databases list configuration. It is recommended to exclude the other system databases (namely master, tempdb and msdb) as all operations (that is, provisioning) are not supported for these databases. - The service account has restricted permissions to the following server roles: - bulkadmin - dbcreator - diskadmin - securityadmin - serveradmin - sysadmin > **Note** > > It is recommended that these server roles must be made non requestable in SailPoint. Apart from the above listed server roles, for provisioning any custom server roles with service account, the following permission must be assigned to the service account: ```text grant alter any server role to [account] ``` - If SailPoint Microsoft SQL Server Connector is to be used as a read only connector, there is a limitation from AWS RDS for assigning the following permission (in reference to the permissions mentioned under [Aggregation](<#aggregation>)): ```text grant connect any database to [account] ``` As a workaround a database account must be associated with the service account for each database that needs to be managed. > **Note** > > Support for Windows authentication is yet to be validated for AWS RDS. - Few users such as the master and rdsa users can be aggregated, but provisioning operations cannot be performed on these users by the Microsoft SQL Server source. ## SSL Connection The Microsoft SQL Server Source supports the SSL Connection. **Configuration Steps:** 1. On the source VA, log in with the SailPoint user. 2. Go to `/home/sailpoint/certificates`. 3. The final certificate file obtained from the server must be placed in this directory. 4. In the `hosts.yaml` file make an entry of the SQL Server host in the XXX.XX.XX.XXX format. > **Note** > > For information on creating a hosts.yaml file, refer to [Configuring a Hosts.yaml File](). 5. Restart the CCG with the `sudo systemctl restart ccg` command. 6. Create a source on SailPoint with the following URL: `jdbc:sqlserver://:;encrypt=true;trustServerCertificate=false;hostNameInCertificate=` ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). - Identify or create a service account on the Microsoft SQL system. - The Microsoft SQL Server jar file has been obtained. Refer to [Download Microsoft JDBC Driver for SQL Server]() for detailed instructions. ### Prerequisites for Using the AlwaysOn Availability Groups Feature - All the Server Login accounts must be replicated across all the primary and secondary nodes of the Microsoft SQL Servers which are configured for availability group. Although this is not provided out of the box by Microsoft, there are [MSDN articles]() on how to achieve it. - Only the user databases that are in the availability databases of the availability group must be part of the databases managed by the Microsoft SQL Server source. > [!NOTE] > > The Microsoft SQL Connector currently does not support the ability to read from secondary databases that are available for read-only access. ## Supported Managed Systems The SailPoint Microsoft SQL Server connector supports the following versions: - Microsoft SQL Server 2022 - Microsoft SQL Server 2019 on supported Linux platforms: - Red Hat Enterprise Linux - SUSE Enterprise Linux Server - Ubuntu For more information on the Linux versions, refer to [Release notes for SQL Server 2019 on Linux](). - Microsoft SQL Server 2019 - Microsoft SQL Server 2017 - Microsoft SQL Server 2016 - Azure Managed Instance. When using an Azure Managed Instance, Windows authentication is not supported. For more information, refer to the [Microsoft documentation](). - Microsoft SQL Server on Azure SQL Virtual Machines. - For Azure SQL database managed systems, use the Microsoft Azure SQL Database connector. For more information, refer to [Microsoft Azure SQL Database](). - Microsoft SQL Server hosted on Amazon Web Services Relational Database Service (AWS RDS). For more information on AWS RDS, refer to [Amazon Web Services Relational Database Service (AWS RDS)](<#amazon-web-services-relational-database-service-aws-rds>). ## Administrator Permissions Login using administrator credentials and create a new user on managed system using the following command: ```text CREATE LOGIN WITH PASSWORD = '' ``` The following minimum permissions are required for Microsoft SQL Server service accounts (user) based on the operations: #### Test Connection ```text grant Connect SQL to [user] ``` > [!NOTE] > > In order to access databases, service account must have user mapping on the databases. #### Aggregation ```text use [master] GO grant Connect SQL to [user] grant view any database to [user] grant view any definition to [user] grant connect any database to [user] ``` #### Enable/Disable User ```text grant alter any login to [user] ``` #### Change Password ```text grant alter any login to [user] ``` #### Delete Account ```text grant alter any login to [user] ``` #### Delete Role ```text use [database name] create user [username] for login [server login name] grant alter any role to [username] ``` #### Create Account ```text grant alter any login to [user] ``` #### Create Role ```text use [database name] create user [username] for login [server login name] grant alter any role to [username] ``` To perform any operation on a database, the service account must have database user on the specific database. ```text use [database name] create user [username] for login [server login name] exec sp_addrolemember db_owner, [username] ``` User must have proper server role assignments to assign the same role to another user. **For example**, if administrator has granted Role1, Role2, Role3 roles to user A then, user A can grant only Role1, Role2, Role3 to any other user. User A cannot assign other roles apart from the roles assigned to it. Above mentioned permissions are required for adding and removing entitlements. #### Revoke Permissions To revoke permissions, the service account must have Grant access to those permissions. For example, if the service account (user) wants to revoke 'X' permission for any other user, it must have the Grant access to the 'X' permission. > [!NOTE] > > To revoke server-level permissions, such as `CONNECT SQL`, the service account must have the necessary admin-level permissions. For example, if you want to revoke the `CONNECT SQL` permission for any user with a service account (a user with minimum permissions), the service account must have either the `CONTROL SERVER` permission or have a membership of the sysadmin fixed server role. # 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. ## Machine Account Provisioning Attributes Use the following table to map each machine account attribute to its display name, data type, requirement status, and usage notes. | Field (name) | Display Name | Type | Required | Notes | | --- | --- | --- | --- | --- | | `native_identity` | Name | `string` | Yes | Create a unique Account ID/Name within 20 characters. | | `password` | Password | `secret` | Yes | Store and manage via enterprise secret handling standards. | | `type_desc` | type\_desc | `string` | Yes | Default value from template, can be set to `WINDOWS_LOGIN` and `SQL_LOGIN` if required by target environment. | For additional details about machine account implementation, refer to the [Machine Identity Security Overview](). # Provisioning The Microsoft SQL Server connector supports provisioning, allowing you to create and manage accounts and entitlements in Microsoft SQL Server 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 The following generators create required information for a new Microsoft SQL Server account. You might need to edit the contents. | Account Attribute | Generator | Description | | --- | --- | --- | | \*native\_identity | Generator | Native identity represented by default as login Name | | password | Generator | Account password for newly created server account | | \*type\_desc | Static | Description type of the login | > [!NOTE] > > The Microsoft SQL Server source provisioning operation does not fail for the case-sensitive database. # 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 Microsoft SQL Server 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 | | --- | --- | | native\_identity | Account | | native\_identity | Group | ### Default Account Attributes The Microsoft SQL Server 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 | | --- | --- | | native\_identity | Native identity represented by default as `loginName`. This is an Account ID which must not be changed. | | server\_login | Server login associated to account. | | name | Account name. | | principal\_id | ID of database principal. | | type | Type of the login. | | type\_desc | Description type of the login. | | create\_date | Creation date of the login. | | modify\_date | Last modification date of the login. | | sid | SID of the login. | | server\_name | Server name. | | is\_fixed\_role | If the value is `1`, then this row represents an entry for one of the fixed database roles. | | owning\_principal\_id | ID of the principal that owns this database principal. | | roles | Server and database roles assigned to the login and its mapped database users. | | DBUser | Database users which are associated to the login

**Note:** SailPoint recommends that, on Managed Systems the server name and database name must not be the same. | ## 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 Microsoft SQL Server 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 | | --- | --- | | native\_identity | Native identity represented by default as `groupName`. This is an Account ID which must not be changed. | | name | Group name. | | database\_name | Database name in which group exists. | | database\_id | Database ID in which group exists. | | principal\_id | ID of database principal. | | roles | Roles assigned to the group. | | server\_name | Server name of the group. | | type\_desc | Description type of the group. | # 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]() ## The Test Connection Fails with the Connection is Closed Error The logs show error: com.microsoft.sqlserver.jdbc.SQLServerException: The "variant" data type is not supported. **Resolution**: The issue arises when the application is using an older version of the mssql jar that does not support the variant data type. Upgrade to the latest mssql jar provided by Microsoft to resolve the issue. ## Aggregation Error When a login user is created in Microsoft SQL Server and is granted permission only on some of the Databases present on the server and if aggregation task is run for that source, Aggregation fails as the user is not able to access other databases. **Resolution**: In configuration under the **Include Databases** section, provide the complete list of databases (comma separated list) for which the login user have accesses. This completes the aggregation successfully, and only details of the users present in the list of included database will be fetched. ## Kerberos Login Failed **Issue :** Integrated authentication failed. ClientConnectionId:f5aec66e-a9d2-48f1-8bce-b894a3a9bb65 due to javax.security.auth.login.LoginException (Client not found in Kerberos database (6)) **Resolution**: Make sure login to Active Directory machine check the UPN name of the service account configured. The same should be configured in source. ## Server Name Error During aggregation if the SERVERNAME variable has not been declared in the Microsoft SQL Server database, connector displays the following error message: `"SQLServerException: Must declare the scalar variable "@@SERVERNAME"` **Resolution**: The SERVERNAME variable must be declared and defined in the Microsoft SQL Server database before performing the aggregation. ## Delete Provisioning Operation Fails with an Error Message Delete provisioning operation fails with the following error message when the service account does not have **db\_owner** permission on the Microsoft SQL Server database along with **Alter any login** permission on it: `"Logins other than the current user can only be seen by members of the sysadmin role."` **Resolution**: A service account must have the **db\_owner** permission on the Microsoft SQL Server database along with **Alter any login** permission. ## Data Out of Order Exception While Merging When the Index Column Contains Special Characters When the index column contains special characters, during merging it shows the following error: `[ InvalidConfigurationException ] [ Possible suggestions ] For data merging, data should be ordered. Please add order by clause in aggregation query or set disableOrderingCheck as true. [ Error details ] java.lang.Exception: Data out of order exception. Data should be sorted in ascending order.` **Resoultion:** SailPoint uses the `java.text.Collator` class to check for ascending (or descending) order. The JVM instance uses the environment locale setting of language, country, and variant when comparing the records. If the database `ResultSet` does not comply with the collator instance, then the exception occurs. The recommended resolution is to align the locale settings between SailPoint and your database instance. As an alternative, adjusting the dataset also resolves the ordering constraint. **Method 1:** 1. In order to add a collator class, you need to write one and add the compiled class to your library path for the web application and add it to your JDBC app definition. 2. Add the following entry to the source XML using the REST APIs: `POST https://{orgName}.api.identitynow.com/cc/api/source/update/{source ID}` In the body of the POST, use the form-data as follows: - Key: `collatorClassName` - Value: `something.collators.MyCollator` > **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. 3. Drop the `MyCollator.class` in WEB-INF\\classes\\something\\collators For more information, refer to [RuleBasedCollator (Java Platform SE 7)](). You will want to extend your custom collator off of this class. **Method 2:** 1. Remove the check for sorting and make sure that the ordering in the SQL query is correct. 2. Add the following entry to the source XML using the REST APIs: `POST https://{orgName}.api.identitynow.com/cc/api/source/update/{source ID}` In the body of the POST, use the form-data as follows: - Key: `disableOrderingCheck` - Value: `true` > **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. You should know that is your data is out of order in your query, then there is the possibility of the aggregation missing information with this option, but if you are sure your data is in order, then this workaround should be able to work for you. ## The Test Connection Fails with an Error Even When SSL is Not Configured for the Connection The test connection fails with the following error even when SSL is not configured for the connection: `The driver could not enable secure connection to SQL server by using SSL encryption. pkix path validation failed java.security.cert.certpathvalidatorexception validity check failed` **Resolution**: By default, in versions 4.0.0 or above, Microsoft set the value for encrypt as true. For these versions you must pass `encrypt=false;` in the URL. For example: `jdbc.sqlserver://:;encrypt=false;` ## Test Connection Using Windows Authentication Fails After configuring Windows authentication, test connections fail. **Resolution** - Refer to the [Kerberos Setup Checklist]() and confirm that Windows authentication and Kerberos are configured correctly. ## Test Connection Error While Using Windows Authentication **Issue:** during test connection for SQLJDBCDriver.config file this error occurs: ```text java.io.IOException: Configuration Error: Line 3: expected [option key] ``` **Resolution:** This file is in Window format (with CR LF) and convert it into Unix format (with LF only). ## The Following Errors are Only Applicable When Using an Azure Managed Instance ### You Receive a Pooled Connection Error When Trying to Test the Connection 10 to 15 Minutes After Previously Configuring and Testing the Connection **Resolution**: This is expected system behavior as cloud databases periodically reconfigure themselves. If you connect to it in this time span, you will get a **transient error**. Wait a couple of minutes and retry the connection. ### When Trying to Connect to an On-Prem Machine to Azure SQL You Get a Connectivity Error **Resolution**: For a connection to an Azure SQL Managed Instance, check the following to resolve the error: - If the endpoint is a private endpoint (for example, if you are using an Azure ExpressRoute or other VPN connection), ensure that the tcp/3342 port is open to the managed instance private endpoint DNS address (for example, this could be an application gateway or dedicated IP address depending on your configuration). - If the endpoint is a public endpoint, ensure that the tcp/3342 port is open to the public endpoint DNS address (for example, this could be an application gateway or a dedicated IP address depending on your configuration). # 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" } ] ```