IRPCLogin.GetVaultConnectionInfo
Vault API / core session session
Gets the full connection information of the current vault session, in the form the M-Files COM API uses.
| Service | Login and sessions MFiles.IRPCLogin |
|---|---|
| gRPC method | /MFiles.IRPCLogin/GetVaultConnectionInfo |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-vault-connection-info |
| Request | GetVaultConnectionInfoRequest |
| Response | GetVaultConnectionInfoResponse |
| 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 | no |
| Streaming | none (unary) |
Remarks
Used by M-Files components; applications should use
GetVaultSessionInfo and the session_data
returned at login instead. Requires a vault session. The RPC binding fields are left empty.
Request: GetVaultConnectionInfoRequest
No fields.
Response: GetVaultConnectionInfoResponse
Nested message fields are expanded to depth 2 only, to keep the page small (the full expansion has more rows); follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
connection_info | VaultConnectionInfo | The vault connection information of the user's session. |
connection_info.connection_mode | MFilesAPIMode | The connection mode of M-Files API.Values: MFILES_APIMODE_NORMAL (0), MFILES_APIMODE_INTERNAL_SERVER_ACCESS (1), MFILES_APIMODE_INTERNAL_SERVER_ACCESS_WITH_VAULT_MANAGEMENT (2). |
connection_info.rpc_binding_string | string | Binding string to the server. |
connection_info.minimum_rpc_authentication_level | uint32 | Ignored if connectionsecuritymode is specified. RPC_C_AUTHN_LEVEL_NONE or RPC_C_AUTHN_LEVEL_PKT_PRIVACY. Specifies the minimum authentication level to use if the protocol sequence is normal RPC, such as ncacn_ip_tcp. Ignored for other protocol sequences. |
connection_info.server_version | string | Server version string (e.g. "10.0.3757" or "10.0.3757.0"). |
connection_info.client_computer_name | string | The local computer name override used in the session. |
connection_info.vault_guid | string | The GUID of the vault. |
connection_info.vault_display_name | string | The name of the vault for display purposes. |
connection_info.locale_for_sorting | uint32 | Locale used for sorting. |
connection_info.session_id | bytes | The session identifier. |
connection_info.session_info | SessionInfoServer | General session information. |
connection_info.attachment_guid | string | The current attachment GUID of the vault. |
connection_info.enable_keep_alive | bool | True to allow the keep-alive thread to run. |
connection_info.server_vault_capabilities | ServerVaultCapabilities | Capabilities of M-Files Server and the connected document vault. |
connection_info.client_capabilities | ClientCapabilities | Capabilities of M-Files Client that were reported for the server when the connection (session) was established. |
connection_info.optional_grpc_cookies | string | Optional cookie data for gRPC connections. May contain multiple "<cookie_name>=<cookie_value>" cookies separated by newline character. |
connection_info.server_data | ServerData | Server data, including the product serial number and deployment type. Used to populate serial number and deployment type on SessionInfo. |
connection_info.connection_security_mode | ConnectionSecurityMode | Connection security mode. Overrides dwMinimumAuthenticationLevelIfNormalRPC if specified.Values: CONNECTION_SECURITY_MODE_UNSPECIFIED (0), CONNECTION_SECURITY_MODE_NONE (1), CONNECTION_SECURITY_MODE_ENCRYPTED (2), CONNECTION_SECURITY_MODE_ENCRYPTED_IF_BUILTIN_KEY_AVAILABLE (3). |
Related methods
- GetVaultSessionInfo -- Gets basic information about the current vault session: server version and ID, vault GUID and name, and the state of the server push channel.