updateUser

Modifies an existing user on the server.
Categories:

http://your-server/rest/updateUser Since 1.10.1

Modifies an existing user on the server.

Parameters

Parameter Req. OpenS. Default Comment
username Yes The name of the user.
password No The password of the user, either in clear text of hex-encoded (see above).
email No The email address of the user.
ldapAuthenticated No Whether the user is authenicated in LDAP.
adminRole No Whether the user is administrator.
settingsRole No Whether the user is allowed to change personal settings and password.
streamRole No Whether the user is allowed to play files.
jukeboxRole No Whether the user is allowed to play files in jukebox mode.
downloadRole No Whether the user is allowed to download files.
uploadRole No Whether the user is allowed to upload files.
coverArtRole No Whether the user is allowed to change cover art and tags.
commentRole No Whether the user is allowed to create and edit comments and ratings.
podcastRole No Whether the user is allowed to administrate Podcasts.
shareRole No Whether the user is allowed to share files with anyone.
videoConversionRole No false (Since 1.15.0) Whether the user is allowed to start video conversions.
musicFolderId No (Since 1.12.0) IDs of the music folders the user is allowed access to. Include the parameter once for each folder.
maxBitRate No (Since 1.13.0) The maximum bit rate (in Kbps) for the user. Audio streams of higher bit rates are automatically downsampled to this bit rate. Legal values: 0 (no limit), 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320.

Example

Result

An empty subsonic-response element on success.

{
  "subsonic-response": {
    "status": "ok",
    "version": "1.16.1",
    "type": "AwesomeServerName",
    "serverVersion": "0.1.3 (tag)",
    "openSubsonic": true
  }
}
{
  "subsonic-response": {
    "status": "ok",
    "version": "1.16.1"
  }
}
Last modified April 8, 2023: Simplify OpenSubsonic API (#30) (616a145)