Sign in
Admin

Update a user (admin)

Changed on

Update a user's role, bookmark quota, storage quota, or browser crawling setting. Requires admin role. You cannot update your own user account via this endpoint.

put/admin/users/{userId}

Request

  • Base URL: https://try.karakeep.app/api/v1
  • URL: https://try.karakeep.app/api/v1/admin/users/{userId}
  • Auth: HTTP bearer

Path parameters

userIdstring required

The ID of the user to update.

Example:user_123

Request body

role'user' | 'admin'
bookmarkQuotainteger nullable
storageQuotainteger nullable
browserCrawlingEnabledboolean nullable

Example request

{
  "role": "admin",
  "bookmarkQuota": 1000,
  "storageQuota": 5000000000
}

Response

User updated successfully.

successboolean required

Whether the update was successful.

Changes

  • 6210da080616Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      api operation id adminUpdateUser was added

    • info

      added the media type text/plain for the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • f73fc965ff1bRevision changes
    • info

      added the new optional request property