IRPCVaultsAdmin.CheckForOpenSessions
Administration API / specialized admin session idempotent
Checks whether users have open sessions to a vault: succeeds if there are none and fails with a list of the sessions otherwise.
| Service | Vault management MFiles.IRPCVaultsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultsAdmin/CheckForOpenSessions |
| HTTP (mf-http-grpc) | POST /grpc/v1/check-for-open-sessions |
| Request | CheckForOpenSessionsRequest |
| Response | CheckForOpenSessionsResponse |
| 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 system administrator server role (server right
manage_vaults). - Read-only. Call it before TakeVaultOffline
with
disconnect_usersfalse, which fails with the same error. - The error message lists the first 10 open sessions, one per line. Sessions of the server's own components and of vault applications are not counted.
Request: CheckForOpenSessionsRequest
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 |
|---|---|---|
vault | string | The GUID of the vault. |
Response: CheckForOpenSessionsResponse
No fields.
Related methods
- TakeVaultOffline -- Takes a vault offline: users cannot log in to it until it is brought online again.