URL | Requires Auth | HTTP Method |
|
|
|
Note
To save customFields
you must first define the customFields
in admin panel (Accounts -> Registration -> Custom fields)
To update the password for the user, "edit-other-user-password" permission must be set accordingly using an administrator account (Administration > Permissions).
Argument | Example | Required | Description |
|
| Required | The id of the user to update. |
|
| Optional | The email address for the user. |
|
| Optional | The display name of the user. |
|
| Optional | The password for the user. |
|
| Optional | The username for the user. |
|
| Optional
Default: | Whether the user is active, which determines if they can login or not. |
|
| Optional
Default: | The roles the user has assigned to them. |
|
| Optional
Default: | Whether the user should join the default channels. |
|
| Optional
Default: | Should the user be required to change their password when they login? |
|
| Optional
Default: | Should the user get a welcome email? |
|
| Optional
Default: | Should the user's email address be verified? |
|
| Optional
Default: | Any custom fields the user should have on their account. |
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \-H "X-User-Id: aobEdbYhXfu5hkeqG" \-H "Content-type:application/json" \http://localhost:3000/api/v1/users.update \-d '{"userId": "BsNr28znDkG8aeo7W", "data": { "name": "new name", "email": "newemail@user.tld" }}'
{"user":{"_id": "BsNr28znDkG8aeo7W","createdAt": "2016-09-13T14:57:56.037Z","services": {"password": {"bcrypt": "$2a$10$5I5nUzqNEs8jKhi7BFS55uFYRf5TE4ErSUH8HymMNAbpMAvsOcl2C"}},"username": "uniqueusername","emails": [{"address": "newemail@user.tld","verified": false}],"type": "user","status": "offline","active": true,"roles": ["user"],"_updatedAt": "2016-09-13T14:57:56.175Z","name": "new name","customFields": {"twitter": "userstwitter"}},"success": true}
Version | Description |
0.48.0 | Renamed to |
0.35.0 | Added as |