IRPCLogin.GetServerCapabilities

View as Markdown

Vault API / core session no session idempotent

Gets the features the server supports, without logging in.

ServiceLogin and sessions MFiles.IRPCLogin
gRPC method/MFiles.IRPCLogin/GetServerCapabilities
HTTP (mf-http-grpc)POST /grpc/v1/get-server-capabilities
RequestGetServerCapabilitiesRequest
ResponseGetServerCapabilitiesResponse
Book and levelVault API, core
Kindsession
SessionNot needed: the call can be made before logging in.
Idempotentyes
Returns metadata structure versionno
Streamingnone (unary)

Remarks

Needs no session; the result is the same for all callers and can be cached. Check a capability before using the methods or fields it guards.

These are server-level capabilities. After logging in to a vault, prefer session_data.server_vault_capabilities, which also includes vault-specific capabilities (for example facet_search) as they apply to the user.

Request: GetServerCapabilitiesRequest

No fields.

Response: GetServerCapabilitiesResponse

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

FieldTypeDescription
server_capabilitiesServerVaultCapabilitiesReceives the server capabilities.
server_capabilities.vault_login_accountsboolVault supports in-vault login accounts.
server_capabilities.public_link_sharingboolSpecifies whether sharing public links are allowed.
server_capabilities.latest_version_public_link_sharingboolSpecifies whether sharing public links for latest versions are allowed.
server_capabilities.facet_searchboolSpecifies whether facet search are allowed.
server_capabilities.property_def_searchabilityboolSpecifies whether property definitions can be configured searchable or unsearchable.
server_capabilities.automatic_metadataboolServer implements automatic metadata feature and the metadata extraction is enabled on server.
server_capabilities.file_streamingboolSpecifies whether file streaming is supported.
server_capabilities.search_options2boolServer supports search options.
server_capabilities.json_ext_applicationsboolServer supports returning ext. application structs in json format.
server_capabilities.search_referenced_value_list_itemsboolServer supports searching for value list items which are referenced by objects.
server_capabilities.get_text_content_with_optionsboolServer supports calling the new GetTextContentForFile method with options.
server_capabilities.external_repository_object_migrationboolServer supports external repository object migration.
server_capabilities.client_http_apiboolServer supports communication with client through HTTP API.
server_capabilities.reverse_grouping_levelboolServer supports reverse grouping levels.
server_capabilities.replication_configuration_idboolServer supports configuration ID in export and import jobs.
server_capabilities.detect_text_languageboolServer supports detecting the language of plain text.
server_capabilities.async_nacl_change_propagationboolServer supports asynchronous NACL change propagation.
server_capabilities.object_data_retrieval_in_chunksboolServer supports object data retrieval in chunks.
server_capabilities.async_tasks_retrievalboolServer supports retrieving asynchronous tasks.
server_capabilities.find_duplicatesboolServer supports finding duplicate files.
server_capabilities.favor_full_text_searchboolServer supports favoring full-text search even if no AnyField conditions exist.
server_capabilities.application_task_queueboolServer supports application task queue operations.
server_capabilities.object_permissions_for_clientboolServer supports ObjectPermissionsForClient.
server_capabilities.undelete_user_account_by_guidboolServer supports undeleting a user account by GUID.
server_capabilities.use_user_visible_aclin_searchesboolServer supports using UserVisibleACL in searches to check users' read access to objects.
server_capabilities.named_value_storage_conflict_detectionboolServer supports conflict detection when saving named values.
server_capabilities.hierarchical_object_type_propertiesboolProperties with hierarchy for real object types supported.
server_capabilities.embedded_ui_for_share_pointboolServer supports embedding vNext UI to the SharePoint.
server_capabilities.embedded_ui_for_salesforce_crmboolServer supports embedding vNext UI to the Salesforce.
server_capabilities.async_modify_object_classboolServer supports asynchronous object class modification.
server_capabilities.settings_managerboolServer supports settings management.
server_capabilities.web_user_interfaceboolServer supports web user interface.
server_capabilities.remove_from_recently_accessedboolServer supports removing objects from "Recently Accessed by Me" -view.
server_capabilities.plain_text_password_methodsboolServer supports plain text password methods.
server_capabilities.ocr_automatic_language_detectionboolServer supports OCR automatic language detection.
server_capabilities.ground_linkboolServer supports ground link feature.
server_capabilities.async_aacl_change_propagationboolServer supports asynchronous AACL change propagation.
server_capabilities.google_integration_supportedboolServer supports google g-suite.
server_capabilities.document_compareboolServer supports making document comparison requests.
server_capabilities.full_control_vault_user_can_modify_codeboolServer supports full control vault user can modify code (Cloud Service Fabric Isolated Service).
server_capabilities.broadcast_request_supportedboolServer supports sending pre-defined broadcast messages through the vault database.
server_capabilities.embedded_ui_for_arc_gisboolServer supports embedding vNext UI to the ArcGIS.
server_capabilities.search_in_external_view_folderboolServer supports search in external view folder.
server_capabilities.automatic_semantic_aliasboolServer supports automatic semantic aliases (advanced vault settings).
server_capabilities.automatic_online_transitionboolServer supports automatic online transition.
server_capabilities.vault_server_attachmentsboolServer supports vault server attachment feature.
server_capabilities.replication_package_list_and_removeboolServer supports replication package list and remove feature.
server_capabilities.plugin_replication_allowed_for_vault_adminboolDoes server support plugin replication for vault admins?
server_capabilities.recurring_notificationsboolServer supports recurring notifications.
server_capabilities.remove_workflowsboolServer supports removing workflows as a batch.
server_capabilities.jsoned_workflows_adminboolServer supports JSONed workflows admin interface.
server_capabilities.tls_certificatesboolServer supports configuring TLS certificates.
server_capabilities.attach_vault_options_as_jsonboolServer supports transmitting AttachVaultOptions.
server_capabilities.web_client_sends_telemetry_databoolSending production telemetry data by web clients is enabled.
server_capabilities.ground_link_eotboolServer supports ground link EOT feature.
server_capabilities.vault_access_rights64_bitsboolServer supports 64-bit VAULTACCESS.
server_capabilities.vault_role_manage_private_viewsboolServer supports a vault role for managing private views.
server_capabilities.exclude_vaults_user_cannot_accessboolServer supports returning only vaults user has access to.
server_capabilities.find_duplicates_of_obj_verboolServer supports finding duplicate of ObjVer.
server_capabilities.add_object_with_filesboolServer supports adding object with files in single server call.
server_capabilities.folder_uistate_operations_of_viewboolServer supports accessing and setting Folder UI State of View as structure based data.
server_capabilities.long_smtpnotification_password_supportedboolServer supports long SMTP notification password.
server_capabilities.can_change_permissions_object_capabilityboolServer reports the "can change permissions" object capability.
server_capabilities.add_new_version_based_on_conflict_objectboolServer supports adding a new version to the object based on the related deleted conflict object.
server_capabilities.reading_replication_packages_from_new_location_supportedboolServer can read replication packages whose names end with the full hash.
server_capabilities.writing_replication_packages_to_new_location_supportedboolServer can write replication packages whose names end with the full hash.
server_capabilities.vault_health_check_supportedboolServer supports vault health check.
server_capabilities.allow_all_see_deleted_conflict_objectsboolServer supports that all users can see deleted conflict objects.
server_capabilities.automatic_conflict_resolutionboolAutomatic conflict resolution is enabled in the vault.
server_capabilities.share_private_viewsboolServer supports sharing private views.
server_capabilities.external_mail_source_oauth_proxy_supportedboolServer supports storing external mail source oauth proxy information.
server_capabilities.async_tasks_range_apiboolServer supports an API to get a range of asynchronous tasks.
server_capabilities.shared_link_based_wopioperationsboolServer supports shared link based wopi operations.
server_capabilities.advanced_password_hashesboolServer supports hashing passwords with advanced algorithms, including at least PBKDF2.
server_capabilities.anonymous_authentication_supportedboolServer supports anonymous authentication.
server_capabilities.get_default_replication_configuration_supportedboolServer supports getting default configuration for replication.
server_capabilities.object_version_data_request_with_identity_type_supportedboolObjectVersionDataRequest supports an identity type.
server_capabilities.rsa_aes_encryptionboolEncryption with RSA+AES is supported.
server_capabilities.indexer_monitoring_statusboolIndexer monitoring status is supported.
server_capabilities.green_lights_supportedboolGreen Lights supported.
server_capabilities.allow_code_modification_with_valid_signature_supportedboolServer supports installation of signed scipts and apps by users.
server_capabilities.mdcc_resolved_on_serverboolThe Metadata Card Configuration is delivered as a pre-resolved from a dedicated virtual NVS namespace.
server_capabilities.new_web_wopico_authoring_supportedboolWOPI CoAuthoring using New web is supported.
server_capabilities.get_vault_session_info_supportedboolServer supports returning of vault session info.
server_capabilities.event_log_saved_searchesboolEvenLog Saved Searches Supported.
server_capabilities.allow_sys_admin_unsigned_code_modification_supportedboolSys Admins can install unsigned vault applications and modify unsigned VBScripts even when the signing feature is enabled.
server_capabilities.vault_app_dependencies_supportedboolIf vault app installation can require other vault apps to be installed in the vault.
server_capabilities.dataset_deleted_condition_supportedboolServer supports deleted/not deleted-condition in an exported dataset definition.
server_capabilities.unified_password_hashesboolServer supports transmitting hashing passwords with the same encoding between all gRPC methods.
server_capabilities.set_properties_with_missing_required_params_supportedboolServer supports SetProperties with missing required params.
server_capabilities.index_management_enabledboolIndex management operations are enabled for the server.
server_capabilities.search_results_sortingboolSpecifies whether the server supports sorting search results.
server_capabilities.property_action_state_transition_timeboolServer supports state transition time setting via state property action.
server_capabilities.set_new_web_as_default_client_supportedboolServer supports set new web as default client.
server_capabilities.ignore_vault_external_data_connection_pointsboolServer supports ignore vault's external data connection points.
server_capabilities.add_user_returns_tasks_before_loginboolServer supports returning tasks the caller must wait before login to the vault with that user succeeds.
server_capabilities.m_files_link_supportedboolServer supports the new links and the Link Loading Page.
server_capabilities.can_verify_vault_app_signatureboolServer supports verification of vault app signatures.
server_capabilities.allow_signed_code_in_import_supportedboolServer supports allowing signed code importing even if the code import would be otherwise denied for the structure element.
server_capabilities.value_list_item_search_property_conditionsboolServer supports real property definition based conditions in value list item searches.
server_capabilities.additive_permissions_via_automatic_aclcomponentsboolServer supports additive permissions via automatic ACL components.
server_capabilities.set_default_view_from_my_filtered_views_supportedboolServer supports setting the default view from the user's filtered views.
server_capabilities.set_properties_ex_supportedboolServer supports the updated SetPropertiesEx call.
server_capabilities.search_results_sorting_by_search_engineboolServer supports search results sorting done by search engine.
server_capabilities.async_task_hierarchy_wait_supportedboolServer supports returning task hierarchy enabling waiting for all tasks matchins search conditions to complete.
server_capabilities.vault_level_optimization_jobsboolServer supports vault-level optimization jobs.
server_capabilities.mdcc_conversion_on_serverboolServer supports converting metadata card configurations between primary and configurator versions.
server_capabilities.template_request_filter_supportedboolServer supports specifying a filter when requesting templates.
server_capabilities.import_views_with_older_last_modified_supportedboolServer supports importing views with an older last modified date and time.
server_capabilities.visitor_links_supportedboolServer supports new interface methods for visitor links.
server_capabilities.notifications_modern_authentication_supportedboolServer supports modern authentication (OAuth2) to send notifications.
server_capabilities.get_metadata_structure_supportedboolServer supports providing full metadata structure with one RPC call.
server_capabilities.optimize_vault_job_auto_cancelboolServer supports auto-canceling optimize vault jobs.
server_capabilities.generate_v2_azure_auth_conf_supportedboolServer supports generating authentication configuration for Azure v2.0 endpoint.
server_capabilities.preview_thumbnail_supportedboolServer supports creating preview thumbnails.
server_capabilities.vault_connection_qrsettingsboolServer supports vault connection QR settings.
server_capabilities.run_extension_methodboolServer supports the 'RunExtensionMethod' method.
server_capabilities.structure_item_groups_in_export_supportedboolServer supports structure item groups in the export job.
server_capabilities.teams_add_on_supportedboolServer supports teams add-on.
server_capabilities.unified_login_supportedboolServer support all different types log-in methods through a single method.
server_capabilities.handling_technical_credentials_supportedboolServer supports handling of login accounts defined as technical credentials.
server_capabilities.jsoned_vault_basic_supportedboolServer supports JSONed vault basic.
server_capabilities.generate_login_service_auth_confboolServer supports generating authentication configuration for M-Files Login Service.
server_capabilities.new_desktop_supportedboolServer supports new vNext based Desktop.
server_capabilities.gl_comm_errorboolServer supports notifying greenlights joining errors and error is on.
server_capabilities.recently_used_valuesboolServer supports storing and returning recently used values for lookup properties in metadata.
server_capabilities.add_object_with_multiple_filesbool
server_capabilities.new_get_effective_permissions_supportedboolServer supports new GetEffectivePermissions API.
server_capabilities.sub_folders_in_viewsboolServer supports subfolders in views.
server_capabilities.manual_aad_auth_conf_migration_supportedboolServer supports manually migrating Azure AD authentication configuration to Login Service.
server_capabilities.reverse_references_in_pseudo_user_acesboolServer supports reverse references in pseudo-user ACEs (Access Control Entries).
server_capabilities.entity_version_checking_supportedboolServer supports entity version numbering to track modification conflicts.
server_capabilities.folder_download_supportedboolHTTP layer supports downloading folders with download URLs.
server_capabilities.uistate_for_special_folders_supportedboolServer supports special folder type such as history.
server_capabilities.latest_comment_as_object_data_supportedboolServer supports getting the latest version comment as part of the object data.
server_capabilities.native_co_authoring_supportedboolServer supports native co-authoring.
server_capabilities.workflow_state_historyboolServer supports GetWorkflowStateHistory API.
server_capabilities.block_mfiles_loginboolIs logging in using M-Files accounts prohibited.
server_capabilities.cloud_management_api_operationsboolServer supports Cloud Management API Operations.
server_capabilities.reload_applicationboolServer supports 'ReloadApplication' method.
server_capabilities.workflow_descriptions_supportedboolWorkflow, State and State Transition struct with user description fields.
server_capabilities.new_license_apiboolServer supports new GetLicenseCodeAndSerialNumber API.
server_capabilities.new_wopidiscovery_endpoint_supportedboolServer supports new WOPI discovery RPC endpoint.
server_capabilities.web_force_session_based_tokenboolM-Files Web Access uses only session-based tokens.
server_capabilities.basic_tier_objects_supportedboolVault supports basic-tier objects.
server_capabilities.version_editors_property_supportedboolServer supports the property with multiple editors for a single object version.
server_capabilities.check_in_external_changes_supportedboolServer supports the Check in external Changes RPC endpoint.
server_capabilities.sharing_center1_supportedboolServer supports Sharing center 1 feature.
server_capabilities.get_folder_contents_api_request_responseboolServer supports GetFolderContents API with request and response structures.
server_capabilities.uixapplication_schema_v6_supportedboolServer supports UIX Application Schema v6.
server_capabilities.user_and_group_changesboolServer supports user and group change versioning and synchronization to Change Hub.
server_capabilities.native_co_authoring_replication_supportedboolServer supports native co-authoring replication.
server_capabilities.separate_desktop_co_authoring_settingboolServer recognizes a vault setting that enables co-authoring for Master Storage separately from Microsoft 365.
server_capabilities.incoming_requests_via_grpc_onlyboolServer uses the gRPC-only routing for incoming requests.
server_capabilities.non_standard_default_for_iis_endpointboolServer uses the non-standard default (7780) for IIS endpoint.
server_capabilities.workspace_personalization_supportedboolServer supports workspace personalization.
server_capabilities.integration_platformboolServer supports Integration Platform.
server_capabilities.check_in_external_changes_returns_visibilityboolThe server supports the post-operation visibility info in CheckInExternalChanges RPC function.
server_capabilities.get_client_settings_for_desktop_supportedboolServer supports GetClientSettingsByType for M-Files Desktop.
server_capabilities.pdftron_modular_uisupportedboolServer supports Modular UI PDFTron integration.
server_capabilities.query_search_agent_supportedboolServer supports QuerySearchAgent RPC endpoint.
server_capabilities.set_tier_supportedboolServer supports SetTier API and functionality.
server_capabilities.user_group_sync_status_supportedboolServer supports user group synchronization status.
server_capabilities.downloading_content_from_temp_location_supportedboolServer supports downloading content from temporary location.
server_capabilities.get_uiversion_info_supportedboolServer supports GetUIVersionInfo RPC endpoint.
server_capabilities.aino_search_results_summarization_supportedboolUnused.
server_capabilities.cad_file_preview_supportedboolServer supports CAD file preview (DWG, DXF, DWT, DGN to PDF conversion).
server_capabilities.declarative_metadata_structure_supportedboolCollective metadata structure interfaces IRPCDeclarativeMetadataStructureAsProtobuf and IRPCDeclarativeMetadataStructure are available.
server_capabilities.master_storage_malware_detectionboolServer checks user downloads of Master Storage files against the file's malware verdict, and offers GetFileMalwareInfo for advisory warnings.
server_capabilities.keep_upload_session_alive_supportedboolServer supports KeepUploadSessionAlive RPC endpoint.
server_capabilities.purview_labelsboolServer offers GetSensitivityLabels (IRPCSensitivityLabels), which returns the Microsoft Purview sensitivity labels of files in Master Storage, for advisory label display.
server_capabilities.get_objects_by_external_idsboolServer supports looking up objects by their external IDs.
server_capabilities.summarization_agent_supportedboolServer supports the Aino summarization agent (AI summaries with Q&A).
server_capabilities.dual_preview_supportedboolServer supports dual preview (SharePoint Embedded preview and PDFTron) for documents in vaults that keep their files in SharePoint Embedded.
server_capabilities.coauthoring_external_idcheckedboolServer checks the external ID for co-authoring.
server_capabilities.get_index_configurations_for_ixsupportedboolServer offers GetIndexConfigurationsForIX (IRPCIndexingDataSource2), which returns the vault's search index configuration, without secrets, to a caller who can see all objects.
server_capabilities.draft_object_creation_supportedboolServer supports creating objects in a draft (pending-upload) state with AddObjectWithFiles (draft).
server_capabilities.retrieval_of_program_defaults_display_settings_supportedboolServer supports reading the program default display settings.
server_capabilities.reset_folder_uistate_to_defaults_supportedboolServer offers ResetFolderUIStateToDefaults (IRPCFolderUISettings), which resets a folder's UI state and returns the resulting state.
server_capabilities.auto_check_in_on_file_close_supportedboolServer supports automatic check-in when an Office file is closed in Microsoft 365 co-authoring.
server_capabilities.vault_admin_edit_of_replication_job_with_working_directory_supportedboolServer lets vault administrators modify cloud replication jobs that carry folders, keeping the server-owned working directory and impersonation.
server_capabilities.create_new_object_with_property_metadata_supportedboolServer supports CreateNewObjectWithPropertyMetadata: a new object and its property value metadata in one call.
server_capabilities.add_object_with_files_with_property_metadata_supportedboolServer supports AddObjectWithFilesWithPropertyMetadata: a new object with files and its property value metadata in one call.
server_capabilities.direct_file_content_in_add_object_with_files_supportedboolServer accepts inline file content (OBJ_FILE_SOURCE_TYPE_FILE_CONTENT) when creating an object with files.
server_capabilities.set_properties_with_metadata_attributed_to_supportedboolServer supports SetPropertiesWithMetadataAttributedTo, which records automatic metadata changes as made by a built-in agent user.
server_capabilities.vault_ready_for_m365_storage_permissions_supportedboolServer offers IsVaultReadyForM365StoragePermissions (IRPCUsersAdmin), which tells whether the vault's users meet the precondition for applying M-Files permissions to Microsoft 365 storage.
server_capabilities.file_upload_stateless_supportedboolServer supports the file_ref uploads of IRPCFileTransfer and IRPCFileTransferStreaming. False by default in M-Files Server 26.11, where those methods answer "Not implemented.".
server_capabilities.get_text_content_with_format_supportedboolServer supports requesting GetTextContentForFile content in a specific FileFormat (plain text or Markdown) and reports the format actually produced.
server_capabilities.persistent_reasoning_metadata_supportedboolServer supports persisting reasoning metadata.
server_capabilities.agentic_aino_supportedboolServer supports agentic Aino retrieval.
server_capabilities.folder_tree_creation_supportedboolServer supports creating a whole traditional folder tree in one request (CreateFolderTree). Not reported for Ground Link proxy vaults.
server_capabilities.get_current_timestamp_for_ixsupportedboolServer offers GetCurrentTimestampForIX (IRPCIndexingDataSource2), which returns the vault's current indexing position so that a crawl can start from now.
server_capabilities.select_folders_supportedboolServer supports saving per-user folder selections for view levels (SetFolderSelection) and reporting them.