IRPCSharedLinks.GetExternalSharingSettings
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.
| Service | Shared links MFiles.IRPCSharedLinks |
|---|---|
| gRPC method | /MFiles.IRPCSharedLinks/GetExternalSharingSettings |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-external-sharing-settings |
| Request | GetExternalSharingSettingsRequest |
| Response | GetExternalSharingSettingsResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires a vault session. Does not fail when sharing is disabled; check
sharing_enabled.
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.
| Field | Type | Description |
|---|---|---|
allow_sharing_to_anyone_with_the_link | bool | True if links may be opened by anyone who has them (read-only links and external links with anyone access). |
sharing_enabled | bool | True if sharing is enabled on the server and in the vault. |
visitor_list_restricted | bool | True if the caller sees only the visitors they added, not all visitors of a link. |