IRPCSharedLinks.GetExternalSharingSettings

View as Markdown

Vault API / standard write session or assertion returns metadata structure version

Tells whether sharing is enabled in the vault and what the caller may do with external links.

ServiceShared links MFiles.IRPCSharedLinks
gRPC method/MFiles.IRPCSharedLinks/GetExternalSharingSettings
HTTP (mf-http-grpc)POST /grpc/v1/get-external-sharing-settings
RequestGetExternalSharingSettingsRequest
ResponseGetExternalSharingSettingsResponse
Book and levelVault API, standard
Kindwrite
SessionRequired: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotentno
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: GetExternalSharingSettingsRequest

No fields.

Response: GetExternalSharingSettingsResponse

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

FieldTypeDescription
allow_sharing_to_anyone_with_the_linkboolTrue if links may be opened by anyone who has them (read-only links and external links with anyone access).
sharing_enabledboolTrue if sharing is enabled on the server and in the vault.
visitor_list_restrictedboolTrue if the caller sees only the visitors they added, not all visitors of a link.