GuidesAPI Reference
Guides

SCIM Field Mapping

Below are the mapping fields from your source system into Interact if you are using SCIM to import the data. They follow the RFC 7644 bracket syntax

User Profile Fields

These are the fields available within a User Profile within Interact

Field LabelField NameRequiredDescriptionPossible Values
Unique ID fieldexternalIdYes
User NameuserNameYesUnique identifier for the User
ActiveactiveYestrue, false
Hide Profileurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:omitFromSearchNotrue, false
PasswordpasswordNo
Surnamename.familyNameYesLast Name
First Namename.givenNameYes
Authentication Typeurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:loginTypeYespreferred login methodSAML, Local Login, Windows Login
Profile TypeuserTypeNoType of user. If you don't provide value, it will default to "Intranet User"Power User, Intranet User, Non Intranet User
Forced Password Reseturn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:forcePasswordResetNoFlag to toggle the user to change their password - for users that use a password to login.true, false
Titleurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:name.titleNoThe title eg. Mr, Mrs, Miss etc.
Initialsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:name.initialsNoThe user's initials - eg. SD, DMW, TW etc.
Pronounsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:pronounsNouser's preferred pronoun which will be displayed on their profile
Date of Birthurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:dateOfBirthNoThe User's date of birth, in the ISO time string format eg. 1990-01-23T00:00:00Z
TimezonetimezoneNoTimezone for userhttps://developer.interactsoftware.com/docs/valid-timezone-entries
ExpertiseN/ANoSupported in separate feedhttps://developer.interactsoftware.com/docs/expertise-and-interests
InterestsN/ANoSupported in separate feedhttps://developer.interactsoftware.com/docs/expertise-and-interests
PictureN/ANoSupported in separate feedhttps://developer.interactsoftware.com/docs/profile-pictures
Email Addressemails[type eq "work"].valueNotype field: work, home, mobile
primary field: true, false
Alternate Email Addressemails[type eq "home"].value or
emails[type eq "mobile"].value (with clarifying note)		Notype field: work, home, mobile
primary field: true, false
Addressaddresses[type eq "work"].formatted or
addresses[type eq "home"].formatted (with clarifying note)		NoAddress in combined format (i.e. street address, city, state, zip)
Home Phone NumberphoneNumbers[type eq "home"].valueNotype field: work, home, mobile
Work Phone NumberphoneNumbers[type eq "work"].valueNotype field: work, home, mobile
Mobile Phone NumberphoneNumbers[type eq "mobile"].valueNotype field: work, home, mobile
FacsimileN/ANoNot Supported in SCIM
ExtensionN/ANoNot Supported in SCIM
Managerurn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.valueNoThe accepted commonly used identifiers are: primary/work email, username, externalId.
Job Start Dateurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:jobStartDateNoThe User's job start date, in the ISO time string format eg. 2021-01-23T00:00:00Z
Job End Dateurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:jobEndDateNoThe User's job end date, in the ISO time string format eg. 2021-04-23T00:00:00Z
Job TitletitleNo
Biourn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:bioNouser's bio/about me summary
Primary Departmenturn:ietf:params:scim:schemas:extension:enterprise:2.0:User:departmentYesPrimary Department / Division
Additional Departmentsurn:ietf:params:scim:schemas:core:2.0:User:groups[type eq "department"].valueNo
Primary Locationurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:locationYesPrimary Location / City / Office
Additional Locationsurn:ietf:params:scim:schemas:core:2.0:User:groups[type eq "location"].valueNo
Primary Companyurn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organizationYesPrimary Organisation / Company
Additional Companiesurn:ietf:params:scim:schemas:core:2.0:User:groups[type eq "company"].valueNo
Facebookurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:facebookIdNoFacebook ID for the user's profile. Please do not include the prefix https://www.facebook.com/
LinkedInurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:linkedInIdNoLinkedIn ID for the user's profile. Please do not include the prefix https://www.linkedin.com/in/
Twitterurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:twitterTagNoTwitter Tag for the user's profile. Please do not include the prefix https://www.twitter.com/
Instagramurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:instragramTagNoInstagram Tag for the user's profile. Please do not include the prefix https://www.instagram.com/
Skypeims[type eq "skype"].valueNoInstant messaging address
Chatims[type eq "chat"].valueNoInstant messaging address
Additional Fieldsprefix is "urn:ietf:params:scim:schemas:extension:interactsoftwareadditionalfields:2.0:User:" then <field name>NoDo not use special characters (except space) when creating additional fields. Once field is created, the field name will be lowercased and any spaces will be replaced with _. Eg: "Employee ID" becomes "employee_id"
ThemeN/ANo
Home PageN/ANo
Activate an Onboarding homepage for this UserN/ANo
Preferred LanguagepreferredLanguageNoUser's preferred written or spoken languageen-GB, en-US, ar, zh-CN, zh, cs, da, nl, fi, fr, de, he, id, it, ja, ko, pl, pt, ru, es, sv, tr, af, bg, bn, bs, ca, cy, el, et, fa, fil, fj, hi, hr, ht, hu, is, lt, lv, mg, ms, mt, mww, nb, otq, ro, sk, sl, sm, sw, ta, te, th, to, ty, uk, ur, vi, yue, sr-Cyrl, sr-Lat
CulturelocaleNoIndicates the User's default location for purposes of localizing items such as currency, date time format, or numerical representationsen-GB, en-US
Person IDN/ANoNumerical system field generated by Interact. Value seen in URL as id=<value>
Not mapped in Interact UIprofileURLNoA fully qualified URL pointing to a page representing the User's online profile.
Personaurn:ietf:params:scim:schemas:core:2.0:User:groups[type eq "persona"].valueNo

Groups

Within Interact is it possible to create Groups, these can be Locations, Companies and Security Groups. Generally within SCIM processing from systems like Entra ID the groups updated will be Security Groups, but it is possible to use the SCIM endpoint to update the other groups, as shown in SCIM Package Examples

The following fields are available for all the above group types:

Field LabelField NameRequiredDescriptionPossible Values
NamedisplayNameYesName of the Location, Department, Company or Security Group
MembersmembersNoCan contain a JSON array of members of the group, see below for details
GroupTypeurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:groupTypeYesGroup Typelocation, department, company, group
📘

The following Groups can be updated via SCIM API Endpoint

For Location and Company additional fields can be update via the SCIM Endpoint

Location Fields

These fields are available to for the group Locations

Field LabelField NameRequiredDescriptionPossible Values
Additional Display Nameurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:additionalDisplayNameNoSecondary display name of location
Addressurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:addressNoAddress of location
Cityurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:cityNoCity
Countryurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:countryNoCountry
Currencyurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:currencyNoCurrency of Location as shortcodeGBP, USD, AED for example
Daylight Savings Timeurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:daylightsavingtimeNoEnable Daylight Savings for Locationtrue/false
Descriptionurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:descriptionNoDescription of the location
Display Detailsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:displayDetailsNoDisplay Details on the User Profile pagetrue/false
Emailurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:emailNoEmail address for the location
Enable Mentioningurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:enableMentioningNoAllows the Location to be @Mentionedtrue/false
Exclude from Analyticsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:excludeFromAnalyticsNoExcludes the location from Analyticstrue/false
Indentifierurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:indentifierNoIdentifier field
Keywordsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:keywordsNoComma seperated list of Keywords for the location
Mapurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:mapNoGoogle Map URL to the location.
Opening Hoursurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:openingHoursNoText field for location opening our or similar information
Phoneurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "phone"].valueNoLocaiton Phone Number
Faxurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "fax"].valueNoFax Number
Alternative Phoneurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "alternativePhone"].valueNoAlternative Phone Number
Alternative Faxurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "alternativeFax"].valueNoAlternative Fax Number
Post Codeurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:postCodeNoPostal / Zip Code
Regionurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:regionNoRegion or Area
Send Notificationurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:sendNotificationNoAllows Notification to be sent when @Mention is enabledtrue/false
Stateurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:stateNoState or County
TimeZoneurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:timezoneNoTimezonehttps://developer.interactsoftware.com/docs/valid-timezone-entries
Urlurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:urlNoURL of the Location
Vat Numberurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:vatNumberNoText field for Vat Number
Primary Contacturn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:primaryContact.valueNoPerson ID of the Primary Contact
Additional Contactsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:additionalContactsNoArray of Additional ContactsSee the Members Array details below

Company

These fields are available to for the group Company

Field LabelField NameRequiredDescriptionPossible Values
Additional Display Nameurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:additionalDisplayNameNoSecondary display name of location
Addressurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:addressNoAddress of location
Cityurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:cityNoCity
Countryurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:countryNoCountry
Currencyurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:currencyNoCurrency of Location as shortcodeGBP, USD, AED for example
Daylight Savings Timeurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:daylightsavingtimeNoEnable Daylight Savings for Locationtrue/false
Descriptionurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:descriptionNoDescription of the location
Display Detailsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:displayDetailsNoDisplay Details on the User Profile pagetrue/false
Emailurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:emailNoEmail address for the location
Enable Mentioningurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:enableMentioningNoAllows the Location to be @Mentionedtrue/false
Exclude from Analyticsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:excludeFromAnalyticsNoExcludes the location from Analyticstrue/false
Indentifierurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:indentifierNoIdentifier field
Keywordsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:keywordsNoComma seperated list of Keywords for the location
Mapurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:mapNoGoogle Map URL to the location.
Opening Hoursurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:openingHoursNoText field for location opening our or similar information
Phoneurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "phone"].valueNoLocaiton Phone Number
Faxurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "fax"].valueNoFax Number
Alternative Phoneurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "alternativePhone"].valueNoAlternative Phone Number
Alternative Faxurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "alternativeFax"].valueNoAlternative Fax Number
Post Codeurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:postCodeNoPostal / Zip Code
Regionurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:regionNoRegion or Area
Send Notificationurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:sendNotificationNoAllows Notification to be sent when @Mention is enabledtrue/false
Stateurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:stateNoState or County
TimeZoneurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:timezoneNoTimezonehttps://developer.interactsoftware.com/docs/valid-timezone-entries
Urlurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:urlNoURL of the Location
Vat Numberurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:vatNumberNoText field for Vat Number
Primary Contacturn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:primaryContact.valueNoPerson ID of the Primary Contact
Additional Contactsurn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:additionalContactsNoArray of Additional ContactsSee the Members Array details below

Membership Array

As shown in the example payload, a JSON array in the Payload can be used to added User Profiles to the Membership of the above groups and the additional contacts. This array can contain the following values:

Field NameDescriptionRequiredExample Values
$refReference of the record, for users this will be Users/PersonIdNo"Users/1234"
displayDisplay NameNo
typeType of Member (User)NoUser
valuePersonId of the User to addYesPersonID

As an example, this it the member payload

"members":[
        {
            "$ref": "Users/35069",
            "display": "David Wilson",
            "type": "User",
            "value": "35069"
        }
  ],

The only required field in the value

Updated 5 days ago