User Management on OpenSubsonic

changePassword

Mon, 01 Jan 0001 00:00:00 +0000

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

Changes the password of an existing user on the server, using the following parameters. You can only change your own password unless you have admin privileges.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`username`	Yes			The name of the user which should change its password.
`password`	Yes			The new password of the new user, either in clear text of hex-encoded (see above).

Example

http://your-server/rest/changePassword.view?username=demo&password=password&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

createUser

Mon, 01 Jan 0001 00:00:00 +0000

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

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

Parameters

Parameter	Req.	Default	Comment
`username`	Yes		The name of the new user.
`password`	Yes		The password of the new user, either in clear text of hex-encoded (see above).
`email`	Yes		The email address of the new user.
`ldapAuthenticated`	No	false	Whether the user is authenticated in LDAP.
`adminRole`	No	false	Whether the user is administrator.
`settingsRole`	No	true	Whether the user is allowed to change personal settings and password.
`streamRole`	No	true	Whether the user is allowed to play files.
`jukeboxRole`	No	false	Whether the user is allowed to play files in jukebox mode.
`downloadRole`	No	false	Whether the user is allowed to download files.
`uploadRole`	No	false	Whether the user is allowed to upload files.
`playlistRole`	No	false	Whether the user is allowed to create and delete playlists. Since 1.8.0, changing this role has no effect.
`coverArtRole`	No	false	Whether the user is allowed to change cover art and tags.
`commentRole`	No	false	Whether the user is allowed to create and edit comments and ratings.
`podcastRole`	No	false	Whether the user is allowed to administrate Podcasts.
`shareRole`	No	false	(Since 1.8.0) 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	All folders	(Since 1.12.0) IDs of the music folders the user is allowed access to. Include the parameter once for each folder.

Example

http://your-server/rest/createUser.view?username=test&password=test&email=test@test.com&name=radio&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

deleteUser

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/deleteUser Since 1.3.0

Deletes an existing user on the server, using the following parameters:

Parameters

Parameter	Req.	OpenS.	Default	Comment
`username`	Yes			The name of the user to delete.

Example

http://your-server/rest/deleteUser.view?username=test&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

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

getUser

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getUser Since 1.3.0

Get details about a given user, including which authorization roles and folder access it has. Can be used to enable/disable certain features in the client, such as jukebox control.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`username`	Yes			The name of the user to retrieve. You can only retrieve your own user unless you have admin privileges.

Example

http://your-server/rest/getUser.view?username=tata&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested user element on success.

getUsers

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getUsers Since 1.8.0

Get details about all users, including which authorization roles and folder access they have. Only users with admin privileges are allowed to call this method.

Parameters

Takes no extra parameters.

Example

http://your-server/rest/getUsers.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested users element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "users": {
 "user": [
 {
 "folder": [
 1,
 3
 ],
 "username": "sindre",
 "email": "sindre@activeobjects.no",
 "scrobblingEnabled": "true",
 "adminRole": "false",
 "settingsRole": "true",
 "downloadRole": "true",
 "uploadRole": "false",
 "playlistRole": "true",
 "coverArtRole": "true",
 "commentRole": "true",
 "podcastRole": "true",
 "streamRole": "true",
 "jukeboxRole": "true",
 "shareRole": "false"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "users": {
 "user": [
 {
 "folder": [
 1,
 3
 ],
 "username": "sindre",
 "email": "sindre@activeobjects.no",
 "scrobblingEnabled": "true",
 "adminRole": "false",
 "settingsRole": "true",
 "downloadRole": "true",
 "uploadRole": "false",
 "playlistRole": "true",
 "coverArtRole": "true",
 "commentRole": "true",
 "podcastRole": "true",
 "streamRole": "true",
 "jukeboxRole": "true",
 "shareRole": "false"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`users`	`users`	Yes		The users

updateUser

Mon, 01 Jan 0001 00:00:00 +0000

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

Modifies an existing user on the server.

Parameters

Parameter	Req.	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 authenticated 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

http://your-server/rest/updateUser.view?username=test&password=test&email=test@test.com&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.