IRPCLogin.GetLoginSettings
Vault API / core session no session
Gets the anonymous login settings and enabled vertical applications of the vault that serves the given host name, without a session.
| Service | Login and sessions MFiles.IRPCLogin |
|---|---|
| gRPC method | /MFiles.IRPCLogin/GetLoginSettings |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-login-settings |
| Request | GetLoginSettingsRequest |
| Response | GetLoginSettingsResponse |
| 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 login pages; applications rarely need it. host_name_match is false, and the
settings are empty, when no vault is configured for the host name.
Request: GetLoginSettingsRequest
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 |
|---|---|---|
host_name | string | If not empty, specifies the target hostname. |
Response: GetLoginSettingsResponse
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 |
|---|---|---|
host_name_match | bool | True if host name matches to the name provided when fetching these login settings. |
anonymous_login_settings | AnonymousLoginSettings | Receives the login settings. |
anonymous_login_settings.anonymous_login_allowed | bool | True if anonymous login is allowed. |
vertical_applications | VerticalApplications | The vertical applications enabled for the vault. |
vertical_applications.v_tax_enabled | bool | VTax vertical application is enabled for the vault. |
vertical_applications.v_con_enabled | bool | VCon vertical application is enabled for the vault. |
vertical_applications.v_man_enabled | bool | VMan vertical application is enabled for the vault. |