AuthDataClientUnion
The method-specific part of AuthDataClient. Set the member that AuthDataClient.type names.
| Full name | MFiles.AuthDataClientUnion |
|---|---|
| Proto file | mfiles/structs.proto |
| Nested types | AuthDataClientUnion.UndefinedClientData, AuthDataClientUnion.MFilesLeg1Data, AuthDataClientUnion.MFilesLeg2Data, AuthDataClientUnion.WindowsData, AuthDataClientUnion.PluginData, AuthDataClientUnion.AnonymousData |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
mfiles_leg1 | AuthDataClientUnion.MFilesLeg1Data (oneof data) | 1 | First call of the two-step M-Files challenge login (AUTH_DATA_TYPE_MFILES_LEG1). |
mfiles_leg2 | AuthDataClientUnion.MFilesLeg2Data (oneof data) | 2 | Second call of the two-step M-Files challenge login (AUTH_DATA_TYPE_MFILES_LEG2). |
windows | AuthDataClientUnion.WindowsData (oneof data) | 3 | Windows authentication tokens (AUTH_DATA_TYPE_WINDOWS), possibly over several calls. |
plugin | AuthDataClientUnion.PluginData (oneof data) | 4 | Authentication through a plug-in such as single sign-on (AUTH_DATA_TYPE_PLUGIN). |
credentials | Credentials (oneof data) | 5 | User name and password (AUTH_DATA_TYPE_CREDENTIALS). Completes in one call. |
anonymous | AuthDataClientUnion.AnonymousData (oneof data) | 6 | Anonymous login (AUTH_DATA_TYPE_ANONYMOUS), when the vault allows it. Has no data. |
Used in fields
AuthDataClient.data-- The method's data. Set exactly the member thattypenames.
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
| Field | Type | Number | Description |
|---|---|---|---|
user_name | string | 1 | M-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
| Field | Type | Number | Description |
|---|---|---|---|
authentication_attempt_identifier | AuthenticationAttemptIdentifier | 1 | The identifier returned by the first step, unchanged. |
response | bytes | 2 | The answer to the challenge from AuthDataServerUnion.MFilesLeg1Data. |
Nested message WindowsData
One step of a Windows (SSPI) authentication exchange.
Full name: MFiles.AuthDataClientUnion.WindowsData
| Field | Type | Number | Description |
|---|---|---|---|
authentication_attempt_identifier | AuthenticationAttemptIdentifier | 1 | Unset in the first call; in later calls, the identifier from the previous response. |
auth_data | bytes | 2 | Opaque 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
| Field | Type | Number | Description |
|---|---|---|---|
authentication_attempt_identifier | AuthenticationAttemptIdentifier | 1 | Unset in the first call; in later calls, the identifier from the previous response. |
plugin_name | string | 2 | The name of the plug-in configuration from PluginInfo. |
configuration_scope | string | 3 | The Scope value from PluginInfo.system_configuration. Required. |
vault_guid | string | 6 | The vault that stores the plug-in configuration (VaultGUID in PluginInfo.system_configuration), if any. |
data_format | PluginAuthDataFormat | 4 | PLUGIN_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_data | repeated NamedValue | 5 | The 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.