IRPCExtensionAuthentications.GetExtensionAuthenticationTargets

View as Markdown

Vault API / standard read session idempotent returns metadata structure version

Lists the external systems that accept credentials through this service.

ServiceExtension authentications MFiles.IRPCExtensionAuthentications
gRPC method/MFiles.IRPCExtensionAuthentications/GetExtensionAuthenticationTargets
HTTP (mf-http-grpc)POST /grpc/v1/get-extension-authentication-targets
RequestGetExtensionAuthenticationTargetsRequest
ResponseGetExtensionAuthenticationTargetsResponse
Book and levelVault API, standard
Kindread
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: GetExtensionAuthenticationTargetsRequest

No fields.

Response: GetExtensionAuthenticationTargetsResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
targets[]repeated ExtensionAuthenticationTargetThe targets. Pass id as target to the other methods, and use supported_plugins to choose how to authenticate.
targets[].idstringThe identifier of the target. Pass it as target to the other methods of IRPCExtensionAuthentications.
targets[].namestringThe display name of the target.
targets[].icon_idstringAn identifier of the target's icon.
targets[].requires_user_specific_authenticationboolTrue if each user must store their own credentials for this target.
targets[].supported_plugins[]repeated PluginInfoThe authentication methods the target accepts. The name of the chosen one goes to ExtensionAuthenticationResponse.plugin_configuration.
targets[].supported_plugins[].is_defaultboolTrue if this is the default configuration.
targets[].supported_plugins[].is_scope_independentboolTrue if the plug-in can be used without a configuration scope.
targets[].supported_plugins[].namestringThe configuration's name. Send it as PluginData.plugin_name.
targets[].supported_plugins[].assembly_namestringThe plug-in's implementation, for example MFiles.AuthenticationProviders.OAuth.
targets[].supported_plugins[].bridge_class_namestringInternal to the server.
targets[].supported_plugins[].system_configurationNamedValueArrayWhere the configuration comes from: Scope (send as PluginData.configuration_scope) and, for vault-stored configurations, VaultGUID.
targets[].supported_plugins[].plugin_configurationNamedValueArrayThe plug-in's client-side settings. For an OAuth plug-in these include AuthorizationEndpoint, TokenEndpoint, ClientID, Scope and RedirectURI.