IRPCUserGroupsAdmin.RemoveUserGroup
Administration API / specialized admin session
Removes a user group from the vault.
| Service | User groups MFiles.IRPCUserGroupsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCUserGroupsAdmin/RemoveUserGroup |
| HTTP (mf-http-grpc) | POST /grpc/v1/remove-user-group |
| Request | RemoveUserGroupRequest |
| Response | RemoveUserGroupResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Removes the group and its memberships. Requires the vault rights
manage_usersandlicense_allows_modifications. - The built-in groups 1 and 2 cannot be removed.
Request: RemoveUserGroupRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
id | int32 | The ID of the user group to remove. |
Response: RemoveUserGroupResponse
No fields.