Employee Attribute Mapping

Customer IT / SpaceIQ Onboarding Team

 

Each employee is represented in SiQ as a system user.  The employee object has a number of attributes that must be mapped to your internal user model.

The following table shows a list of available SiQ SCIM attributes that can be mapped to SiQ employee data.

  • SCIM Attributes - these attributes are from the SCIM Schema, refer to  System for Cross-domain Identity Management: Core Schema. Any attribute not found in the SCIM Schema that you want to use will need to be added as a custom attribute (variable).
  • SiQ Attributes - these attributes are found in SiQ.

SCIM Attributes

SiQ Attributes

Required?

Description

"name": {

"formatted"

}

name

Either name or both first_name and last_name are required.

Employee’s full name. For example:

Jon Snow

"name": {

"givenName"

}

first_name

Either name or both first_name and last_name are required.

Employee first name. For example:

Jon

"name": {

"familyName"

}

last_name

Either name or both first_name and last_name are required.

Employee last name. For example:

Snow

title title No

Employee title:

Sr. Director

userType employment_type

No

Employee employment type. For example:

Full time, Contractor, Intern, etc.

"addresses": [

{

"locality": "Mountain View",

},

location

Yes

Employee’s assigned HR location. For example:

Mountain View

"emails": [

{

"value": "{$user.email}",

"type": "work",

"primary":true

}

 

Yes

Employee’s email address. This must be unique.

"phoneNumbers": [

{

"value": "555-555-5555",
"type": "work"

},
{

"value": "555-555-4444",
"type": "mobile"

}

phone

No

Employee phone number.

Phone numbers can be an array. SiQ supports single element and multiply element array.

{

"department":

}

department_name Yes

The team (within a department) in which the employee works:
For example:
Digital Marketing

Note: The department will be defined as a department in case if neither organization nor division is available, otherwise the department will be used as a team if the organization is present.

{

"organization":

}

department_name  Yes

The department in which the employee works. 

See note above for department.

{

"division":

}

department_name Yes

The department in which the employee works. 

See note above for department.

workplace_group (custom scim attribute)

workplace_group  No

The workplace group the employee belongs to.

{

" externalId ":

}

external_id 

Yes

Employee external id represented in the external system. This is often the employee ID from your HR system. This must be unique.

{

"costCenter":

}

cost_center

 

No  Employee’s cost center name.

start_date ( custom scim attributes)

 start_date

No 

Custom Attribute

Employee employment start date from your HR system.

This can be a future date.

end_date (custom scim attribute)  end_date No 

Custom Attribute

Employee employment termination date from your HR system.

This can be a future date.

{

"manager": {
"displayName": “firstname lastname"

}

}

reporting_to No

The employee’s direct manager:

  • First Name and Last Name

OR

  • Email address
badge (custom scim attribute) badge No

Employee’s badge number.

slack_handle (custom scim attribute) slack_handle No

Employee’s slack handle.