The SCIM API is an API that allows a system external to Lattice to provision accounts and send employee information to be populated within Lattice.
The SCIM API can be enabled on the integrations page by navigating to Admin > Settings > Platform > Integrations > Enable SCIM.
The following integrations can be set up with SCIM:
Fields Available to Sync Via SCIM
For details on how to set up these fields for a specific SCIM provider, see the links above for the corresponding integrations.
Field Name in Lattice | SCIM Field Name | SCIM External Namespace | Notes |
Legal Name | name.formatted | urn:ietf:params:scim:schemas:core:2.0:User | This mapping will populate the Legal First Name and Legal Last Name fields only if the below mappings for Legal First Name and Legal Last Name are not provided. |
Legal First Name | name.givenName | urn:ietf:params:scim:schemas:core:2.0:User | If provided, this mapping will override the Legal Name mapping above. |
Legal Last Name | name.familyName | urn:ietf:params:scim:schemas:core:2.0:User | If provided, this mapping will override the Legal Name mapping above. |
Preferred full name | Lattice will concatenate name.givenName + name.familyName. | urn:ietf:params:scim:schemas:core:2.0:User | This field will only be set when a user account is first created. On future syncs/updates, it will not be changed via SCIM. |
Preferred first name | nickName | urn:ietf:params:scim:schemas:core:2.0:User | This field will only be set when a user account is first created. On future syncs/updates, it will not be changed via SCIM. |
Work Email | userName | urn:ietf:params:scim:schemas:core:2.0:User | Required and must be in a valid email address format. In most systems, this will already be mapped by default. |
External User ID | externalId | n/a | This is used as a unique identifier and will only be set upon first sync; it will be used to match the user on future syncs. |
Timezone | timezone | urn:ietf:params:scim:schemas:core:2.0:User | Must be in the 'Olson' timezone database format; e.g., 'America/Los_Angeles'. |
Birthdate | birthDate | urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User | Must be in a valid dateTime format. |
Start Date | startDate | urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User | Must be in a valid dateTime format. |
Job Title | title | urn:ietf:params:scim:schemas:core:2.0:User |
|
Manager | manager.value | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User | Note: this must be the manager's email address, not their name. |
Department | department | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User |
|
Gender | gender | urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User | The only accepted values are case-sensitive "male", "female", and "non_binary". |
In addition to these default fields, any custom fields created in Lattice can be synced via SCIM.
Field Name in Lattice | SCIM Field Name | SCIM External Namespace | Notes |
[Any custom field name] For example: "Office Location" | field name converted to camelCase For example: officeLocation | urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User |
|
Note: For date fields, we use the ISO 8601 format; therefore, all dates must be in YYYY-MM-DD.
Fields Unavailable to Sync via SCIM
The following default fields in Lattice do not exist in the SCIM schema and cannot be updated via SCIM syncs. If SCIM is your primary data source for Lattice, these fields must be uploaded via CSV or entered directly into Lattice.
all Job Architecture fields:
Job Level
Job Function
Job Type
all Compensation fields:
Pay Zone
Base Pay Amount
Base Pay Currency
Base Pay Effective Date
Base Payment Type (also referenced as just Pay Type)
Variable Pay Amount
Bonus Plan Amount (also referenced as just Bonus Amount)
any Equity-related fields
Middle Name
Pronouns
Ethnicity
Sexual Orientation
Phone Number (note: the Sapling SCIM sync includes phone number by default, but most major SCIM providers do not support syncing phone number)