to navigate to open Esc to close Search by Algolia

API: Set the groups of a FileRun user account

Target URL /api.php/Core/!admin/users/edit_groups
Required scope admin
HTTP Method POST
Output format JSON

Request Parameters Reference

Parameter Type Required Description
UID integer Yes The user ID
groups array No The names of the groups the account is to be a member of. Groups which do not exist are created, owned by the owner of the account.

The request replaces the group memberships of the account: the account is removed from every group it is in, then added to the groups listed. Sending no groups removes the account from all groups. Since FileRun 2026.3.0 the administrator must be allowed to manage the account.

A guest account left without any share by the change is deleted.

To add or remove a single membership without touching the others, use the group endpoints instead.

The response

The data object carries UID, the user ID, and add_to_group, an object mapping each group name to the ID of the group the account was added to.