Vaults on a server (IRPCVaults)
An interface for enumerating vaults.
Use this interface to get a listing of registered vaults on the server.
| gRPC service | MFiles.IRPCVaults |
|---|---|
| Book and level | Vault API, core |
| Methods | 3 |
| Proto file | mfiles/IRPCVaults.proto |
Overview
Lists the vaults on the server that the logged-in user can see. Use it to let a user pick a vault or to find a vault's GUID by its name; then log in to that vault with LogIn or LogInWithSession.
GetVaults is the method to use. It accepts both a
server-level session (from a LogIn with the all-zero vault GUID) and a vault session.
GetReplicasOfVaults and GetGroundLinkProxies serve special deployments and return nothing on
an ordinary server. Server-level and vault sessions are described in
Authentication and sessions.
Highlighted methods
| Method | Summary | Facts |
|---|---|---|
| GetVaults | Lists the vaults on the server that the session's user can see. | read session idempotent |
Other methods
| Method | Summary | Facts |
|---|---|---|
| GetGroundLinkProxies | Lists the Ground Link proxy vaults on the server that the session's user can see. | read session idempotent |
| GetReplicasOfVaults | Gets replicas of document vaults (links to (remote) document vaults). | write no session |