IRPCLogin.GetClientSettingsByType
Vault API / core session no session
Gets client settings (theme, timeouts, banners, web security settings) for an M-Files web, desktop or Outlook client.
| Service | Login and sessions MFiles.IRPCLogin |
|---|---|
| gRPC method | /MFiles.IRPCLogin/GetClientSettingsByType |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-client-settings-by-type |
| Request | GetClientSettingsByTypeRequest |
| Response | GetClientSettingsByTypeResponse |
| Book and level | Vault API, core |
| Kind | session |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Used by M-Files' own web and desktop clients; applications rarely need it. Only vNext, web and
Outlook client types are supported; other types, including CLIENT_TYPE_SERVER_API, fail with
E_NOTIMPL.
Request: GetClientSettingsByTypeRequest
Struct for Client settings request data.
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 |
|---|---|---|
vault_guid | string | The GUID of the vault whose client settings to get. |
host_name | string | The host name of the client computer. |
client_type | ClientType | Specifies the type of client( Desktop, Web, etc). |
client_setting_flag | CLIENTSETTINGFLAGS | Flags that control this operation. |
client_setting_flag.all | bool | Specifies all flags set; Including any future flags. |
client_setting_flag.theme | bool | Theme flag |
client_setting_flag.session_timeout | bool | Client session timeout. |
client_setting_flag.default_web_client | bool | Default Web Client. |
client_setting_flag.add_in_settings | bool | Addin Settings. |
client_setting_flag.default_web_client_iis | bool | Default Web Client for IIS. |
client_setting_flag.web_access_cors | bool | CORS settings of Classic web access. |
client_setting_flag.migrate_classic_web_url | bool | Redirect classic web urls. |
client_setting_flag.migrate_web_link_to_online_web | bool | Migrate web links to online web app (Account layer). |
client_setting_flag.custom_banner | bool | Custom banner flag |
client_setting_flag.idle_session_timeout | bool | Idle session timeout. |
Response: GetClientSettingsByTypeResponse
Struct for Client settings information.
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 |
|---|---|---|
theme_configuration | ThemeConfiguration | The vault's UI theme (colors and logos) for the client. |
theme_configuration.web_logo | string | The Web logo. |
theme_configuration.web_login_logo | string | The Web login logo. |
theme_configuration.fav_icon | string | The Fav icon. |
theme_configuration.accent_color | string | The Accent color. |
client_session_timeout_in_seconds | uint32 | The client session timeout in seconds. |
dns_of_vaults_for_web[] | repeated string | The list of Vault DNS for Web(vNext) which marked as Default Web Client. |
web_security_and_cors_settings | SecurityAndCorsSettings | The Web Access Cross origin settings. |
web_security_and_cors_settings.enable_cross_origin_web_access[] | repeated string | The cross origin domain access for classic web. |
web_security_and_cors_settings.cross_origin_headers | string | The allowed cross-origin Header like Content-Type, X-Authentication, Access-Control-Allow-Origin. |
web_security_and_cors_settings.cross_origin_methods | string | the allowed cross-origin Methods like PUT,POST,DELETE,GET. |
web_security_and_cors_settings.prevent_xfs | bool | True to Prevent XFS, false to allow XFS. |
web_security_and_cors_settings.allowed_cross_frame_sites[] | repeated string | The cross-frame sites access for classic web. |
classic_web_urlmigrate_settings | NamedValueArray | Migrate classic web url settings. |
classic_web_urlmigrate_settings.value[] | repeated NamedValue | An array of the NamedValue structures. |
classic_web_urlmigrate_settings.value[].key | string | The name of the value. |
classic_web_urlmigrate_settings.value[].value | TypedValue | The value as a serialized bytearray. |
enable_web_link_migration_to_online_web | bool | If true, migrate the web links to online web app(Account layer). |
custom_banner_configuration | CustomBannerConfiguration | The custom banner configuration. |
custom_banner_configuration.color | string | The background color. |
custom_banner_configuration.content[] | repeated CustomBannerConfigurationContent | Array of banner content. |
custom_banner_configuration.content[].type | string | The type of the custom banner content. |
custom_banner_configuration.content[].text | string | The text of the custom banner content. |
custom_banner_configuration.content[].value | string | The value of the custom banner content. |
custom_banner_configuration.font_color | string | The font color. |
custom_banner_configuration.font_family | string | The font family. |
custom_banner_configuration.font_type | string | The font type. |
idle_session_timeout_in_seconds | uint32 | The idle session timeout in seconds. |