Vault management (basic) (IRPCVaultsAdminBasic)

View as Markdown

Lists the vaults, replica vaults and Ground Link proxy vaults of the server with their administrative details, as far as the caller is allowed to see them.

Use this interface to get document vault definitions. Use IRPCVaultsAdmin to add, modify and remove vaults. We have separated these read operations from operations that manipulate vaults to a dedicated interface to get better isolation. These read operations do not require the "manage vaults" server-level right. So, users with full control of vault can use these methods. These methods need to be supported even if the user does not have the "manage vaults" server-level right so that the user could control his vaults, e.g., change various metadata elements. This is the case in cloud vault.

Overview

M-Files Admin uses this service to fill its "Document Vaults" node. Unlike the vault-changing administration services, these read methods are open to any session: the server decides how much to return.

Sessions and rights. A server-level session is enough (log in with login_data.vault_guid = {00000000-0000-0000-0000-000000000000}); a vault session works too. No right is required, but:

• With the server right manage_vaults (ServerAccess; system administrators have it), can_manage_vaults is true and the vault data is complete (data folders, database settings, file data storage), except database credentials.
• Otherwise can_manage_vaults is false and only the basic vault data (GUID, name, host names) is filled. GetVaultAdmin adds the database engine and file data storage type when called in a vault session with full control of the vault.
• The vault lists of callers without manage_vaults contain only the vaults in which they have a user account.

Methods: GetVaultsAdmin and GetVaultAdmin for ordinary vaults, GetReplicasOfVaultsAdmin and GetReplicaOfVaultAdmin for replica vaults, GetGroundLinkProxiesAdmin and GetGroundLinkProxyAdmin for Ground Link proxy vaults. GetAddInSettings is for M-Files' own web components.

To list the vaults a user can log in to, use IRPCVaults instead.

Methods