API: Modify FileRun user accounts
| Target URL | /api.php/Core/!admin/users/edit |
| Required scope | admin |
| HTTP Method | POST |
| Output format | JSON |
Request Parameters Reference
Besides the parameters described for adding user accounts, this API method uses also the following:
| Parameter | Type | Required | Description |
|---|---|---|---|
| UID | integer | Yes | The user ID |
| generate_password | boolean | No | Set this to generate a new password. The plain text generated password will be included in the response, as data.password. |
| notify | boolean | No | Set to 1 to have FileRun e-mail the new credentials to the user, when the username or the password changed. |
| data[userIsActive] | boolean | No | Set to 1 to activate the account, 0 to deactivate it. Left out, the account keeps its state (since 2026.3.0). |
| data[two_step_reset] | boolean | No | Set to 1 to remove the second authentication factor of the account (since 2026.3.0). |
Notes
- The endpoint rebuilds the whole permissions record from the request. A permission left out of
permsis stored as 0, so send every permission the account is meant to keep. - You cannot edit your own account, nor the System account.
- Changing the password revokes the sessions, the OAuth2 tokens and the app passwords of the account.
- Changing the role to the Guest role turns the account into a guest account, and changing it from the Guest role to another one turns it into a regular account. The licence limits and the administrator's own limits apply.
- A request which changes nothing is refused with "No changes were made!".