IRPCAnonymousLoginOperations.GetAnonymousAuthenticationSettings

View as Markdown

Vault API / standard write session

Tells whether anonymous access to the vault is turned on.

Service	Anonymous login `MFiles.IRPCAnonymousLoginOperations`
gRPC method	`/MFiles.IRPCAnonymousLoginOperations/GetAnonymousAuthenticationSettings`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-anonymous-authentication-settings`
Request	`GetAnonymousAuthenticationSettingsRequest`
Response	`GetAnonymousAuthenticationSettingsResponse`
Book and level	Vault API, standard
Kind	write
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 the vault rights manage_users and license_allows_modifications.
Anonymous access counts as on when exactly one anonymous user account exists and it is allowed to log in.
Not cacheable: the setting is not covered by the metadata structure version.

Request: GetAnonymousAuthenticationSettingsRequest

No fields.

Response: GetAnonymousAuthenticationSettingsResponse

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
`anonymous_authentication_settings`	`AnonymousAuthenticationSettings`	The current setting. `anonymous_authentication_enabled` is false (unset) when anonymous access is off.
`anonymous_authentication_settings.anonymous_authentication_enabled`	`bool`	Boolean indicating whether anonymous authentication should be enabled or disabled.