IRPCVaultsAdminBasic.GetVaultAdmin
Administration API / specialized admin session idempotent
Gets one ordinary vault with its administrative details.
| Service | Vault management (basic) MFiles.IRPCVaultsAdminBasic |
|---|---|
| gRPC method | /MFiles.IRPCVaultsAdminBasic/GetVaultAdmin |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-vault-admin |
| Request | GetVaultAdminRequest |
| Response | GetVaultAdminResponse |
| 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
- Any session can call it, for any vault GUID of the server.
- The detail depends on the caller: with the server right
manage_vaults, complete data except database credentials; in a vault session with full control of the session's vault, the basic data plusdatabase_info.engineandfile_data_storage; otherwise the basic data only. - An unknown GUID fails with "The specified document vault does not exist."; a replica vault fails with "The parameter is incorrect.".
- Waits if the vault is being brought online or offline.
Request: GetVaultAdminRequest
A structure that specifies get vault admin request.
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 |
|---|---|---|
guid | string | The vault GUID with braces. |
Response: GetVaultAdminResponse
A structure that specifies get vault admin response.
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 |
|---|---|---|
can_manage_vaults | bool | True if the caller has the server right manage_vaults. |
vault | Vault | The vault. The fields filled depend on the caller (see the remarks). See Vault. |
vault.vault | VaultBasic | Basic data. |
vault.vault.guid | string | The vault GUID, in braces and upper case. Use it as LoginData.vault_guid. |
vault.vault.display_name | string | The vault name shown to users. |
vault.vault.tooltip | string | Optional description. Often empty. |
vault.vault.icon | bytes | The vault icon in .ico format, or empty. |
vault.vault.dns_names | StringArray | Host names configured for the vault, if any. |
vault.main_data_folder | string | The main physical folder of this vault on the server (e.g. C:\Program Files\M-Files\Server Vaults\MyVault). |
vault.additional_data_folders[] | repeated AdditionalFolder | The specification of the additional file data folders. |
vault.additional_data_folders[].path | string | Path (e.g. "\servername\sharename\folder"). |
vault.additional_data_folders[].limit_in_mb | uint32 | Data limit in megabytes or zero if no limit. |
vault.additional_data_folders[].impersonation | Impersonation | Impersonation information for accessing the folder. |
vault.database_info | SQLDatabase | The vault's SQL database. |
vault.database_info.engine | DBEngine | Database engine identification.Values: DBENGINE_NONE (0), DBENGINE_FIREBIRD (1), DBENGINE_MS_SQL_SERVER (2). |
vault.database_info.server_name | string | The data source i.e. the database server name where the vault's database is residing. This is specified for data service DB engines only. It is empty or unset for embedded databases such as Firebird Embedded. |
vault.database_info.database_name | string | The catalog i.e. the database name where the vault's data is residing. Allows the database name to differ from the vault display name. This is not specified in the Firebird case. |
vault.database_info.system_admin_impersonation | Impersonation | Impersonation information for accessing the database engine for administrative purposes. This contains SYSDBA (System Database Administrator) user name and password. If unset, the default user name and password are used. |
vault.database_info.basic_user_impersonation | Impersonation | Impersonation information for accessing the database engine in basic user operations that do not modify the database structure. This contains DB user name and password. If unset, the default user name and password are used. |
vault.file_data_storage | FileDataStorage | Identifies file data storage to use. Typically specifies that the file data storage is determined automatically.Values: FILE_DATA_STORAGE_DEFAULT (0), FILE_DATA_STORAGE_DISK (1), FILE_DATA_STORAGE_DATABASE (2), FILE_DATA_STORAGE_EXTERNAL (3), FILE_DATA_STORAGE_MASTER (4). |
vault.file_data_connection_string | string | The connection string that identifies the location, protocol, and credentials for the file data storage of this vault. For example, this might specify a storage account, a protocol, and a container name for Azure's BLOB Services. Can be unset or empty. |
vault_variables[] | repeated VaultVariable | The vault variables, such as the full-text search language and the ACL mode, returned to every caller. |
vault_variables[].name | string | The name of the vault variable. |
vault_variables[].value | bytes | The value of the variable in a serialized format. |
online_state | bool | The online state of the vault. |
tenants_enabled_for_office | StringArray | The Microsoft 365 tenant IDs where M-Files integrations have been enabled, if the server has this information; otherwise empty. |
tenants_enabled_for_office.value[] | repeated string | String values. |