IRPCUserGroupsAdmin.ModifyUserGroup
Administration API / specialized admin session idempotent
Replaces the data and members of an existing user group.
| Service | User groups MFiles.IRPCUserGroupsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCUserGroupsAdmin/ModifyUserGroup |
| HTTP (mf-http-grpc) | POST /grpc/v1/modify-user-group |
| Request | ModifyUserGroupRequest |
| Response | ModifyUserGroupResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires the vault rights
manage_usersandlicense_allows_modifications. - Send the complete group: read it with
GetUserGroupAdmin, change what you need
and send it back.
membersreplaces the old member list. To add or remove one member, use AddMemberToUserGroup or RemoveMemberFromUserGroup. - The built-in groups 1 and 2 can be renamed, but their
membersmust be empty.
Request: ModifyUserGroupRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.
| Field | Type | Description |
|---|---|---|
usergroup | UserGroup | The complete new data of the group; user_group.id identifies the group. |
usergroup.user_group | UserGroupBasic | The basic data of the group. |
usergroup.user_group.id | int32 | The ID of the user group. |
usergroup.user_group.name | string | The name of the group. |
usergroup.user_group.members[] | repeated int32 | The IDs of the members of this group (user accounts and/or user groups). |
usergroup.user_group.type | UserGroupType | User group type.Values: USER_GROUP_TYPE_NORMAL (0), USER_GROUP_TYPE_REPOSITORY_USER (1), USER_GROUP_TYPE_REPOSITORY_GROUP (2), USER_GROUP_TYPE_ANY (-1). |
usergroup.is_external_windows_group | bool | Is group imported from Windows domain. |
usergroup.synchronize_memberships | bool | Should memberships of this group be synchronized automatically. |
usergroup.license_type_for_new_logins | LicenseType | Type of the license for logins created automatically.Values: LICENSE_TYPE_NONE (0), LICENSE_TYPE_NAMED_USER_LICENSE (1), LICENSE_TYPE_CONCURRENT_USER_LICENSE (2), LICENSE_TYPE_READ_ONLY_LICENSE (3), LICENSE_TYPE_VISITOR_LICENSE (4). |
usergroup.external_group_name | string | The name for external group. Empty if the group is not external. |
usergroup.organizational_unit | string | The organizational unit for filtering the AD group searches. Empty if the group is not external. |
usergroup.acl | AccessControlList | Permissions. |
usergroup.acl.checked_out_to_user | int32 | Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist. |
usergroup.acl.is_fully_authoritative | bool | Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version. |
usergroup.acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
usergroup.acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
usergroup.acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
usergroup.acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
usergroup.aliases | string | Semicolon-separated list of semantic aliases. |
usergroup.import_mode | ExternalGroupImportMode | Import mode for external groups.Values: EXTERNAL_GROUP_IMPORT_MODE_UNDEFINED (0), EXTERNAL_GROUP_IMPORT_MODE_DIRECT_USERS (1), EXTERNAL_GROUP_IMPORT_MODE_DIRECT_AND_NESTED_USERS (2). |
usergroup.external_repository_name | string | External repository name. unset if this group doesn't represent external repository user information. |
usergroup.external_repository_subject_id | string | ID in the external repository. unset if this group doesn't represent external repository user information. |
Response: ModifyUserGroupResponse
No fields.
Related methods
- GetUserGroupAdmin -- Gets one user group of any type, with its members.
- AddMemberToUserGroup -- Adds one user or group to a user group, if it is not a member yet.
- RemoveMemberFromUserGroup -- Removes one user or group from a user group, if it is a member.