createUser

Creates a new user on the server.

http://your-server/rest/createUser Since 1.1.0

Creates a new user on the server, using the following parameters:

Parameters

ParameterReq.OpenS.DefaultComment
usernameYesThe name of the new user.
passwordYesThe password of the new user, either in clear text of hex-encoded (see above).
emailYesThe email address of the new user.
ldapAuthenticatedNofalseWhether the user is authenicated in LDAP.
adminRoleNofalseWhether the user is administrator.
settingsRoleNotrueWhether the user is allowed to change personal settings and password.
streamRoleNotrueWhether the user is allowed to play files.
jukeboxRoleNofalseWhether the user is allowed to play files in jukebox mode.
downloadRoleNofalseWhether the user is allowed to download files.
uploadRoleNofalseWhether the user is allowed to upload files.
playlistRoleNofalseWhether the user is allowed to create and delete playlists. Since 1.8.0, changing this role has no effect.
coverArtRoleNofalseWhether the user is allowed to change cover art and tags.
commentRoleNofalseWhether the user is allowed to create and edit comments and ratings.
podcastRoleNofalseWhether the user is allowed to administrate Podcasts.
shareRoleNofalse(Since 1.8.0) Whether the user is allowed to share files with anyone.
videoConversionRoleNofalse(Since 1.15.0) Whether the user is allowed to start video conversions.
musicFolderIdNoAll folders(Since 1.12.0) IDs of the music folders the user is allowed access to. Include the parameter once for each folder.

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"
  }
}