PluginInfo
An authentication plug-in configuration.
| Full name | MFiles.PluginInfo |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
is_default | bool | 1 | True if this is the default configuration. |
is_scope_independent | bool | 2 | True if the plug-in can be used without a configuration scope. |
name | string | 3 | The configuration's name. Send it as PluginData.plugin_name. |
assembly_name | string | 4 | The plug-in's implementation, for example MFiles.AuthenticationProviders.OAuth. |
bridge_class_name | string | 5 | Internal to the server. |
system_configuration | NamedValueArray | 6 | Where the configuration comes from: Scope (send as PluginData.configuration_scope) and, for vault-stored configurations, VaultGUID. |
plugin_configuration | NamedValueArray | 7 | The plug-in's client-side settings. For an OAuth plug-in these include AuthorizationEndpoint, TokenEndpoint, ClientID, Scope and RedirectURI. |
Used by methods
- IRPCLogin.GetAuthenticationConfiguration -- Tells a client, before login, whether to authenticate with an authentication plug-in (single sign-on) and returns the plug-in's client-side configuration.
- IRPCLogin.GetAuthenticationPlugins -- Lists the authentication plug-ins installed on the server, without their configurations.
- IRPCVaultAdmin.GetMigrantAuthenticationConfigurations -- Lists the authentication configurations of the vault that need to be migrated to the current format.
Used in fields
ExtensionAuthenticationRequest.supported_plugins-- The plugins information supported by the external connection.ExtensionAuthenticationTarget.supported_plugins-- The authentication methods the target accepts. Thenameof the chosen one goes toExtensionAuthenticationResponse.plugin_configuration.GetAuthenticationPluginsResponse.plugins-- Receives the plugin information.GetAuthenticationConfigurationResponse.plugin_infos-- The matching plug-in configurations.system_configurationholds the configuration scope (Scope) to send back inPluginData.configuration_scope;plugin_configurationholds the plug-in's client settings.GetMigrantAuthenticationConfigurationsResponse.plugin_infos-- The authentication plugin information of each configuration, in the same order asconfigurations.