IRPCSharedLinksPublic.AccessSharedLink
Vault API / standard write no session
Starts a visitor's access to a link shared with named visitors: returns an access session value and, if the email address is a recipient of the link, emails an access code to it.
| Service | Shared links (anonymous access) MFiles.IRPCSharedLinksPublic |
|---|---|
| gRPC method | /MFiles.IRPCSharedLinksPublic/AccessSharedLink |
| HTTP (mf-http-grpc) | POST /grpc/v1/access-shared-link |
| Request | AccessSharedLinkRequest |
| Response | AccessSharedLinkResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- No session is needed. An email address that is not valid fails the call.
- The server returns an access session value whether or not the address is a recipient, so the response does not reveal who the recipients are.
- Pass the access session, the email address and the access code that the visitor received to
GetSharedLinkInfo and
DownloadSharedFile_Begin in
additional_data(ACCESS_SESSION,RECIPIENT_EMAIL,RECIPIENT_ACCESSCODE).
Request: AccessSharedLinkRequest
Requests shared link access.
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 |
|---|---|---|
guid_vault | string | The vault GUID. |
access_key | string | The access key of the link. |
email | string | The visitor's email address. |
Response: AccessSharedLinkResponse
Response for shared link access request.
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 |
|---|---|---|
access_session | string | The access session value to pass as ACCESS_SESSION. |
Related methods
- GetSharedLinkInfo -- Gets the name, extension and size of the file that a shared link points to, without logging in.
- DownloadSharedFile_Begin -- Starts downloading the file of a shared link, without logging in, and returns a download ID, the file size and its MD5 checksum.