You can upload custom attributes to enable segmentation and reporting breakdowns. In addition, certain DX products require specific user attributes to be set:
Data Cloud, PlatformX, and Onboarding require GitHub or GitLab usernames
Onboarding requires start dates
DX provides several methods for keeping user properties up-to-date. Please contact your account manager to discuss which method may be best for you.
Method 1 - CSV upload
You can upload CSVs containing user attributes from your Workspace Settings.
Method 2 - Directory sync
User properties can be imported automatically from directory providers such as Okta, Workday, and Azure AD. Contact your account representative to enable Directory Sync.
Method 3 - DX Web API
User properties can be set via request from your systems to the DX Web API. Please contact your DX account manager to obtain an API token for your account.
Example request:
curl -X POST https://api.getdx.com/users.update \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your_token_here" \
--data '{
"email": "[email protected]",
"start_date": "2024-10-31",
"github_username": "inoda"
}'
Arguments:
Name | Description |
email (required) | string - Unique identifier for the user being updated. |
start_date (optional) | string - YYYY-MM-DD date the user's employment started. |
github_username (optional) | string - The user's GitHub username |
gitlab_username (optional) | string - The user's GitLab username |
Method 4 - Profile editor
For customers that cannot or do not want to enable directory sync, DX provides a Profile Editor to be incorporated into your engineering IT onboarding checklist to make sure that new hires are set up properly in DX. When using this approach, we recommend doing an initial backfill via CSV upload.
