IRPCVaultAdmin.GetMigrantAuthenticationConfigurations
Administration API / specialized admin session
Lists the authentication configurations of the vault that need to be migrated to the current format.
| Service | Vault administration MFiles.IRPCVaultAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultAdmin/GetMigrantAuthenticationConfigurations |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-migrant-authentication-configurations |
| Request | GetMigrantAuthenticationConfigurationsRequest |
| Response | GetMigrantAuthenticationConfigurationsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session with full control of the vault. Read-only.
- M-Files Admin shows these and migrates each with MigrateAuthenticationConfiguration.
Request: GetMigrantAuthenticationConfigurationsRequest
No fields.
Response: GetMigrantAuthenticationConfigurationsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
configurations[] | repeated AuthenticationConfigurationMigration | The configurations to migrate, each in its migrated form. Empty if none. |
configurations[].scope | string | Scope of the configuration. |
configurations[].original_name | string | Name of the original configuration. |
configurations[].migrated_configuration | string | Configuration in migrated form. |
configurations[].entra_id_tech_cred | bool | Is the original configuration for Entra ID with technical credential settings included. |
plugin_infos[] | repeated PluginInfo | The authentication plugin information of each configuration, in the same order as configurations. |
plugin_infos[].is_default | bool | True if this is the default configuration. |
plugin_infos[].is_scope_independent | bool | True if the plug-in can be used without a configuration scope. |
plugin_infos[].name | string | The configuration's name. Send it as PluginData.plugin_name. |
plugin_infos[].assembly_name | string | The plug-in's implementation, for example MFiles.AuthenticationProviders.OAuth. |
plugin_infos[].bridge_class_name | string | Internal to the server. |
plugin_infos[].system_configuration | NamedValueArray | Where the configuration comes from: Scope (send as PluginData.configuration_scope) and, for vault-stored configurations, VaultGUID. |
plugin_infos[].system_configuration.value[] | repeated NamedValue | An array of the NamedValue structures. |
plugin_infos[].plugin_configuration | NamedValueArray | The plug-in's client-side settings. For an OAuth plug-in these include AuthorizationEndpoint, TokenEndpoint, ClientID, Scope and RedirectURI. |
plugin_infos[].plugin_configuration.value[] | repeated NamedValue | An array of the NamedValue structures. |
Related methods
- MigrateAuthenticationConfiguration -- Migrates one authentication configuration of the vault to the current format after a successful test sign-in with it.