Home›User provisioning›SCIM field mapping

SCIM field mapping

Reference for mapping fields from your source system into Interact user and group profiles when provisioning via SCIM.

Overview

The tables below list the fields you can map from your source system into Interact when you use SCIM to import data. They follow the RFC 7644 bracket syntax.

Note: Full endpoint details live in the API Reference. The tables on this page are field-level mapping reference.

User profile fields

These fields are available within a user profile in Interact.

Field label Field name Required Description Possible values
Unique ID field externalId Yes
User Name userName Yes Unique identifier for the user
Active active Yes true, false
Hide Profile urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:omitFromSearch No true, false
Password password No
Surname name.familyName Yes Last name
First Name name.givenName Yes
Authentication Type urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:loginType Yes Preferred login method SAML, Local Login, Windows Login
Profile Type userType No Type of user. If you do not provide a value, it defaults to Intranet User Power User, Intranet User, Non Intranet User
Forced Password Reset urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:forcePasswordReset No Flag to force the user to change their password (for users that log in with a password) true, false
Title urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:name.title No The title, for example Mr, Mrs, Miss
Initials urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:name.initials No The user's initials, for example SD, DMW, TW
Pronouns urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:pronouns No The user's preferred pronoun, displayed on their profile
Date of Birth urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:dateOfBirth No The user's date of birth, in ISO time string format, for example 1990-01-23T00:00:00Z
Timezone timezone No Timezone for the user See Valid timezone entries
Expertise N/A No Supported in a separate feed See Expertise and interests
Interests N/A No Supported in a separate feed See Expertise and interests
Picture N/A No Supported in a separate feed See Profile pictures
Email Address emails[type eq "work"].value No type field: work, home, mobile; primary field: true, false
Alternate Email Address emails[type eq "home"].value or emails[type eq "mobile"].value (with clarifying note) No type field: work, home, mobile; primary field: true, false
Address addresses[type eq "work"].formatted or addresses[type eq "home"].formatted (with clarifying note) No Address in combined format (street address, city, state, zip)
Home Phone Number phoneNumbers[type eq "home"].value No type field: work, home, mobile
Work Phone Number phoneNumbers[type eq "work"].value No type field: work, home, mobile
Mobile Phone Number phoneNumbers[type eq "mobile"].value No type field: work, home, mobile
Facsimile N/A No Not supported in SCIM
Extension N/A No Not supported in SCIM
Manager urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value No The accepted commonly used identifiers are: primary/work email, username, externalId
Job Start Date urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:jobStartDate No The user's job start date, in ISO time string format, for example 2021-01-23T00:00:00Z
Job End Date urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:jobEndDate No The user's job end date, in ISO time string format, for example 2021-04-23T00:00:00Z
Job Title title No
Bio urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:bio No The user's bio or about-me summary
Primary Department urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department Yes Primary department or division
Additional Departments urn:ietf:params:scim:schemas:core:2.0:User:groups[type eq "department"].value No
Primary Location urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:location Yes Primary location, city or office
Additional Locations urn:ietf:params:scim:schemas:core:2.0:User:groups[type eq "location"].value No
Primary Company urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization Yes Primary organisation or company
Additional Companies urn:ietf:params:scim:schemas:core:2.0:User:groups[type eq "company"].value No
Facebook urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:facebookId No Facebook ID for the user's profile. Do not include the prefix https://www.facebook.com/
LinkedIn urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:linkedInId No LinkedIn ID for the user's profile. Do not include the prefix https://www.linkedin.com/in/
Twitter urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:twitterTag No Twitter tag for the user's profile. Do not include the prefix https://www.twitter.com/
Instagram urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:instragramTag No Instagram tag for the user's profile. Do not include the prefix https://www.instagram.com/
Skype ims[type eq "skype"].value No Instant messaging address
Chat ims[type eq "chat"].value No Instant messaging address
Additional Fields Prefix is urn:ietf:params:scim:schemas:extension:interactsoftwareadditionalfields:2.0:User: then <field name> No Do not use special characters (except space) when creating additional fields. Once a field is created, the field name is lower-cased and any spaces are replaced with _. For example, Employee ID becomes employee_id
Theme N/A No
Home Page N/A No
Activate an Onboarding homepage for this User N/A No
Preferred Language preferredLanguage No The user's preferred written or spoken language en-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-Latn
Culture locale No The user's default locale for localising items such as currency, date-time format or numerical representations en-GB, en-US
Person ID N/A No Numerical system field generated by Interact. Value seen in URL as id=<value>
Not mapped in Interact UI profileURL No A fully qualified URL pointing to a page representing the user's online profile
Persona urn:ietf:params:scim:schemas:core:2.0:User:groups[type eq "persona"].value No

Groups

In Interact you can create groups: locations, companies and security groups. When processing SCIM from systems like Microsoft Entra ID, the groups updated are usually security groups, but you can also 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 label Field name Required Description Possible values
Name displayName Yes Name of the location, department, company or security group
Members members No Can contain a JSON array of group members. See Membership array
GroupType urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:groupType Yes Group type location, department, company, group

Note: For Location and Company groups, additional fields can be updated via the SCIM endpoint.

Location fields

These fields are available for Location groups.

Field label Field name Required Description Possible values
Additional Display Name urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:additionalDisplayName No Secondary display name of the location
Address urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:address No Address of the location
City urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:city No City
Country urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:country No Country
Currency urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:currency No Currency of the location as a shortcode For example GBP, USD, AED
Daylight Savings Time urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:daylightsavingtime No Enable daylight saving time for the location true/false
Description urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:description No Description of the location
Display Details urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:displayDetails No Display details on the user profile page true/false
Email urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:email No Email address for the location
Enable Mentioning urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:enableMentioning No Allows the location to be @mentioned true/false
Exclude from Analytics urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:excludeFromAnalytics No Excludes the location from analytics true/false
Identifier urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:indentifier No Identifier field
Keywords urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:keywords No Comma-separated list of keywords for the location
Map urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:map No Google Map URL for the location
Opening Hours urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:openingHours No Text field for location opening hours or similar information
Phone urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "phone"].value No Location phone number
Fax urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "fax"].value No Fax number
Alternative Phone urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "alternativePhone"].value No Alternative phone number
Alternative Fax urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "alternativeFax"].value No Alternative fax number
Post Code urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:postCode No Postal or zip code
Region urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:region No Region or area
Send Notification urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:sendNotification No Allows a notification to be sent when @mention is enabled true/false
State urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:state No State or county
TimeZone urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:timezone No Timezone See Valid timezone entries
Url urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:url No URL of the location
Vat Number urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:vatNumber No Text field for VAT number
Primary Contact urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:primaryContact.value No Person ID of the primary contact
Additional Contacts urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:additionalContacts No Array of additional contacts See Membership array

Company fields

These fields are available for Company groups.

Field label Field name Required Description Possible values
Additional Display Name urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:additionalDisplayName No Secondary display name
Address urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:address No Address
City urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:city No City
Country urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:country No Country
Currency urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:currency No Currency as a shortcode For example GBP, USD, AED
Daylight Savings Time urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:daylightsavingtime No Enable daylight saving time true/false
Description urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:description No Description
Display Details urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:displayDetails No Display details on the user profile page true/false
Email urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:email No Email address
Enable Mentioning urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:enableMentioning No Allows the company to be @mentioned true/false
Exclude from Analytics urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:excludeFromAnalytics No Excludes the company from analytics true/false
Identifier urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:indentifier No Identifier field
Keywords urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:keywords No Comma-separated list of keywords
Map urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:map No Google Map URL
Opening Hours urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:openingHours No Text field for opening hours or similar information
Phone urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "phone"].value No Phone number
Fax urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "fax"].value No Fax number
Alternative Phone urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "alternativePhone"].value No Alternative phone number
Alternative Fax urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:phoneNumbers[type eq "alternativeFax"].value No Alternative fax number
Post Code urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:postCode No Postal or zip code
Region urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:region No Region or area
Send Notification urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:sendNotification No Allows a notification to be sent when @mention is enabled true/false
State urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:state No State or county
TimeZone urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:timezone No Timezone See Valid timezone entries
Url urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:url No URL
Vat Number urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:vatNumber No Text field for VAT number
Primary Contact urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:primaryContact.value No Person ID of the primary contact
Additional Contacts urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:Group:additionalContacts No Array of additional contacts See Membership array

Membership array

As shown in the example payload, a JSON array in the payload can add user profiles to the membership of the above groups and to the additional contacts. This array can contain the following values.

Field name Description Required Example values
$ref Reference of the record. For users this is Users/PersonId No "Users/1234"
display Display name No
type Type of member (User) No User
value Person ID of the user to add Yes PersonID

The following is an example member payload. The only required field is value.

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