User groups (IRPCUserGroupsAdmin)
Adds, reads, modifies and removes the user groups of a vault and their members.
Use this interface to add, modify and delete user groups in a vault.
A user group consists of members. A member can be a user account or another user group. A special type of user group is a Windows Group that refers to an existing Windows local or global group. The members of a Windows Group are not defined in the vault database but are instead queried from Windows whenever needed.
| gRPC service | MFiles.IRPCUserGroupsAdmin |
|---|---|
| Book and level | Administration API, specialized |
| Methods | 12 |
| Proto file | mfiles/IRPCUserGroupsAdmin.proto |
Overview
M-Files Admin uses this service for the User groups node of a vault and for importing Windows
groups. All methods need a vault session whose user has the vault right manage_users
(VaultAccess); the write methods also need
license_allows_modifications.
- Members.
UserGroup.user_group.memberslists user account IDs as positive numbers and member groups as negative numbers (group 102 is -102). The same convention applies tomember_idof AddMemberToUserGroup and RemoveMemberFromUserGroup. - Built-in groups. 1 "All internal users" and 2 "All internal and external users" are
returned with empty
members: their membership follows from the users'is_internal_userrole. They can be renamed but not given members or removed. - External Windows groups (
is_external_windows_group) mirror a group of the domain directory. SyncExternalWindowsGroup updates their members; GetUserGroupSyncStatus reports the last synchronization. - Group types. Besides normal groups (
USER_GROUP_TYPE_NORMAL), a vault can have groups that represent users and groups of an external repository. GetUserGroupsAdmin returns normal groups only; GetUserContainersAdmin returns all types.
Methods by task:
- Read: GetUserGroupsAdmin, GetUserGroupAdmin, GetUserContainersAdmin, GetChangedUserGroups.
- Add, change, remove: AddUserGroup, AddOrUndeleteUserGroup, ModifyUserGroup, RemoveUserGroup.
- Change one membership without sending the whole group: AddMemberToUserGroup, RemoveMemberFromUserGroup.
Users without manage_users read groups with
GetUserGroups of
IRPCVault. Users are managed with
IRPCUsersAdmin.
Methods
| Method | Summary | Facts |
|---|---|---|
| AddMemberToUserGroup | Adds one user or group to a user group, if it is not a member yet. | admin session |
| AddOrUndeleteUserGroup | Adds a user group, or brings back a removed group with the same name. | admin session |
| AddUserGroup | Adds a user group to the vault. | admin session |
| GetChangedUserGroups | Gets the user groups that were added, changed or removed after a version token. | admin session |
| GetUserContainersAdmin | Gets all user groups of the vault, including the groups that represent external repository users and groups. | admin session idempotent |
| GetUserGroupAdmin | Gets one user group of any type, with its members. | admin session |
| GetUserGroupsAdmin | Gets all normal user groups of the vault, with their members. | admin session |
| GetUserGroupSyncStatus | Gets the result of the last synchronization of an external Windows group. | admin session |
| ModifyUserGroup | Replaces the data and members of an existing user group. | admin session idempotent |
| RemoveMemberFromUserGroup | Removes one user or group from a user group, if it is a member. | admin session |
| RemoveUserGroup | Removes a user group from the vault. | admin session |
| SyncExternalWindowsGroup | Updates the members of an external Windows group from the domain directory. | admin session idempotent |