AMampache
Users

Edit a user (Admin)

Changed on

Update an existing user.

patch/users/{user_id}

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/users/{user_id}
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

Path parameters

user_idstring required

Unique identifier of the user.

Query parameters

passwordstring

Deprecated: for privacy, send this in a form or JSON request body instead of the query string (query values land in server/proxy logs and browser history). Query-string support is retained for backward compatibility.

emailstring
fullnamestring
websitestring
statestring
citystring
disable0 | 1
groupinteger
maxbitratestring

Maximum transcode bitrate for the user, in bits per second (e.g 320000 = 320Kb). API6 and older take this value in kbps.

fullname_public0 | 1
reset_apikey0 | 1
reset_streamtoken0 | 1
clear_stats0 | 1

Request body

passwordstring

Deprecated: for privacy, send this in a form or JSON request body instead of the query string (query values land in server/proxy logs and browser history). Query-string support is retained for backward compatibility.

emailstring
fullnamestring
websitestring
statestring
citystring
disable0 | 1
groupinteger
maxbitratestring

Maximum transcode bitrate for the user, in bits per second (e.g 320000 = 320Kb). API6 and older take this value in kbps.

fullname_public0 | 1
reset_apikey0 | 1
reset_streamtoken0 | 1
clear_stats0 | 1

Response

Updated

successstring

Changes

  • e8e6b266ea29Revision changes
    • info

      api operation id userEdit was added

    • info

      added optional request body

    • info

      for the path request parameter user_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 531d5bc1344eRevision changes
    • info

      query request parameter password was deprecated