User properties
In addition to names and email addresses—which are automatically populated—DX supports several core user properties that enhance personalization, reporting, and integration across the platform.
| Property | Purpose |
|---|---|
startdate |
Used to measure ramp-up time and assign users to tenure bands. This property is required for Onboarding. |
githubusername |
Associates GitHub activity with DX user records. This property is required for GitHub-based reports and PlatformX surveys. |
githubusername2 |
An additional field for instances where more than one GitHub instance exists. |
gitlabusername |
Associates GitLab activity with DX user records. This property is required for GitLab-based reports and PlatformX surveys. |
excludefromsnapshots |
If set to TRUE, excludes the user from Snapshots. |
ailightadoptiondate |
Date on which user became a light AI adopter. |
aimoderateadoptiondate |
Date on which user became a moderate AI adopter. |
aiheavyadoptiondate |
Date on which user became a heavy AI adopter. |
ssoemail |
Alternate email used to authenticate through SAML SSO. |
branch |
When snapshot branching is enabled, the branch name to which the user belongs. |
protected |
If set to TRUE, the user’s IC metrics will be de-identified. Learn more |
Setting properties
For setting GitHub usernames, please see How does DX link user identities across systems?. GitHub and GitLab username properties are matching inputs: DX uses them to automatically link accounts with the same username. You can also select multiple GitHub, GitLab, or other tool accounts for a user from the User linking page or the Linked accounts tab in Organization.
A GitHub or GitLab username can be associated with only one DX user within an account. If a User CSV upload assigns a GitHub username to User A and that username is already assigned to User B, the username will be removed from User B and assigned to User A. The same behavior applies to GitLab usernames. CSV upload and the Web API set these username properties; they do not replace selecting multiple accounts in the UI.
If your identity provider is supported by WorkOS, you can use Directory Sync through WorkOS to set mapped user properties automatically. Before configuring this path, confirm your provider appears in the WorkOS integrations list and supports SCIM/Directory Sync. DX commonly recommends this for start dates, and for GitHub or GitLab usernames only when those usernames cannot be populated automatically. For guidance, see Should I set up directory sync? and How does Directory Sync work in DX?.
For all other properties, DX offers four methods for setting properties as described below:
| Method | Description |
|---|---|
| CSV upload | Upload CSVs by browsing to the User CSVs admin area in DX. |
| Web API | Use the users.update Web API method to set properties. |
| Directory Sync (WorkOS) | Enable Directory Sync to sync mapped properties automatically from a supported provider in WorkOS. For Okta setup steps, use Okta directory sync. |
| Profile editor | DX provides a profile editor to use in onboarding checklists. |