IRPCVaultLoginsAdmin.ForceLogoutVaultLoginSessions
Administration API / specialized admin session
Logs out all sessions of the given login accounts in this vault.
| Service | Vault login accounts MFiles.IRPCVaultLoginsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultLoginsAdmin/ForceLogoutVaultLoginSessions |
| HTTP (mf-http-grpc) | POST /grpc/v1/force-logout-vault-login-sessions |
| Request | ForceLogoutVaultLoginSessionsRequest |
| Response | ForceLogoutVaultLoginSessionsResponse |
| 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
- Ends the sessions immediately; their clients must log in again. Only sessions to the caller's vault are affected.
- Requires the vault right
manage_users. Find logged-in accounts with GetVaultLoginsWithSessions.
Request: ForceLogoutVaultLoginSessionsRequest
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_names[] | repeated string | The account names of the logins whose sessions to end. |
Response: ForceLogoutVaultLoginSessionsResponse
No fields.
Related methods
- GetVaultLoginsWithSessions -- Gets the login accounts that currently have sessions to this vault.