Users

Update an existing user by authId

Required scope - write_user. Assigning a privileged role (e.g. super_admin) additionally requires the caller to hold the root scope.

put/api/v1/users/{authId}

Path parameters

authIdstring required

The authId of the user

Request body

firstNamestring

lastNamestring

isActiveboolean

localestring

orgSlugstring

rolesstring[]

attributesobject

Example request

{
  "attributes": {
    "1": "value for attributeId 1",
    "2": "value for attributeId 2"
  }
}

Response

Example response

{
  "user": {
    "attributes": {
      "attribute name 1": "value for attribute name 1",
      "attribute name 2": "value for attribute name 2"
    }
  }
}

Changes

Changed in 13 of the 50 revisions of this API.19831

Apr 6, 202674c633c2da2c1See the full diff
- ○
  added the optional property user/allOf[User]/invitationExpiresAt to the response with the 200 status
  response-optional-property-added
Apr 5, 2026e8542f1e3a761See the full diff
- ○
  added the required property user/allOf[User]/isInviting to the response with the 200 status
  response-required-property-added
Jun 21, 2025abeaa4c8a1121See the full diff
- ○
  added the optional property user/allOf[subschema #2]/orgGroups to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 28, 20257991790a5a192See the full diff
- ○
  added the new optional request property attributes
  new-optional-request-property
- ○
  added the optional property user/allOf[subschema #2]/attributes to the response with the 200 status
  response-optional-property-added
May 7, 2025720da6dd028b1See the full diff
- ○
  added the new optional request property orgSlug
  new-optional-request-property
Jan 28, 202550ad4103f2271See the full diff
- ○
  added the optional property user/allOf[subschema #2]/org to the response with the 200 status
  response-optional-property-added
Dec 10, 20241956019598a71See the full diff
- ○
  added the optional property user/allOf[User]/linkedAuthId to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 3, 2024795cad873b4718See the full diff
- ○
  the response property user/allOf[User]/authId became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/createdAt became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/deletedAt became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/email became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/emailVerified became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/firstName became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/id became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/isActive became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/lastName became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/locale became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/otpVerified became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/smsPhoneNumberVerified became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/socialAccountId became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/socialAccountType became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[User]/updatedAt became required for the status 200
  response-property-became-required
- ○
  the response property user/allOf[subschema #2]/roles became required for the status 200
  response-property-became-required
- ○
  added the required property user/allOf[User]/loginCount to the response with the 200 status
  response-required-property-added
- ○
  added the required property user/allOf[User]/mfaTypes to the response with the 200 status
  response-required-property-added
Sep 26, 2024192da8a641d01See the full diff
- ○
  added the optional property user/allOf[User]/smsPhoneNumberVerified to the response with the 200 status
  response-optional-property-added
Sep 17, 20241f092af5030c12See the full diff
- ●
  removed the optional property user/allOf[User]/googleId from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property user/allOf[User]/socialAccountId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property user/allOf[User]/socialAccountType to the response with the 200 status
  response-optional-property-added

Full history (13 revisions)