IRPCUsersAdmin.RemoveUser
Administration API / specialized admin session
Removes a user account from the vault.
| Service | Users MFiles.IRPCUsersAdmin |
|---|---|
| gRPC method | /MFiles.IRPCUsersAdmin/RemoveUser |
| HTTP (mf-http-grpc) | POST /grpc/v1/remove-user |
| Request | RemoveUserRequest |
| Response | RemoveUserResponse |
| 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 account and its private data: its views, notification rules, event subscriptions
and group memberships are deleted. Requires the vault rights
manage_usersandlicense_allows_modifications; removing an account with thefull_controlrole also requireschange_full_control_role. - The user stays in the Users value list (6) as a deleted item, so objects that refer to the
user keep the reference. Bring the account back with
AddUser (
USER_ACCOUNT_ADDITION_MODE_UNDELETE_OR_ADD) or UndeleteUserByGUID; the deleted views and rules do not come back. - The login account is not removed.
- An account with an
external_idcan fail with "Access denied" ("... should be deleted via Manage").
Request: RemoveUserRequest
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 account to remove. |
Response: RemoveUserResponse
No fields.
Related methods
- AddUser -- Adds a user account to the vault, or brings back a removed one.
- UndeleteUserByGUID -- Brings back a removed user account, identified by its GUID in the Users value list.