LoginData

View as Markdown

Which vault to log in to, and options for the new session.

Full nameMFiles.LoginData
Proto filemfiles/structs.proto

Fields

FieldTypeNumberDescription
server_hostnamestring1The host name the client used to reach the server. Optional for user name and password logins. Anonymous logins, and server-level logins on servers with vault login accounts, use it to find the vault configured for that host name.
vault_guidstring2The vault to log in to, as a GUID string with or without braces, in any case. Use {00000000-0000-0000-0000-000000000000} for a server-level session; an empty string is rejected with E_MFILES_INVALID_VAULT_GUID_X_DESC.
is_administrativebool3True for administrative tools that manage the vault rather than work with documents, as M-Files Admin does. Applications leave it false.
client_session_timeout_in_secondsuint324Optional. Requests a longer idle timeout for a vault session. Honored only when it is at least the server's session timeout and at most 7 days (or the server timeout if that is longer); otherwise, and for server-level sessions, the server timeout applies. The effective value shows as SessionData.keep_alive_interval_in_seconds, which is half of it.

Used by methods

Used in fields