Active Directory Connector external fields


Default and additional fields

The Active Directory Connector installation automatically loads a default configuration. However, you can sync more than just the fields included in the default configuration. Use the following default fields and additional external fields to set mappings and tasks for the Active Directory Connector in the JSON configuration. The tables provide additional information for the Active Directory Connector default fields listed in Default field mappings and Create a profile synchronization scheme. For help, see Edit the JSON configuration. You can:

  • Map Active Directory fields to your preference in Collaborate and Collaborate fields to your preferences in Active Directory.
  • Map more than one field in either direction.
Note: For an explanation of the Type, Sync direction, and Collaborate field name values in the default fields and additional fields tables see Field value descriptions. 


This table lists the Active Directory Connector default fields in the order that they appear in the Active Directory mapping.

AD field name Description Type Sync direction Collaborate field name
User.mail Primary email address String

ex2in

ex2in_on_create

contactInfo.email_main
User.name Legal or preferred name String

ex2in (recommended)

2way_in

2way_ex

general.name
User.thumbnailPhoto

Profile pic

Note: Install image management software such as Code Two on the Active Directory Server.

String

2way_in

2way_ex

images.profile
User.telephoneNumber Primary work telephone number String

2way_in

2way_ex

contactInfo.phone_work
User.mobile Mobile number String

2way_in

2way_ex

contactInfo.phone_cell
User.homePhone Home telephone number String

2way_in

2way_ex

contactInfo.phone_home
User.manager Manager String ex2in relationships.manager
User.department Department String

2way_in

2way_ex

general.department
User.title Job title String

2way_in

2way_ex

general.title



This table provides the complete list of additional external fields for the Active Directory Connector. 

AD field name Description Type Sync direction Collaborate field name
User.carLicense Automobile license plate number String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.co Country String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.comment Comment String

 

2way_in

2way_ex

bio.bio

User.company Company or organization name String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.description Description String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.displayName Display name String

2way_in

2way_ex

general.name
User.distinguishedName X500 Distinguished name
String

ex2in 

general.name
User.division Company group or division String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.employeeID Employee ID String

2way_in

2way_ex

hr.empId
User.employeeNumber Employee number String

2way_in

2way_ex

hr.empId

User.facsimileTelephoneNumber Fax number String

2way_in

2way_ex

contactInfo.phone_work_4
User.generationQualifier Generational suffix (ie: Sr., Jr., III, etc.) String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.givenName

Given name (first name)

Note: Concatenate with Sn (last name) to populate name field in Genesys Cloud.

String ex2in general.name
User.homePostalAddress Home address String

2way_in

2way_ex

contactInfo.address
User.houseIdentifier House number, Unit number, apartment, etc. String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.info Info, notes. String

2way_in

2way_ex

bio.bio
User.initials Initials for name, useful for some naming conventions String ex2in No default field for this value. Create a custom field if needed.
User.ipPhone IP phone number String

2way_in

2way_ex

contactInfo.phone_other
User.l Location String

2way_in

2way_ex

contactInfo.address
User.middleName Middlename String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.otherFacsimileTelephoneNumber Other fax number String

2way_in

2way_ex

contactInfo.phone_other
User.otherHomePhone Other home phone number String

2way_in

2way_ex

contact.info.phone_other
User.otherIpPhone Other IP phone number String

2way_in

2way_ex

contactInfo.phone_work_2.extension
User.otherLoginWorkstations Other login workstations String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.otherMailbox Other, alternate email address String

2way_in

2way_ex

contactInfo.email_other
User.otherMobile Other mobile phone number String

2way_in

2way_ex

contactInfo.phone_work_2
User.otherPager Pager number String

2way_in

2way_ex

contactInfo.phone_work_2.extension
User.otherTelephone Other telephone number String

2way_in

2way_ex

contactInfo.phone_work_3
User.pager Pager number String

2way_in

2way_ex

contactInfo.phone_work.extension
User.personalTitle Title String

2way_in

2way_ex

general.title
User.physicalDeliveryOfficeName Office location String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.postalAddress Mailing address String

2way_in

2way_ex

contactInfo.address
User.postalCode Zip or post code String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.postOfficeBox Post office box number String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.preferredDeliveryMethod Preferred delivery method String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.preferredLanguage Preferred language String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.roomNumber Room number String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.sAMAccountName LDAP name, unique in domain ex2in

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.sn

Surname (last name)

Note: Concatenate with GivenName (first name) to populate name field in Genesys Cloud.

ex2in

2way_in

2way_ex

general.name
User.st State, Province or County String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.street Street name String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.streetAddress First line of address String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.url Other web page address String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.
User.wWWHomePage Home web page address String

2way_in

2way_ex

No default field for this value. Create a custom field if needed.




This section provides descriptions for the values in the Type, Sync direction, and Collaborate field name columns in the Collaborate Connector Default fields and Additional fields tables.

Type

This table describes the data type values used in the Genesys Cloud field.

Value Description
String Use a simple string field for any Collaborate field type.
Multi-string Use in a simple string without line breaks or a multi-line string as multiple lines.
Integer Numbers only. Other values are normalized or removed.
Enum A fixed enumeration of values. May require translate functions to map the Collaborate values to the external connector values.
Byte Use for image mapping to Genesys Cloud.
Boolean True/False, Yes/No, On/Off, etc.
Tag Multi-value data type, searchable in Genesys Cloud
String array Multiple string values which can be synced with a Genesys Cloud tag field type.

Sync direction

The table describes the sync direction values for the data transfer between the Genesys Cloud field (internal) and the field in your system (external).

Value Description
ex2in Copies data from your system to Genesys Cloud. 
in2ex Copies data from Genesys Cloud to your system.*
ex2in_on_create Copies data from your system to Genesys Cloud only once to create users. Subsequent changes to your system do not synchronize to Genesys Cloud.
2way_in Copies data in both directions, but if data is changed in both locations simultaneously, Genesys Cloud wins.*
2way_ex Copies data in both directions, but if data is changed in both locations simultaneously, your system wins.*

* Genesys Cloud does not write to your system by default. To do so, you must add the update task in the JSON configuration. 

Collaborate field name

The values in the Collaborate field name column represent the most likely matches in Genesys Cloud for the Collaborate Connector fields. If the listed value does not fit, use a custom field.



Custom attributes

If you modified your Active Directory schema to include custom attributes, you can sync them to supported fields in your organization’s Genesys Cloud profile (Collaborate fields). See Configure Active Directory custom attributes in Genesys Cloud. The custom attributes table lists the readable fields in Active Directory. 

To add or modify Collaborate fields, see Change the profile configuration and Edit a user’s profile.


This table lists supported attributes generated from a typical Active Directory server, limited to attributes of type DirectoryString, DN, and OctetString. Active Directory servers set up with Lync servers or Exchange servers have longer attribute lists.

Attribute name Attribute type
cn  DirectoryString
sAMAccountName  DirectoryString
adminDescription DirectoryString
adminDisplayName  DirectoryString
altSecurityIdentities  DirectoryString
businessCategory  DirectoryString
DirectoryString
canonicalName 

DirectoryString

carLicense  DirectoryString
co  DirectoryString
comment  DirectoryString
company  DirectoryString
department  DirectoryString
departmentNumber DirectoryString
description  DirectoryString
desktopProfile DirectoryString
displayName DirectoryString
division  DirectoryString
employeeID DirectoryString
employeeNumber  DirectoryString
employeeType  DirectoryString
extensionName DirectoryString
facsimileTelephoneNumber  DirectoryString
generationQualifier 

DirectoryString

givenName DirectoryString
groupPriority   DirectoryString
groupsToIgnore Directory String
homeDirectory  DirectoryString
homeDrive  DirectoryString
homePhone DirectoryString
homePostalAddress  DirectoryString
houseIdentifier  DirectoryString
info  DirectoryString
initials DirectoryString
ipPhone  DirectoryString
jpegPhoto OctetString
l DirectoryString
mail DirectoryString
manager  DN
mhsORAddress  DirectoryString
middleName  DirectoryString
mobile  DirectoryString
msDS-cloudExtensionAttribute1 DirectoryString
msDS-cloudExtensionAttribute10  DirectoryString
msDS-cloudExtensionAttribute11  DirectoryString
msDS-cloudExtensionAttribute12 DirectoryString
msDS-cloudExtensionAttribute13 DirectoryString
msDS-cloudExtensionAttribute14 DirectoryString
msDS-cloudExtensionAttribute15 DirectoryString
msDS-cloudExtensionAttribute16  DirectoryString
msDS-cloudExtensionAttribute17  DirectoryString
msDS-cloudExtensionAttribute18 DirectoryString
msDS-cloudExtensionAttribute19 DirectoryString
msDS-cloudExtensionAttribute2 DirectoryString
msDS-cloudExtensionAttribute20 DirectoryString
msDS-cloudExtensionAttribute3  DirectoryString
msDS-cloudExtensionAttribute4 DirectoryString
msDS-cloudExtensionAttribute5  DirectoryString
msDS-cloudExtensionAttribute6 DirectoryString
msDS-cloudExtensionAttribute7  DirectoryString
msDS-cloudExtensionAttribute8 DirectoryString
msDS-cloudExtensionAttribute9 DirectoryString
name  DirectoryString
o DirectoryString
objectGUID  OctetString
otherFacsimileTelephoneNumber DirectoryString
otherHomePhone DirectoryString
otherIpPhone  DirectoryString
otherLoginWorkstations  DirectoryString
otherMailbox DirectoryString
otherMobile  DirectoryString
otherPager  DirectoryString
otherTelephone DirectoryString
ou DirectoryString
ownerBL DN
pager  DirectoryString
personalTitle DirectoryString
photo OctetString
physicalDeliveryOfficeName DirectoryString
postalAddress  DirectoryString
postalCode  DirectoryString
postOfficeBox  DirectoryString
preferredLanguage  DirectoryString
primaryInternationalISDNNumber  DirectoryString
primaryTelexNumber  DirectoryString
profilePath DirectoryString
proxyAddresses DirectoryString
roomNumber  DirectoryString
scriptPath DirectoryString
secretary  DN
seeAlso DN
servicePrincipalName  DirectoryString
sn DirectoryString
st  DirectoryString
street  DirectoryString
streetAddress  DirectoryString
telephoneNumber  DirectoryString
textEncodedORAddress DirectoryString
thumbnailLogo OctetString
thumbnailPhoto  OctetString
title DirectoryString
uid DirectoryString
url DirectoryString
userParameters  DirectoryString
userPrincipalName  DirectoryString
userSharedFolder  DirectoryString
userSharedFolderOther  DirectoryString
userWorkstations  DirectoryString
wbemPath DirectoryString
wWWHomePage DirectoryString