users.update

Update user properties including start_date, github_username, and gitlab_username.

Facts

Property	Value
Method	`POST https://api.getdx.com/users.update`
Required scope	`users:write`

Arguments

Required arguments

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.
`email`	`Text`	The email of the user you want to update.

Optional arguments

Name	Type	Description
`start_date`	`Date`	Date formatted as YYYY-MM-DD
`github_username`	`Text`	The Github username of the user
`additional_github_username`	`Text`	Additional GitHub username
`gitlab_username`	`Text`	The Gitlab username of the user
`ai_light_adoption_date`	`Date`	Date formatted as YYYY-MM-DD
`ai_moderate_adoption_date`	`Date`	Date formatted as YYYY-MM-DD
`ai_heavy_adoption_date`	`Date`	Date formatted as YYYY-MM-DD

Example request

This is a typical request:

curl -X POST https://api.getdx.com/users.update \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

Example response

This is a typical success response:

{
  "ok": "true",
  "user": {
    "email": "user@company.com",
    "start_date": "2024-10-07",
    "github_username": "myuser",
    "gitlab_username": "myuser"
  }
}

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok param in the response.

Error	Description
`not_authed`	No authentication token provided.
`invalid_auth`	Some aspect of authentication cannot be validated.