# SailPoint Duo SaaS Connector Documentation > Duo SaaS 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 | | Pending Activation | Disabled | # Connecting SailPoint and Duo SaaS 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. (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](). 4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 5. 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. (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](). 5. 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](). 6. 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. (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](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (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](). 6. (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. 7. 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 Duo Users** to manage Duo users as accounts. > **Note** > > Manage Duo Users is enabled by default for the new sources. 2. Enable **Manage Duo Administrators** to manage Duo Administrators as accounts. ### Page Size Settings > [!NOTE] > > **Screenshot** > > [![Page Size Settings]()]() 1. Enter the **End Users Page Size** value. Default: 100, Maximum value: 300. 2. Enter the **Groups Page Size** value. Default: 100, Maximum value: 100. 3. Enter the **Administrator Users Page Size** value. Default: 100, Maximum value: 500. 4. Select **Save**. ## Activity Insights Settings SailPoint pulls in activity data in the form of events like user logins, password changes, and content updates within the application. You can view an identity’s activity data within an application to discover trends for that user. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on utilizing activity data, refer to [Activity Insights](). Activity Insights Settings allows you to gather account information and activity data from Duo. To enable Activity Insights for the Duo application, refer to [Prerequisites]() for more information. To configure Activity Insights, complete the following: > [!NOTE] > > **Screenshot** > > [![Activity Insights Settings]()]() 1. Go to **Activity Insights Settings**. 2. Select **Enable Activity Insights** to view access to data insights on source and application activity such as logins and other app-specific events. 3. Select **Save**. Ensure the Duo application has the necessary scopes to utilize Activity Insights. Refer to [Required Permissions]() for the requested scopes for Activity Insights from Duo. ### User Metadata Activity Insights pulls the following user metadata from Duo: | Field | Description | | --- | --- | | Groups | The groups the user belongs to in Duo. | | Status | The user's status in Duo. For example, a user's status can be `Active`, `Disabled`, or `Locked out`. | ## 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 SaaS 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 SaaS. > [!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 - 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](). ### Activity Insights Activity Insights supports activity from Duo and its associated accounts. This allows you to gather account information and activity data from Duo. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on configuring Activity Insights, refer to Activity Insights Settings. 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](). ## Required Permissions > [!NOTE] > > You must have the Owner role to create or modify an API application within the Duo Admin panel. 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. ### For Activity Insights An administrator requires the following permission to utilize Activity Insights: | Scope | Description | | --- | --- | | Grant read log | The Admin API application can read authentications, offline access, telephony, and administrator action log information. | For more information on configuring Activity Insights, refer to [Activity Insights Settings](). # 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 | Label | Type | Required | Initial Value | | --- | --- | --- | --- | --- | | user\_type | user\_type | string | Yes | static | | username | username | string | Yes | static | | name | name | string | Yes | static | | email | email | string | Yes | static | | phones | phones | string | No | disable | | realname | realname | string | No | disable | | role | role | string | No | disable | 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 SaaS 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. # 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 SaaS connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the Duo SaaS source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | username | Equals | Username | | email | Equals | Work email | ## 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 SaaS 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 | | administrative units | The administrator unit assignments. | ### 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 SaaS 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. | # 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]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](). ## Aggregation Error Aggregation fails for source if configured to Manage Duo Administrators 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]().