Skip to content

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 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.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.