# Vault management (basic) (IRPCVaultsAdminBasic)

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md) > [Administration API](https://developer.m-files.com/APIs/gRPC-API/admin/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/

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.

- **gRPC service:** `MFiles.IRPCVaultsAdminBasic`
- **Book and level:** [Administration API](https://developer.m-files.com/APIs/gRPC-API/admin/index.md), specialized
- **Methods:** 7
- **Proto file:** [`mfiles/IRPCVaultsAdminBasic.proto`](https://developer.m-files.com/APIs/gRPC-API/downloads/proto/mfiles/IRPCVaultsAdminBasic.proto)

<a id="overview"></a>

## 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](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.ServerAccess/index.md); 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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetVaultAdmin/index.md) 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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetVaultsAdmin/index.md) and
[GetVaultAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetVaultAdmin/index.md) for ordinary vaults,
[GetReplicasOfVaultsAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetReplicasOfVaultsAdmin/index.md) and
[GetReplicaOfVaultAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetReplicaOfVaultAdmin/index.md) for replica
vaults, [GetGroundLinkProxiesAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetGroundLinkProxiesAdmin/index.md)
and [GetGroundLinkProxyAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetGroundLinkProxyAdmin/index.md) for
Ground Link proxy vaults. [GetAddInSettings](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetAddInSettings/index.md)
is for M-Files' own web components.

To list the vaults a user can log in to, use [IRPCVaults](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaults/index.md) instead.

<a id="methods"></a>

## Methods

| Method | Summary | Facts |
|---|---|---|
| [GetAddInSettings](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetAddInSettings/index.md) | Gets the cross-origin (CORS) and cross-frame settings that a vault's add-in configuration allows. | `internal: not for applications` `admin` `no session` |
| [GetGroundLinkProxiesAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetGroundLinkProxiesAdmin/index.md) | Lists the Ground Link proxy vaults of the server, including offline ones. | `admin` `session` `idempotent` |
| [GetGroundLinkProxyAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetGroundLinkProxyAdmin/index.md) | Gets one Ground Link proxy vault with its administrative details. | `admin` `session` `idempotent` |
| [GetReplicaOfVaultAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetReplicaOfVaultAdmin/index.md) | Gets one replica vault with its administrative details. | `admin` `session` `idempotent` |
| [GetReplicasOfVaultsAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetReplicasOfVaultsAdmin/index.md) | Lists the replica vaults of the server. | `admin` `session` `idempotent` |
| [GetVaultAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetVaultAdmin/index.md) | Gets one ordinary vault with its administrative details. | `admin` `session` `idempotent` |
| [GetVaultsAdmin](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetVaultsAdmin/index.md) | Lists the ordinary vaults of the server (not replicas or Ground Link proxies) with their administrative details, including offline vaults. | `admin` `session` `idempotent` |