AuthDataClientUnion

View as Markdown

The method-specific part of AuthDataClient. Set the member that AuthDataClient.type names.

Fields

FieldTypeNumberDescription
mfiles_leg1AuthDataClientUnion.MFilesLeg1Data (oneof data)1First call of the two-step M-Files challenge login (AUTH_DATA_TYPE_MFILES_LEG1).
mfiles_leg2AuthDataClientUnion.MFilesLeg2Data (oneof data)2Second call of the two-step M-Files challenge login (AUTH_DATA_TYPE_MFILES_LEG2).
windowsAuthDataClientUnion.WindowsData (oneof data)3Windows authentication tokens (AUTH_DATA_TYPE_WINDOWS), possibly over several calls.
pluginAuthDataClientUnion.PluginData (oneof data)4Authentication through a plug-in such as single sign-on (AUTH_DATA_TYPE_PLUGIN).
credentialsCredentials (oneof data)5User name and password (AUTH_DATA_TYPE_CREDENTIALS). Completes in one call.
anonymousAuthDataClientUnion.AnonymousData (oneof data)6Anonymous login (AUTH_DATA_TYPE_ANONYMOUS), when the vault allows it. Has no data.

Used in fields

Nested message UndefinedClientData

Not used by any authentication method; never set it.

Full name: MFiles.AuthDataClientUnion.UndefinedClientData

No fields.

Nested message MFilesLeg1Data

First step of the M-Files challenge login: names the account and asks for a challenge.

Full name: MFiles.AuthDataClientUnion.MFilesLeg1Data

FieldTypeNumberDescription
user_namestring1M-Files user name.

Nested message MFilesLeg2Data

Second step of the M-Files challenge login: answers the challenge from the first step.

Full name: MFiles.AuthDataClientUnion.MFilesLeg2Data

FieldTypeNumberDescription
authentication_attempt_identifierAuthenticationAttemptIdentifier1The identifier returned by the first step, unchanged.
responsebytes2The answer to the challenge from AuthDataServerUnion.MFilesLeg1Data.

Nested message WindowsData

One step of a Windows (SSPI) authentication exchange.

Full name: MFiles.AuthDataClientUnion.WindowsData

FieldTypeNumberDescription
authentication_attempt_identifierAuthenticationAttemptIdentifier1Unset in the first call; in later calls, the identifier from the previous response.
auth_databytes2Opaque Windows authentication data.

Nested message PluginData

Authentication through a server plug-in, for example single sign-on with an identity provider.

Take plugin_name and configuration_scope from the PluginInfo that GetAuthenticationConfiguration returned. A missing configuration_scope fails with E_INVALIDARG. What auth_data must contain depends on the plug-in.

Full name: MFiles.AuthDataClientUnion.PluginData

FieldTypeNumberDescription
authentication_attempt_identifierAuthenticationAttemptIdentifier1Unset in the first call; in later calls, the identifier from the previous response.
plugin_namestring2The name of the plug-in configuration from PluginInfo.
configuration_scopestring3The Scope value from PluginInfo.system_configuration. Required.
vault_guidstring6The vault that stores the plug-in configuration (VaultGUID in PluginInfo.system_configuration), if any.
data_formatPluginAuthDataFormat4PLUGIN_AUTH_DATA_FORMAT_UNENCRYPTED (the default) or PLUGIN_AUTH_DATA_FORMAT_RSA2048. PLUGIN_AUTH_DATA_FORMAT_RSA512 is refused.Values: PLUGIN_AUTH_DATA_FORMAT_UNENCRYPTED (0), PLUGIN_AUTH_DATA_FORMAT_RSA512 (1), PLUGIN_AUTH_DATA_FORMAT_RSA2048 (2).
auth_datarepeated NamedValue5The plug-in's input as named values, for example the token from the identity provider. Non-empty values are encrypted when data_format says so.

Nested message AnonymousData

Anonymous login. Has no data.

Full name: MFiles.AuthDataClientUnion.AnonymousData

No fields.