Recipient Data Type

A reference to a user or group that is the recipient of a share or assigned permission.

Properties
name data type description
type string 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
id number The ID of the resource.
href string The path to the resource. This is relative to the root of the REST API (https://serveraddress/rest).

Example

{
  "type" : "...",
  "id" : 12345,
  "href" : "..."
}