AuthDataClient

View as Markdown

The client's authentication data in a LogIn call: the method in type and its data in the matching member of data.

Full name	`MFiles.AuthDataClient`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`type`	`AuthDataType`	1	The authentication method. Must match the member set in `data`; unset fails with `E_INVALIDARG`. For user name and password use `AUTH_DATA_TYPE_CREDENTIALS`.Values: `AUTH_DATA_TYPE_UNDEFINED` (0), `AUTH_DATA_TYPE_MFILES_LEG1` (1), `AUTH_DATA_TYPE_MFILES_LEG2` (2), `AUTH_DATA_TYPE_WINDOWS` (3), `AUTH_DATA_TYPE_PLUGIN` (4), `AUTH_DATA_TYPE_CREDENTIALS` (5), `AUTH_DATA_TYPE_ANONYMOUS` (6).
`data`	`AuthDataClientUnion`	2	The method's data. Set exactly the member that `type` names.
`certificate_proof`	`string`	3	Leave empty. Used only when the server requires client certificates.
`is_certificate_validated`	`bool`	4	Leave false. Set only by M-Files proxies that validate client certificates themselves.

Used by methods

IRPCLogin.LogIn -- Authenticates the caller and opens a session to a vault, or to the server when the vault GUID is all zeros.
IRPCLogin.LogInRemote -- Logs in (with authentication) to a remote server.

Used in fields

LogInRemoteRequest.authentication_data -- Authentication data for the remote server, as in LogIn.
LogInRequest.authentication_data -- How the caller proves its identity: type plus the matching member of data.