Customer IT / SpaceIQ Onboarding Team
Each employee is represented in SiQ as a system user. The Employee object has a number of attributes that need to 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:
Variable Name |
Required? |
Description |
| userName |
Yes |
Either name or both first_name and last_name are required. Employee’s full name : Jon Snow |
| givenName |
Yes |
Either name or both first_name and last_name is required. Employee first name: Jon |
| familyName |
Yes |
Either name or both first_name and last_name is required. Employee last name: Snow |
|
"emails": { "value": "{$user.email}", "type": "work", "primary":true } |
Yes |
Must be unique. Employee’s email address. |
| emailType |
Yes |
Primary email type |
| title | Optional |
Employee title: Sr. Director |
| primaryPhone |
Optional |
Employee phone number. |
| primaryPhoneType |
Optional |
Employee's work phone. |
| locality |
Yes |
Employee’s assigned HR location: Mountain View |
| userType |
Optional |
Employee employment type: Full time, Contractor, Intern, etc. |
| urn:ietf:params:scim:schemas: extension:enterprise:2.0:User organization (RFC rfc7643) |
Yes |
The department in which the employee works: Marketing |
| division |
Optional |
The division in which the employee works. |
|
urn:ietf:params:scim:schemas: |
Optional |
The team (within a department) in which the employee works: Digital Marketing |
| workplace_group |
Optional |
The workplace group in which the employee belongs. |
| urn:ietf:params:scim:schemas: extension:enterprise:2.0:User manager (RFC rfc7643) |
Optional |
The employee’s direct manager:
|
| location |
Optional |
Employee's state. |
| externalId | Yes |
Must be unique. Employee external id represented in the external system. This is often the employee ID from your HR system. |
|
urn:ietf:params:scim:schemas: |
Optional |
Employee employment start date from your HR system. Can be a future date. |
| urn:ietf:params:scim:schemas: extension:enterprise:2.0:User end_date ( custom scim attributes) |
Optional |
Employee employment termination date from your HR system. Can be a future date. |
| note ( custom scim attributes) |
Optional |
Notes associated with the employee. |
| urn:ietf:params:scim:schemas: extension:enterprise:2.0:User costCenter (RFC rfc7643) |
Optional |
Employee’s cost center name. |
| Sub_cost_center_name ( custom ) |
Optional |
Employee’s sub cost center name. |
| badge ( custom ) | Optional |
Employee’s badge number. |
| slack_handle (custom) | Optional |
Employee’s slack handle. |