PUT/user/{username}

Replace a user account

Replaces the stored representation of a user identified by username. Supply the user fields to apply the account, contact, credential, and status values for username; only the authenticated user can perform this operation.

1 parameter · 8 body fields
usernamestringrequired

The username identifying the user to replace.

User representation used to replace the existing user record.

idintegeroptional

The user's numeric identifier in 64-bit integer format.

usernamestringoptional

The name used to identify the user.

firstNamestringoptional

The user's first name.

lastNamestringoptional

The user's last name.

emailstringoptional

The user's email address.

passwordstringoptional

The user's password.

phonestringoptional

The user's telephone number.

userStatusintegeroptional

User Status

4 status codes
200Confirms that the user was updated successfully.
400Returned when the user replacement request is invalid.
404Returned when no user exists with the supplied username.
defaultUnexpected error

Error handling

A 400 is returned when the replacement request is invalid. A 404 is returned when no user exists with the supplied username. Values such as id and userStatus must be integers, while fields such as username and email must be strings.