IRPCVault.GetVault
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the GUID, display name and other basic data of the session's vault.
| Service | Vault information MFiles.IRPCVault |
|---|---|
| gRPC method | /MFiles.IRPCVault/GetVault |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-vault |
| Request | GetVaultRequest |
| Response | GetVaultResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
Requires a vault session. tooltip, icon and dns_names are often empty. The response
carries the metadata structure version in the mfiles-metadata-version-bin trailer.
Request: GetVaultRequest
A structure that specifies get vault request.
No fields.
Response: GetVaultResponse
A structure that specifies get vault 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 |
|---|---|---|
vault | VaultBasic | The vault the session is logged in to. |
vault.guid | string | The vault GUID, in braces and upper case. Use it as LoginData.vault_guid. |
vault.display_name | string | The vault name shown to users. |
vault.tooltip | string | Optional description. Often empty. |
vault.icon | bytes | The vault icon in .ico format, or empty. |
vault.dns_names | StringArray | Host names configured for the vault, if any. |
vault.dns_names.value[] | repeated string | String values. |
Related methods
- GetVaultServerAttachments -- Gets the servers this vault is attached to.