---
title: "User properties"
canonical_url: "https://docs.getdx.com/user-properties/"
md_url: "https://docs.getdx.com/user-properties.md"
last_updated: "2026-05-22"
---

# 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](https://docs.getdx.com/ic-metrics/) |


## Setting properties

For setting GitHub usernames, please see [How does DX link user identities across systems?](https://docs.getdx.com/knowledgebase/how-does-dx-link-user-identities-across-systems/). For all other properties, DX offers five 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`](https://docs.getdx.com/webapi/methods/users.update/) Web API method to set properties. |
| Okta sync | Enable [Okta directory sync](https://docs.getdx.com/okta-directory-sync/) to sync properties automatically. |
| Profile editor | DX provides a [profile editor](https://app.getdx.com/user_profiles) to use in onboarding checklists. |
| Workday RaaS | User properties can be included in [Workday RaaS](https://docs.getdx.com/workday-raas/) reports. |
---

## Sitemap

[Overview of all docs pages](/llms.txt)