IRPCLogin.GetVaultSessionInfo
Vault API / core session session returns metadata structure version
Gets basic information about the current vault session: server version and ID, vault GUID and name, and the state of the server push channel.
| Service | Login and sessions MFiles.IRPCLogin |
|---|---|
| gRPC method | /MFiles.IRPCLogin/GetVaultSessionInfo |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-vault-session-info |
| Request | GetVaultSessionInfoRequest |
| Response | GetVaultSessionInfoResponse |
| Book and level | Vault API, core |
| Kind | session |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
Requires a vault session; a server-level session fails with E_MFILES_LOGIN_REQUIRED. A cheap
way to check that a session is still valid. The response also carries the vault's metadata
version in the mfiles-metadata-version-bin trailer.
For the user's identity, groups and access rights, use the session_data returned at login.
Request: GetVaultSessionInfoRequest
No fields.
Response: GetVaultSessionInfoResponse
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_session_info | VaultSessionInfo | The vault session information of the user's session. |
vault_session_info.session_id | bytes | The session's ID, the same bytes as in mfiles-session-id-bin. |
vault_session_info.server_version | string | The server version as text, for example 26.11.16645.0. |
vault_session_info.server_id | string | The GUID of the server. |
vault_session_info.vault_guid | string | The GUID of the vault. |
vault_session_info.vault_display_name | string | The name of the vault for display purposes. |
vault_session_info.attachment_guid | string | The vault's current attachment GUID, as VaultData.vault_attachment. |
vault_session_info.server_data_push_status | ServerDataPushStatus | Whether the session has an open server push channel.Values: SERVER_DATA_PUSH_STATUS_UNINITIALIZED (0), SERVER_DATA_PUSH_STATUS_REGISTERED (1), SERVER_DATA_PUSH_STATUS_NOT_REGISTERED (2), SERVER_DATA_PUSH_STATUS_INVALID (3). |