shareRecipient Data Type

Reference to the recipient of a shared item.

Type can be one of user, group. external_user, public. public_link. If type is public or public_link, ID and hrek are not applicable.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
email string element 0/1 The email address of the recipient. Only applies when type is external_user.
Properties inherited from recipient
type string element 0/1 Type of the recipient.

For assigned permissions, allowed values are:

  • user
  • group

For share recipients, allowed values are:

  • user
  • group
  • external_user
  • public
  • public_link
Properties inherited from longIdLinkPair
href string element 0/1 The path to the resource. This is relative to the root of the REST API (https://serveraddress/rest).
id long element 0/1 The ID of the resource.

Example

<share_recipient>
  <email>...</email>
  <type>...</type>
  <id>...</id>
  <href>...</href>
</share_recipient>