# SailPoint Duo Connector Documentation > Duo Connector Documentation # Documentation # Behavioral Changes There are certain expected behaviors on the Duo source after you aggregate the accounts. - On the Duo source system, the last login details for some of the users are displayed as `Never authenticated`, if those users are not enrolled. In this case, during aggregation, the `last_login` on the Duo source is displayed as blank for that account. - Provisioning on AD\_SYNC user(s) on Duo system fails with an error message, because the `Directory Sync` users cannot be modified. - The following table indicates the status of users and administrators from the Duo managed system on the Duo source: | Type | Status | | --- | --- | | **Duo User** | | | Status on Duo Managed System | Status on the Duo Source | | Active | Enabled | | Bypass | Enabled | | Disabled | Disabled | | Locked Out | Locked | | **Duo Administrator** | | | Status on Duo Managed System | Status on the Duo Source | | Active | Enabled | | Disabled | Disabled | # Connecting SailPoint and Duo To connect SailPoint with Duo, 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 **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. Select **Virtual Appliance**. A virtual appliance is a Linux-based virtual machine that connects to your sources and apps using SailPoint APIs, connectors, and integrations. For more information about configuring and deploying virtual appliances, 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 in SailPoint, 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. For more information, refer to the **Connection Settings** section. 6. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. 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. 3. 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](). 4. 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. 5. 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. 6. (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](). 7. 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](). 8. 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 To configure the connection settings, complete the following: > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **API Hostname** of an account. 2. Enter the **Integration Key** required to configure your system to work with Duo. 3. Enter the **Secret Key** password identifying integration with Duo. 4. Select **Save**. ## Aggregation Settings For more information about aggregation, refer to [Loading Account Data](). ### Aggregation Filter Settings Provide the settings for your aggregation. > [!NOTE] > > **Screenshot** > > [![Aggregation Filter Settings]()]() > [!IMPORTANT] > > The Duo connector supports an attribute called `pageSize` that is for associated attributes of end users (such as phones or groups) using the SailPoint REST APIs. Default: 100, Maximum value: 500. For more information on APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. To configure the aggregation filter settings, complete the following: 1. Enable **Manage Administrator Users** from the Duo managed system on the Duo source. 2. Enter the **End Users Page Size** value. Default: 100, Maximum value: 300. 3. Enter the **Groups Page Size** value. Default: 100, Maximum value: 100. 4. Enter the **Administrator Users Page Size** value. Default: 100, Maximum value: 500. 5. 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 Duo Connecting SailPoint to your Duo system allows you to manage the Duo user accounts. This guide is designed to give specific information about the requirements and field definitions needed to getting a working instance of Duo. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Duo connector supports the following features. > [!NOTE] > > The Duo accounts include Duo users and Administrators. The Duo source supports Password Management for Duo administrators only. Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. ### Account Management Manages Duo Users and Administrators as accounts. **For Duo Users** - Aggregation, Refresh Accounts - Create, Update, Delete - Enable, Disable, Unlock - Add/Remove Entitlement - Add/Remove Phone Attribute: `phone_type` and `phone_platform` **For Duo Administrators** - Aggregation, Refresh Accounts - Enable, Disable - Create, Update, Delete - Change Password - Add/Remove Associated Administrative Units ### Account - Group Management - Aggregation > **Note** > > By default, the Duo Administrator with the Owner role is enabled. - Supports Administrative Unit as a group object. For more information, refer to [Administrative Unit Group Attributes](). > **Note** > > You need to manually add the Administrative Unit as a group object to utilize it. For more information on features, refer to [Source Features](). ## Prerequisites - Create an Admin API integration. This generates an Integration Key and Secret Key that is required for Duo configuration. For more information, refer to [Connection Settings](). - Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](). ## Required Permissions Sign in as an administrator user to the [Duo Administrator Panel](). Ensure that the administrator creating the new Administrator API integration has the following permissions: When **Manage Administrator Users** is enabled: - Grant Administrators - Grant Read Resource - Grant Write Resource When **Manage Administrator Users** is not enabled: - Grant Read Resource - Grant Write Resource > [!NOTE] > > For read only operations, the `Grant Write Resource` permission is not required. # Machine Account Attributes ## Machine Account Provisioning Attributes The following table lists the attributes in the machine account creation template, including the generator and description for each attribute. | Attribute | Type | Required | Initial Value | | --- | --- | --- | --- | | user\_Type | string | No | static | | username | string | Yes | static | | name | string | No | static | | email | string | No | static | | phones | string | No | disable | | realname | string | No | none | | role | string | No | none | For more information, refer to [Machine Identity Security Overview](). ### Classification The `Classification` attribute is used to identify and categorize the account as a machine account. This connector includes the `userType` attribute for classification. The generator is disabled by default. - Attribute name: `UserType` - Value: `Communication`, `Reference`, `Service`, `System` # Provisioning The Duo connector supports provisioning, allowing you to create and manage accounts and entitlements in Duo 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 | | --- | --- | --- | | user\_type | Static | Generator is Static. The default value is 'User'. When you want to manage as administrator, this value need to be set as "Administrator" in the Static Value field. | | username | Identity Attribute | This is an Identity Attribute. The Duo user name as taken from the SailPoint user name. | | name | Identity Attribute | This is an Identity Attribute. The Duo administrator name as taken from the SailPoint user name. | | email | Identity Attribute | This is an Identity Attribute. The email address of the user. | | phones | Identity Attribute | This is an Identity Attribute. The phone number of the user. | | realname | Disable | It is disabled by default. The real name of the user. | | password | Disable | It is disabled by default. The password of the administrator user. The Duo source supports password management of Duo administrators for external management of the password on the Duo native system. Refer to the following details:
\- has\_external\_password\_mgmt: Set this to true in the Static Value field for the administrator's password along with the password attribute. Set it to false if passwords are self-managed. The default value is false.
\- password: Provide the password for the Duo administrator after setting the has\_external\_password\_mgmt attribute to true. | | role | Disable | It is disabled by default. This is the Duo administrator role. The default role ‘Owner’ is assigned to the administrator if the role value is not provided as available in the Duo managed System. To set this to other role, this must be configured as 'Static' and the role name must be provided in the Static Value field. | > [!NOTE] > > The `phone_type` and `phone_platform` attributes are supported as Create Account attributes and while configuring, both these attributes must be set in combination. Without providing values for both the attributes, for single or multiple phone numbers assigned to an account, the default phone type is set as `Mobile` and the default phone platform is set as `Generic Smartphone` in the Duo managed system. ### User Attribute The Duo connector creates a Duo user if the `user_type = User` attribute is present in the Create Account section. If you have marked this attribute as Disabled, while creating a Duo user, you may change that and set this value as User as per your requirement. You can also skip this usage and retain `Disabled` as a value. There is no impact and change in creation of a Duo administrator and `user_type` must be set to `Administrator` while creating the Duo administrator. ## Duo Admin User The Duo source supports aggregation, provisioning, and password management of the administrator user in the Duo managed target system. For the new Duo sources, on the UI, select **Manage Administrator User** to start managing the Administrator Users. For provisioning of the Admin user, the additional attributes that you must consider with the existing attributes are: - `user_type` - `name` - `password` (Optional) - `phone` (Optional) - `role` Refer to [Default Create Account Attributes](<#default-create-account-attributes>) for more information. To send an email with the set up link while creating the Duo administrators, add the `send_email` attribute in the Create Account section and set it to `true` as a Static Value field. The default value is false. ### For Pre-existing Sources Refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() to add the following attributes using APIs. - Add schema attributes as per the following settings: - `role`: Administrator role: string - `user_type`: Type of user: string - `restricted_by_admin_units`: Administrator account restricted by an administrative unit assignment: boolean - Add the `adminUsersUri` attribute key with a value such as `/admin/v1/admins`. - To enable the password management for administrator user, the feature value `PASSWORD` must be added to the features string. Add the `featuresString` attribute key with a value such as `PROVISIONING, SYNC_PROVISIONING, UNLOCK, ENABLE, SEARCH, PASSWORD`. > [!CAUTION] > > Password management is applicable for the administrator users and not for the normal users. # 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 Duo 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 | | --- | --- | | user\_id | Account | | group\_id | Group | ### Default Account Attributes The Duo 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 | | --- | --- | | username | The name of the user. | | status | The status of the user:
\- **Active**: The user must complete secondary authentication.
\- **Bypass**: The user will bypass secondary authentication after completing primary authentication.
\- **Disabled**: The user will not be able to sign in.
\- **Locked out**: The user has been automatically locked out due to excessive authentication attempts. | | email | The email address of the user. | | user\_id | The unique ID of the user as generated by the Duo system. | | realname | The real name of the user. | | notes | Notes about the user. Seen in the Duo administrative interface. | | groups | The list of groups to which the user belongs. Contains the description and name of the group. | | phones | The phone numbers of the user account. | | last\_login | The last login time of the user account. | | tokens | The token for the user account. | | desktoptokens | The desktop tokens for the user account. | | role | The administrator role. | | user\_type | The type of user. | | restricted\_by\_admin\_units | The administrator account restricted by an administrative unit assignment. | | alias1 | Username Alias 1 | | alias2 | Username Alias 2 | | alias3 | Username Alias 3 | | alias4 | Username Alias 4 | ### Support for Alias Duo supports aggregation and provisioning of aliases assigned to the user. To use this functionality, add the alias attribute to the account schema in the following format: | Summary | Description | | --- | --- | | alias1 | Username Alias 1 | | alias2 | Username Alias 2 | | alias3 | Username Alias 3 | | alias4 | Username Alias 4 | | alias5 | Username Alias 5 | | alias6 | Username Alias 6 | | alias7 | Username Alias 7 | | alias8 | Username Alias 8 | > [!NOTE] > > - Aggregation supports multiple aliases assigned to the user. Users can have up to 8 aliases on the Duo managed system. > - Provisioning is supported by up to 4 aliases. ## 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 Duo 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 | | --- | --- | | name | The group's name. | | desc | The group's description. | | status | The group's authentication status:
\- **Active**: The user must complete secondary authentication.
\- **Bypass**: The user will bypass secondary authentication after completing primary authentication.
\- **Disabled**: The user will not be able to sign in.
\- **Locked out**: The user has been automatically locked out due to excessive authentication attempts. | | group\_id | The group's ID. | | voice\_enabled | If true, users in the group will be able to authenticate with a voice callback. If false, users in the group will not be able to authenticate with a voice callback. This setting has no effect if voice callback is disabled globally. | | sms\_enabled | If true, users in the group will be able to use SMS passcodes to authenticate. If false, users in the group will not be able to use SMS passcodes to authenticate. This setting has no effect if SMS passcodes are disabled globally. | | mobile\_otp\_enabled | If true, users in the group will be able to use mobile OTP password to authenticate. If false, users in the group will not be able to use mobile OTP password to authenticate. This setting has no effect if mobile OTP passwords are disabled globally. | | push\_enabled | If true, users in the group will be able to use Duo Push to authenticate. If false, users in the group will not be able to use Duo Push to authenticate. This setting has no effect if Duo Push is disabled globally. | ### Default Administrative Unit Group Attributes The following lists the Administrative Unit group attributes: | Attribute Name | Description | | --- | --- | | groups | The groups assigned to the administrative unit. | | integrations | The groups assigned to the administrative unit. | | admin\_unit\_id | The administrative unit's unique ID. | | name | The administrative unit's name. | | description | The administrative unit's description. | | restrict\_by\_integrations | Select either true or false if the administrative unit specify integrations. | | restrict\_by\_groups | Select either true or false if the administrative unit specify groups. | > [!IMPORTANT] > > For existing applications created before December 2023, to support aggregation and provisioning of associated Administrative Units, manually add this attribute in the **Account Schema** with properties such as **Managed**, **Entitlement**, and **Multi-Valued**. # Migrate VA-based Source to a SaaS Source Some sources that are connected to virtual appliance (VA) clusters can be migrated to SaaS connections. This ensures data (users and entitlements) remain intact and can maintains your source configurations like access profiles, roles, password settings, and correlation configurations when switching from a VA cluster to a SaaS connection. To migrate a source from a VA-based source to a SaaS source, you will provide configuration details on a draft version of the source before publishing the source. > [!NOTE] > > - You must have an Admin or Source Admin user level to migrate a source. A draft version of the source is created. As your migration process is in progress the live source will continue to work as it is. For more information on the Duo SaaS connector, refer to the [Duo SaaS Supported Features](). ## Important Considerations Before Migrating - You do not need to edit additional configurations (other than connection credentials) to migrate the source. - If your source migration is in progress, please do not make any configuration changes to your live source as those can be overwritten once you apply the migration your draft version. - Once you've gone ahead with your migration, it can't be rolled back. Your source is permanently migrated to a SaaS source. - Any preview operations or configuration changes on the draft source will not impact the live source until you apply the migration. ## Migrating Sources To migrate your source, complete the following: 1. Go to **Admin \> Connections \> Sources**. 2. Select or edit the VA-based source you want to migrate. 3. Open the source configuration, and select **Migrate to SaaS**. 4. When prompted, select **Continue**. A draft version of the source is created. The live source will continue to work. 5. Select **Connection Settings**. 6. Re-enter encrypted configuration details. For example, you might need to re-enter the Client Secret, Password, Refresh Token, Personal Access Token (PAT), or Certificates to migrate from the VA cluster to the SaaS connection. > **Important** > > Avoid editing the other configuration options in the draft source. 7. Select **Review and Test**. 8. Select **Test Connection**. 9. (Optional) Select **Accounts**. If you successfully tested your connection in **Review and Test**, you can select **Preview** to display a subset of accounts from the application that will be mapped to SailPoint identities. This can help ensure you are accurately connecting identity data from the application with SailPoint identities. 10. (Optional) Select **Entitlements**. If you successfully tested your connection in **Review and Test** and your source type supports entitlement type configuration, you can select **Preview** to view a preview of entitlements using the current configuration settings. 11. When you've finished reviewing your changes and successfully tested your connection, select **Apply Migration**. Your changes will be applied to the live source and the draft source will be deleted. ## Viewing Source Migration Status You can view the status and creation date of draft sources. 1. Go to **Admin \> Connections \> Sources \> Source Migration Status**. 2. Select **Source Migration Status**. 3. To view or edit the draft source, select **Actions** ![]() **\> Preview** on the draft source. 4. To delete the draft source, select **Actions** ![]() **\> Delete** on the draft source. # 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]() ## Aggregation Error Aggregation fails for upgraded source if configured to Manage Administrator Users with the following error message: ```text java.lang.RuntimeException - openconnector.ConnectorException: [ ConnectorException ] [ Error details ] api-67efa507.duosecurity.comnull: Name or service not known ``` **Resolution**: Ensure the `adminUsersUri` attribute is correctly configured. For more information, refer to [Duo Admin User](). ## Test Connection Error Bad request timestamp Error: If any additional server is configured in a virtual appliance (VA) to pass the traffic, test connection fails with the following error: ```text Unable to connect to Duo. [ ConnectorException ] [ Error details ] Duo error code (40105): Bad request timestamp ``` Test Connection fails with the following error message when the time of the system is not synchronized: ```text Unable to connect to Duo. [ConnectorException] [Error details] Duo error code (40105): Bad request timestamp ``` **Resolution**: This is because the system's time is out of sync. Ensure that the additional server time is correctly synced with the NTP time. The timestamp of the additional server instance must be updated to the current date. # 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" } ] ```