IRPCSharedLinks.GetSharedLinkRecipients

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

Lists the visitors (email recipients) of an external or visitor link.

Service	Shared links `MFiles.IRPCSharedLinks`
gRPC method	`/MFiles.IRPCSharedLinks/GetSharedLinkRecipients`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-shared-link-recipients`
Request	`GetSharedLinkRecipientsRequest`
Response	`GetSharedLinkRecipientsResponse`
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

Users who cannot see the full list of visitors (see visitor_list_restricted in GetExternalSharingSettings) get only the recipients they added themselves.
Recipients with a name are returned in mailbox form (Name <address>).
Reading the visitors of an external link is recorded in the vault's event log.

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_key`	`string`	The access key of the link.

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
`recipients[]`	repeated `SharedLinkRecipient`	The recipients, with their expiration time and access type.
`recipients[].email`	`string`	The recipient email.
`recipients[].access_time`	`google.protobuf.Timestamp`	The access time for the shared link. Is set by the server.
`recipients[].created_by_user`	`int32`	The creator of this shared Link.
`recipients[].shared_link_notification`	`SharedLinkNotification`	Shared link notification type.Values: `SHARED_LINK_NOTIFICATION_NONE` (0), `SHARED_LINK_NOTIFICATION_ALWAYS` (1).
`recipients[].expires_at_utc`	`google.protobuf.Timestamp`	The expiration time for the shared link. Use FILETIME_ZERO to indicate no expiration time.
`recipients[].external_shared_link_access_type`	`ExternalSharedLinkAccessType`	The access type of the recipient.Values: `EXTERNAL_SHARED_LINK_ACCESS_TYPE_UNINITIALIZED` (0), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_DOWNLOAD` (1), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_PREVIEW` (2), `EXTERNAL_SHARED_LINK_ACCESS_TYPE_EDIT` (3).
`recipients[].created_by_user_name`	`string`	The user who created the shared link.

GetExternalSharingSettings -- Tells whether sharing is enabled in the vault and what the caller may do with external links.
GetSharedLink -- Gets one shared link by its access key.