IRPCVaultLoginsAdmin.RemoveVaultLogin
Administration API / specialized admin session
Removes a login account from the vault.
| Service | Vault login accounts MFiles.IRPCVaultLoginsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultLoginsAdmin/RemoveVaultLogin |
| HTTP (mf-http-grpc) | POST /grpc/v1/remove-vault-login |
| Request | RemoveVaultLoginRequest |
| Response | RemoveVaultLoginResponse |
| 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
- Deletes the login; it can no longer authenticate to this vault. The user account that refers
to it stays, with its
external_idcleared; remove or disable it separately with IRPCUsersAdmin. - Requires the vault right
manage_users(see the service overview for servers where vault logins are read-only for vault administrators). - An unknown account name fails with "Not found.". A login with an
external_idfails with "Access denied" ("... should be changed via Manage").
Request: RemoveVaultLoginRequest
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 |
|---|---|---|
account_name | string | The account name of the login: the user name of an M-Files login, or DOMAIN\user of a Windows login. |
Response: RemoveVaultLoginResponse
No fields.