SCIM Field Mapping
Here is a spreadsheet that you can use for mapping fields from your source system into Interact if you are using SCIM to import the data.
| 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 | |
| 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 don't provide value, it will default 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 toggle the user to change their password - for users that use a password to login. | true, false |
| Title | urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:name.title | No | The title eg. Mr, Mrs, Miss etc. | |
| Initials | urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:name.initials | No | The user's initials - eg. SD, DMW, TW etc. | |
| Pronouns | urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:pronouns | No | user's preferred pronoun which will be 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 the ISO time string format eg. 1990-01-23T00:00:00Z | |
| Timezone | timezone | No | Timezone for user | https://developer.interactsoftware.com/docs/valid-timezone-entries |
| Expertise | N/A | No | Supported in separate feed | https://developer.interactsoftware.com/docs/expertise-and-interests |
| Interests | N/A | No | Supported in separate feed | https://developer.interactsoftware.com/docs/expertise-and-interests |
| Picture | N/A | No | Supported in separate feed | https://developer.interactsoftware.com/docs/profile-pictures |
| Email Address | emails(type="work").value | No | type field: work, home,
mobile primary field: true, false |
|
| Alternate Email Address | emails(type="home").value or emails(type="mobile").value | No | type field: work, home,
mobile primary field: true, false |
|
| Address | addresses(type="work").formatted or addresses(type="home").formatted | No | Address in combined format (i.e. street address, city, state, zip) | |
| Home Phone Number | phoneNumbers(type="home").value | No | type field: work, home, mobile | |
| Work Phone Number | phoneNumbers(type="work").value | No | type field: work, home, mobile | |
| Mobile Phone Number | phoneNumbers(type="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 the ISO time string format eg. 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 the ISO time string format eg. 2021-04-23T00:00:00Z | |
| Job Title | title | No | ||
| Bio | urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:bio | No | user's bio/about me summary | |
| Primary Department | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department | Yes | Primary Department / Division | |
| Additional Departments | urn:ietf:params:scim:schemas:core:2.0:User:groups(type="department").value | No | ||
| Primary Location | urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:location | Yes | Primary Location / City / Office | |
| Additional Locations | urn:ietf:params:scim:schemas:core:2.0:User:groups(type="location").value | No | ||
| Primary Company | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization | Yes | Primary Organisation / Company | |
| Additional Companies | urn:ietf:params:scim:schemas:core:2.0:User:groups(type="company").value | No | ||
| urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:facebookId | No | Facebook ID for the user's profile. Please do not include the prefix https://www.facebook.com/ | ||
| urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:linkedInId | No | LinkedIn ID for the user's profile. Please do not include the prefix https://www.linkedin.com/in/ | ||
| urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:twitterTag | No | Twitter Tag for the user's profile. Please do not include the prefix https://www.twitter.com/ | ||
| urn:ietf:params:scim:schemas:extension:interactsoftware:2.0:User:instragramTag | No | Instagram Tag for the user's profile. Please do not include the prefix https://www.instagram.com/ | ||
| Skype | ims(type="skype").value | No | Instant messaging address | |
| Chat | ims(type="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 field is created, the field name will be lowercased and any spaces will be replaced with _. Eg: "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 | 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-Lat |
| Culture | locale | No | Indicates the User's default location for purposes of localizing 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="persona").value | No |
Updated 7 months ago