Update user info

put

https://{server}/api/v2.1/admin/users/{user_id}/

Update one or more attributes of a user and return the updated user information. Only the parameters sent are changed.

Boolean values must be sent as strings (true/false).
Deactivating a user (is_active=false) also deletes the user's API tokens and personal library API tokens.
When is_active is sent together with keep_sharing=false, all shares from and to the user are removed.
When is_active is sent and email is configured, an activation email is sent to the user if the account is active.
reference_id and department are not supported (v13).

Permission: System admin (is_staff) whose admin role grants can_manage_user or can_update_user. Admin roles with a restricted permission set (e.g. audit_admin, system_admin) receive 403.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user_id

string

required

^[a-f0-9]{32}(@auth.local)$

The unique user id in the form [email protected]. This is not the email address of the user.

Body Params

password

string

New password.

is_staff

string

enum

Grant/revoke system admin rights.

Allowed:

is_active

string

enum

Activate/deactivate the account. Activation fails if the licensed number of users is exceeded.

Allowed:

keep_sharing

string

enum

Only evaluated together with is_active. false removes all shares of the user.

Allowed:

role

string

User role, must be one of the configured roles, e.g. default or guest.

name

string

length ≤ 64

Display name, max. 64 characters, must not contain /.

login_id

string

Unique login ID.

contact_email

string

Contact email, must be a valid email address (empty string clears it).

quota_total

integer

≥ 0

Quota in MB (>= 0).

institution

string

Name of an existing institution. Empty string removes the institution.

upload_rate_limit

integer

≥ 0

Upload rate limit in KB/s (Pro, >= 0, 0 = no limit).

download_rate_limit

integer

≥ 0

Download rate limit in KB/s (Pro, >= 0, 0 = no limit).

Responses

400

Invalid parameter (e.g. is_staff invalid., role must be in [...], name too long, login ID already exists, Contact email invalid., invalid quota or rate limit, unknown institution) or the licensed number of users is exceeded.

403

Permission denied: the account is not a system admin, or its admin role lacks the required admin permission.

404

User not found.

500

Internal server error.

Language

Credentials

Bearer

Account-Token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK