BackendService

Update User

Update a User.

patch/v1/users/{id}

Path parameters

idstring required

The User ID.

Request body

idstring

The User ID. Starts with user_....

organizationIdstring

The Organization this User belongs to.

emailstring

The User's email address.

This email is verified and unique within the Organization. Two Users in different Organizations may have the same email.

createTimestring date-time

When the User was created.

updateTimestring date-time

When the User was last updated.

ownerboolean

Whether the User is an owner of their Organization.

googleUserIdstring

The Google User ID, if the User has ever logged in with Google.

microsoftUserIdstring

The Microsoft User ID, if the User has ever logged in with Microsoft.

githubUserIdstring

The Github User ID, if the User has ever logged in with GitHub.

hasAuthenticatorAppboolean

Whether the User has an authenticator app set up.

displayNamestring

The User's human-friendly name.

profilePictureUrlstring

The URL of the User's profile picture.

Response

Changes

Changed in 5 of the 10 revisions of this API.5178

May 20, 20253ea9a7bcd4982See the full diff
- ○
  added the new optional request property githubUserId
  new-optional-request-property
- ○
  added the optional property user/allOf[User]/githubUserId to the response with the 200 status
  response-optional-property-added
May 6, 20259c3c66ced2574See the full diff
- ○
  added the new optional request property displayName
  new-optional-request-property
- ○
  added the new optional request property profilePictureUrl
  new-optional-request-property
- ○
  added the optional property user/allOf[User]/displayName to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property user/allOf[User]/profilePictureUrl to the response with the 200 status
  response-optional-property-added
Mar 11, 2025e3ac0347dfbe191See the full diff
- ▲
  the user response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ●
  removed the optional property user/createTime from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property user/email from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property user/googleUserId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property user/hasAuthenticatorApp from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property user/id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property user/microsoftUserId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property user/organizationId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property user/owner from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property user/updateTime from the response with the 200 status
  response-optional-property-removed
- ○
  added User to the user response property allOf list for the response status 200
  response-property-all-of-added
Mar 5, 2025aae16339e1e148See the full diff
- ▲
  the details/items/ response's property type/format changed from object/ to / for status 400
  response-property-type-changed
- ▲
  the details/items/ response's property type/format changed from object/ to / for status 401
  response-property-type-changed
- ▲
  the details/items/ response's property type/format changed from object/ to / for status 403
  response-property-type-changed
- ▲
  the details/items/ response's property type/format changed from object/ to / for status 404
  response-property-type-changed
- ●
  removed the optional property details/items/description from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details/items/description from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property details/items/description from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property details/items/description from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property details/items/docsLink from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details/items/docsLink from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property details/items/docsLink from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property details/items/docsLink from the response with the 404 status
  response-optional-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 4, 2025b9fc18a0eac31See the full diff
- ○
  endpoint added
  endpoint-added

Full history