getUser
Get details about a given user, including which authorization roles and folder access it has.
Categories:
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.
{
"subsonic-response": {
"status": "ok",
"version": "1.16.1",
"type": "AwesomeServerName",
"serverVersion": "0.1.3 (tag)",
"openSubsonic": true,
"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",
"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 |
---|---|---|---|---|
user |
user |
Yes | The user |
Last modified December 16, 2024: Make old endpoints consistent with OG Subsonic, various bugfixes (#119) (a080a53)