public. Modify an existing user
| Name | Type | Description |
| userid | string | either an integer user ID, "current", or "=" followed by a double uri-encoded user name |
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| authpassword | string? | Password to use for verification with external authentication service |
| authusername | string? | Username to use for verification with external authentication service |
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Conflict | 409 | Username conflicts with an existing username |
| Forbidden | 403 | Administrator access or account owner is required |
| NotFound | 404 | Requested user could not be found |
| Ok | 200 | The request completed successfully |
Input:
<user>
<username>{text}</username>
<email>{text}</email>
<fullname>{text}</fullname>
<status>{active|inactive}</status>
<service.authentication id="{int}" />
<permissions.user>
<role>{text}</role>
</permissions.user>
</user>
Output:
<user id="{int}" href="{uri}">
<nick>{text}</nick>
<username>{text}</username>
<email>{text}</email>
<page.home id="{int}" href="{int}">
<title>{text}</title>
<path>{text}</path>
</page.home>
<fullname>{text}</fullname>
<status>{active|inactive}</status>
<date.lastlogin>{date}</date.lastlogin>
<service.authentication id="{int}" href="{uri]" />
<permissions.user>
<operations mask="{int}">{text}</operations>
<role id="{int}" href="{uri}">{text}</role>
</permissions.user>
<permissions.effective>
<operations mask="{int}">{text}</operations>
</permissions.effective>
<groups count="{int}" href="{uri}">
<group id="{int}" href="{uri}">
<name>{text}</name>
<service.authentication id="{int}" href="{uri}" />
<users count="{int}" href="{uri}" />
<permissions.group>
<operations mask="{int}">{text}</operations>
<role id="{int}" href="{uri}">{text}</role>
</permissions.group>
</group>
...
</groups>
</user>
Note that it is not possible to modify an existing user's authentication service.
Use PUT:users/{userid}/password to change the user password.
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
Copyright © 2011 MindTouch, Inc. Powered by