PUT
/user/{username}Update a user
Replaces the user resource identified by username with the supplied user object. Use the request body to provide the user's identity, contact, credential, and account-status values. A successful response confirms that the user resource was updated.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
usernamestringrequired
The username identifying the user to update.
Optional user object containing the replacement identity, contact, credential, and account-status values.
idintegeroptional
The user's numeric identifier.
usernamestringoptional
The user's login name.
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
200Confirms that the user resource was updated successfully.
400Returned when the update request is invalid.
404Returned when no user exists with the supplied `username`.
defaultReturned when an unexpected error occurs.
Error handling
A 400 is returned when the update request is invalid. A 404 is returned when no user exists for username; provide a username that identifies the user you want to update.